Než začnete
Potřebujete ID zákazníka, připravenou bankovní capability pro zamýšlenou metodu a měnu a připravenou vydanou peněženku vlastněnou stejným zákazníkem. PomocíallowPending můžete požadavek uložit, zatímco vybraná banka zákazníka ještě posuzuje. Otevřenou práci dokončete přes Capabilities a úkoly.
1. Vytvořte nebo vyberte vypořádací peněženku
Vytvořte vydanou peněženku podle Účty a peněženky, poté ji znovu přečtěte. Pokračujte jen tehdy, když její aktuální stav umožňuje vypořádání. Uložte jejídata.id z odpovědi jako SETTLEMENT_WALLET_ID. Nepoužívejte externí peněženku pro settlement.accountId.
2. Vytvořte vydaný bankovní účet
PoužijtePOST /v3/customers/{customerId}/accounts s těmito hlavičkami:
Request headers
Request body
data.id jako BANK_ACCOUNT_ID. Také uchovejte data.status, data.openTaskIds, data.details a vazbu na vypořádání.
Volitelná pole požadavku:
Vyberte banku
Odešleteinstitution, když zákazník potřebuje bankovní údaje od konkrétní banky. Swipelux rezervuje jeden vydaný účet na zákazníka, metodu, měnu a instituci. Požadavek bez institution vrátí 409 conflict, pokud zákazník již má vydaný účet pro tuto metodu a měnu u kterékoli banky. Požadavek s institution vrátí 409 conflict pouze tehdy, když účet pro tuto banku již existuje.
Čtení účtu vrací vybranou banku jako institution s poli id, name a bic. bic může být null.
Idempotence se vztahuje k vybrané bance. Opakované odeslání stejného požadavku vrátí původní účet. Změna institution pod stejným Idempotency-Key vrátí 409 idempotency_conflict.
Uložte požadavek před schválením bankou
Ve výchozím nastavení Swipelux přijme požadavek na vydaný bankovní účet až poté, co je bankovní capability připravena. Chcete-li nastavení účtu zákazníka shromáždit dříve, odešleteallowPending: true spolu s institution:
Request body with allowPending
status: "in_review" a statusReason.code nastavené na waiting_for_approval. Odpověď obsahuje také applicationId a openTaskIds žádosti. Tyto úkoly dokončete přes Capabilities a úkoly.
Uložený požadavek si ponechává své ID účtu, vypořádací peněženku i slot účtu. Jakmile jsou žádost a capability připraveny, Swipelux zřídí bankovní údaje pod stejným BANK_ACCOUNT_ID. Nadále čtěte toto ID. Nevytvářejte další požadavek.
Dokud uložený požadavek čeká, drží slot účtu. Další požadavek allowPending pro stejný slot s jiným Idempotency-Key vrátí 409 conflict. Pole holder.accountId v problému uvádí čekající účet. Místo opakování požadavku načtěte tento účet.
Pokud je žádost nejprve zamítnuta, zrušena nebo archivována, účet přejde do stavu rejected. Slot účtu již nedrží.
Zvolte měnu vypořádání
Ve výchozím nastavení se vklady vypořádávají v měně vypořádací peněženky. Nastavtesettlement.currency na USDC nebo USDT, chcete-li zvolit doručované aktivum nezávisle na měně peněženky:
Request body with settlement currency
USDT vyžaduje účet v USD a vypořádací peněženku na síti, která podporuje doručování USDT. V opačném případě požadavek vrátí 400 invalid_settlement_target. Čtení účtu vrací uloženou volbu, a to i během provisioningu účtu.
ID bankovního účtu a ID peněženky mají různé role. Přes ID bankovního účtu čtěte provisioning a bankovní údaje. ID vypořádací peněženky používejte k identifikaci místa, kde jsou vklady připisovány.
3. Sledujte provisioning
PřečtěteGET /v3/customers/{customerId}/accounts/{accountId} po vytvoření a po každém relevantním webhooku.
Nechte zákaznické rozhraní ve stavu čekajícím, dokud details chybí. Pokud openTaskIds není prázdný, dokončete nejnovější úkoly a znovu načtěte účet. Neodvozujte připravenost z uplynulého času.
Pokud byl účet uložen s allowPending: true, zůstává ve stavu in_review s statusReason.code nastaveným na waiting_for_approval, dokud banka žádost neschválí.
Pokud je nejnovější statusReason.code awaiting_assignment, vytvořte první příchozí platbu pro stejného zákazníka, capability a vypořádací peněženku přes Přijímat prostředky a poté bankovní účet znovu přečtěte. Touto větví postupujte pouze tehdy, když ji aktuální účet vyžaduje.
4. Prezentujte bankovní údaje bezpečně
Zobrazte pouze úplné údaje vrácené nejnovějším čtením účtu. Když jedetails.referenceRequired true, zobrazte přesnou details.reference a umožněte její zkopírování. Když je false, referenci si nevymýšlejte.
U vydaných účtů swift zobrazte details.bankName, details.swiftCode (BIC přijímající banky), details.accountNumber, details.accountHolderName a details.accountHolderAddress, pokud jsou vráceny. Odesílatelé musí adresu příjemce zkopírovat do mezinárodního převodu přesně. Zobrazte také details.bankAddress a všechna pole zprostředkující banky, která účet vrací.
Tyto bankovní údaje jsou opakovaně použitelné. Nenahrazujte je financovacími souřadnicemi z odkvótované příchozí platby, které patří pouze k danému převodu.
Dále přidejte Webhooky, aby aktualizace provisioningu dosáhly vaší aplikace, aniž byste zákazníka drželi na pollingové obrazovce.