Odesílat prostředky

Každá výplata začíná z připravené a financované vydané peněženky. Model cíle závisí na tom, kdo koncový bod vlastní.

Než začnete

Znovu načtěte zdrojovou peněženku. Ověřte, že její aktuální stav umožňuje výplatu a její dostupný zůstatek pokryje zamýšlenou zdrojovou částku. Uložte její ID odvozené z odpovědi jako SOURCE_WALLET_ID. Potřebujete také připravenou výplatní capability pro aktuálního zákazníka a vybraný cíl. Stávající peněženky na Tronu mohou odesílat USDT do jiné peněženky na Tronu pomocí quote stablecoin_transfers. Vstup i výstup musí používat stejnou síť a stejný stablecoin. Nové vydané peněženky na Tronu vytvořit nelze.

1. Připravte cíl

První strana
Třetí strana

Použijte externí bankovní účet vlastněný zákazníkem, když zákazník koncový bod vlastní. Vytvořte jej pomocí POST /v3/customers/{customerId}/accounts a těchto hlaviček:

Request headers

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

Request body

{
  "origin": "external",
  "type": "bank",
  "methods": ["ach", "wire"],
  "country": "US",
  "currency": "USD",
  "details": {
    "routingNumber": "021000021",
    "accountNumber": "123456789",
    "accountType": "checking",
    "bankName": "Example Bank",
    "accountHolderName": "Acme Payments SAS"
  },
  "label": "Customer operating account"
}

Přečtěte jej pomocí GET /v3/customers/{customerId}/accounts/{accountId}. Pokračujte jen tehdy, když jeho aktuální stav umožňuje výplatu. Uložte jeho ID acc_ jako PAYOUT_DESTINATION_ID.

Vytvořte osobu nebo firmu a jejich bankovní nebo peněženkový koncový bod přes Příjemci a cíle. Pokračujte jen tehdy, když je cíl připraven.Uložte vrácené ID dst_ jako PAYOUT_DESTINATION_ID. ID příjemce rcp_ nepoužívejte jako cíl quote.

2. Vytvořte výplatní quote

Použijte POST /v3/quotes s těmito hlavičkami:

Request headers

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

Request body

{
  "customerId": "${CUSTOMER_ID}",
  "capabilityId": "${CAPABILITY_ID}",
  "in": {
    "amount": "150.00",
    "currency": "USDC",
    "accountId": "${SOURCE_WALLET_ID}"
  },
  "destinationId": "${PAYOUT_DESTINATION_ID}",
  "out": {
    "currency": "USD"
  }
}

Uložte data.id jako QUOTE_ID a zobrazte vrácenou cenu a poplatky.

Zvolte bankovní trasu

U výplaty z kryptoměn do fiat můžete nastavit volitelné institutionId a vyžádat si tak schválenou bankovní trasu pro zákazníka. Pokud jej vynecháte, použije se automatické směrování.

Request body with institutionId

{
  "customerId": "${CUSTOMER_ID}",
  "capabilityId": "${CAPABILITY_ID}",
  "institutionId": "${INSTITUTION_ID}",
  "in": {
    "amount": "150.00",
    "currency": "USDC",
    "accountId": "${SOURCE_WALLET_ID}"
  },
  "destinationId": "${PAYOUT_DESTINATION_ID}",
  "out": {
    "currency": "USD"
  }
}

Explicitní institutionId nikdy nepřejde na jinou banku. Když vybraná banka nemá pro tohoto zákazníka, capability a cíl připravenou trasu, POST /v3/quotes vrátí 422 bank_not_supported_for_customer s ukazatelem /institutionId.
institutionId je platné pouze u výplatních quotes z kryptoměn do fiat. Jeho odeslání u quote příchozí platby, karty nebo převodu stablecoinů vrátí 400 validation_error.
Čtení quote a převodu vrací institutionId vybrané trasy, včetně automaticky vybrané, pokud lze banku identifikovat.

Výplaty SWIFT

V produkci vyžadují výplaty USD přes SWIFT připravenou capability SWIFT, která podporuje výplaty (swift_pooled nebo swift_named), a jsou financovány v USDC na Ethereum, Base nebo Polygon, nebo v USDT na Ethereum nebo Polygon. Částka pro příjemce po odečtení poplatků musí být alespoň 100.00 USD. Cíl SWIFT vyžaduje adresu banky v polích bankAddress, bankCity, bankState a bankPostalCode. Země BIC se musí shodovat se zemí banky. Swipelux přebírá adresu příjemce z profilu zákazníka nebo příjemce.

Výplaty Pix

Cíle příjemců Pix a Pix Safe přijímají BRL. Vytvořte quote výplaty s připravenou capability Pix zákazníka (pix_pooled), financujte ji v USDC a nastavte out.currency na BRL. USDT nemůže financovat výplatu v BRL. Výplata Pix nemůže nést vývojářský poplatek. Pokud má zdrojový účet vývojářské poplatky, nastavte v požadavku na quote fees.breakdown.developer na {"fixed": "0.00", "bips": 0}. Jinak POST /v3/quotes vrátí 400 validation_error. Swipelux ocení quote až po schválení bankovních údajů cíle. Během jejich ověřování POST /v3/quotes vrací 400 validation_error s detail uvádějícím, že cíl se stále ověřuje, proto si po dokončení ověření vyžádejte nový quote. Pokud byly bankovní údaje zamítnuty nebo nastavení cíle není dokončeno, detail vás místo toho požádá o kontaktování podpory a nové quotes budou selhávat, dokud podpora nastavení nedokončí. Pokud ověření nelze zkontrolovat, vrátí 503 quote_temporarily_unavailable; zkuste to později.

3. Proveďte výplatu

Vytvořte převod pomocí POST /v3/transfers. Pro toto zamýšlené provedení použijte jeden nový klíč:

Request headers

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

Request body

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

Uložte data.id převodu jako TRANSFER_ID. Úspěšné vytvoření spustí výplatu; nedokládá doručení.

4. Sledujte doručení

Přečtěte GET /v3/transfers/{transferId} po vytvoření a po každé události. Podle nejnovějšího data.state, data.stateDetail a data.openTaskIds rozhodněte, zda čekat, jednat, nebo zobrazit konečný výsledek. Dále si projděte Quotes a převody pro přesné částky, bezpečné obnovení provedení a úkoly převodu.

Začínáme

Onboarding zákazníků

Vytvořte peněžní toky

Spuštění

Odesílat prostředky

Než začnete

1. Připravte cíl

2. Vytvořte výplatní quote

Zvolte bankovní trasu

Výplaty SWIFT

Výplaty Pix

3. Proveďte výplatu

4. Sledujte doručení

​Než začnete

​1. Připravte cíl

​2. Vytvořte výplatní quote

​Zvolte bankovní trasu

​Výplaty SWIFT

​Výplaty Pix

​3. Proveďte výplatu

​4. Sledujte doručení

Než začnete

1. Připravte cíl

2. Vytvořte výplatní quote

Zvolte bankovní trasu

Výplaty SWIFT

Výplaty Pix

3. Proveďte výplatu

4. Sledujte doručení