Přijímat prostředky

Odkvótovanou příchozí platbu použijte, když zákazník potřebuje financovat konkrétní částku. Převod vypořádá stablecoin do vydané peněženky.

Než začnete

Potřebujete připravenou capability příchozí platby a připravenou vydanou cílovou peněženku pro stejného zákazníka. Otevřenou práci dokončete přes Capabilities a úkoly, poté oba zdroje znovu načtěte. Pooled SWIFT nepodporuje příchozí platby. Chcete-li přijímat vklady SWIFT, vydejte pojmenovaný účet SWIFT. Viz Vydat bankovní účet.

1. Vytvořte quote

Vytvořte cenu pomocí POST /v3/quotes. Odešlete tyto hlavičky:

Request headers

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: payin-quote-001
Content-Type: application/json

Request body

{
  "customerId": "${CUSTOMER_ID}",
  "capabilityId": "${CAPABILITY_ID}",
  "externalId": "payin-order-123",
  "in": {
    "amount": "150.00",
    "currency": "USD"
  },
  "destinationId": "${SETTLEMENT_WALLET_ID}",
  "out": {
    "currency": "USDC"
  }
}

Uložte data.id jako QUOTE_ID. Zobrazte vrácené částky a poplatky místo jejich přepočítávání ze směnného kurzu.

Minimální částky

Quotes bankovních příchozích plateb mohou vyžadovat minimální částku, například 20.00 USD pro pooled Wire. POST /v3/quotes vrátí 422 amount_not_deliverable, když je částka pod minimem nebo příliš malá na pokrytí poplatků za převod.

2. Proveďte quote

Aktuální quote proveďte před vypršením pomocí POST /v3/transfers. Pro tento zamýšlený převod použijte nový klíč:

Request headers

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: payin-transfer-001
Content-Type: application/json

Request body

{
  "quoteId": "${QUOTE_ID}"
}

Uložte data.id převodu jako TRANSFER_ID a uchovejte jeho aktuální stav.

Přidejte návratovou URL pro kartu a Apple Pay

Pro quote kartou nebo Apple Pay můžete do stejného požadavku zahrnout volitelné redirectUrl. Poté, co zákazník dokončí hostovaný checkout, stránka checkoutu otevře tuto URL a vrátí zákazníka zpět do vaší aplikace.

Request body with redirectUrl

{
  "quoteId": "${QUOTE_ID}",
  "redirectUrl": "https://your-app.example/payments/complete"
}

redirectUrl musí být absolutní HTTPS URL o délce nejvýše 2048 znaků a nesmí obsahovat vložené přihlašovací údaje. Odeslání redirectUrl pro quote, který nepodporuje návratovou navigaci, selže při validaci, místo aby bylo ignorováno. Příchod na redirectUrl je pouze navigace prohlížeče. Nepotvrzuje, že platba nebo převod byly dokončeny. Dokončení určujte ze stavu převodu v kroku 4 a z webhookových událostí.

Předvyberte metodu checkoutu pro quote kartou

Pro quote kartou můžete do stejného požadavku zahrnout volitelné checkoutMethod, kterým zvolíte, s jakou možností financování se hostovaný checkout otevře. Aktuální hodnoty jsou card, apple_pay, google_pay, cash_app, sepa a blik. Seznam je otevřený a může se rozšiřovat, proto při čtení převodu tolerujte hodnoty, které neznáte. Checkout se otevře s vyžádanou metodou, pokud je pro zákazníka a jeho zařízení dostupná, a zákazník si stále může vybrat kteroukoli jinou metodu, kterou checkout nabízí. Pokud pole vynecháte, zachová se výchozí předvýběr.

Request body with checkoutMethod

{
  "quoteId": "${QUOTE_ID}",
  "checkoutMethod": "apple_pay"
}

checkoutMethod je preference, nikoli záruka. Dostupnost závisí na zákazníkovi, jeho zařízení a checkoutu, takže vyžádání metody ji nezpřístupní. sepa a blik jsou zde možnosti financování uvnitř kartového checkoutu, nikoli schopnosti, raily ani účty Swipelux. Předvýběr nemění schopnost, částky ani poplatky quote a konečné poplatky potvrzuje checkout. Čtení převodu vrací vyžádanou hodnotu; nepotvrzuje, kterou metodu zákazník použil. Odeslání checkoutMethod pro quote, který není kartový, selže při validaci, místo aby bylo ignorováno, a opakování se stejným idempotentním klíčem musí odeslat stejné checkoutMethod.

3. Získejte financovací pokyny

Přečtěte GET /v3/transfers/{transferId}/instructions. Vykreslete vrácenou variantu data.instructions, aniž byste předpokládali její typ. Tyto údaje jsou specifické pro daný převod. Nikdy nepoužívejte bankovní souřadnice, kód, hostovanou URL, částku, referenci ani expiraci jednoho převodu pro jinou příchozí platbu. Pro bankovní pokyny, když je reference.required true, zobrazte přesnou reference.value vedle bankovních souřadnic a umožněte její zkopírování. Zobrazte vrácenou částku a měnu ze stejné sady pokynů. Bankovní pokyny mohou obsahovat také volitelná pole bankName, bankAddress, accountHolderName a accountHolderAddress. Každé vrácené pole zobrazte vedle ostatních bankovních souřadnic. Odesílající banky často vyžadují adresu přijímající banky pro swift a jiné mezinárodní převody, proto bankAddress zobrazte vždy, když je vráceno.

Bank instructions

{
  "type": "bank",
  "method": "swift",
  "amount": { "amount": "150.00", "currency": "USD" },
  "accountHolderName": "Swipelux FBO Customer",
  "accountHolderAddress": "8 The Green, Dover, DE",
  "bankName": "JPMorgan Chase",
  "bankAddress": "383 Madison Avenue, New York, NY",
  "details": {
    "swiftCode": "CHASUS33",
    "accountNumber": "123456789"
  },
  "reference": { "value": "SWIFTMEMO1", "required": true }
}

Vydaný bankovní účet je něco jiného: poskytuje opakovaně použitelné údaje pro pozdější vklady. Když je to zamýšlené použití, viz Vydat bankovní účet.

4. Sledujte vypořádání

Přečtěte GET /v3/transfers/{transferId} po provedení a po každé události. Stav pro zákazníka odvozujte z nejnovějšího data.state. Použijte data.stateDetail a data.openTaskIds, když převod vyžaduje další akci. Neoznačujte jej jako dokončený z očekávaného harmonogramu. Dále přidejte Webhooky a udržujte stav převodu synchronizovaný, dokud nedosáhne výsledku, který váš produkt zpracovává.

Začínáme

Onboarding zákazníků

Vytvořte peněžní toky

Spuštění

Přijímat prostředky

Než začnete

1. Vytvořte quote

Minimální částky

2. Proveďte quote

Přidejte návratovou URL pro kartu a Apple Pay

Předvyberte metodu checkoutu pro quote kartou

3. Získejte financovací pokyny

4. Sledujte vypořádání

​Než začnete

​1. Vytvořte quote

​Minimální částky

​2. Proveďte quote

​Přidejte návratovou URL pro kartu a Apple Pay

​Předvyberte metodu checkoutu pro quote kartou

​3. Získejte financovací pokyny

​4. Sledujte vypořádání

Než začnete

1. Vytvořte quote

Minimální částky

2. Proveďte quote

Přidejte návratovou URL pro kartu a Apple Pay

Předvyberte metodu checkoutu pro quote kartou

3. Získejte financovací pokyny

4. Sledujte vypořádání