Abans de començar
Necessites una capacitat de cobrament preparada i una cartera de destinació emesa preparada per al mateix client. Completa qualsevol treball obert mitjançant Capacitats i tasques, i després torna a obtenir els dos recursos. El SWIFT agrupat no admet cobraments. Per rebre dipòsits SWIFT, emet un compte SWIFT nominatiu. Consulta Emetre un compte bancari.1. Crea una cotització
Crea el preu ambPOST /v3/quotes. Envia aquestes capçaleres:
Request headers
Request body
data.id com a QUOTE_ID. Presenta els imports i les comissions retornats en lloc de reconstruir-los a partir de la taxa.
Imports mínims
Les cotitzacions de cobrament bancari poden aplicar un import mínim, per exemple 20.00 USD per a Wire agrupat.POST /v3/quotes retorna 422 amount_not_deliverable quan l’import és inferior al mínim o massa petit per cobrir les comissions de transferència.
2. Executa la cotització
Executa la cotització actual abans que expiri ambPOST /v3/transfers. Utilitza una nova clau per a aquesta transferència prevista:
Request headers
Request body
data.id de la transferència com a TRANSFER_ID i conserva el seu estat actual.
Afegeix una URL de retorn per a targeta i Apple Pay
Per a una cotització de targeta o Apple Pay, pots incloure unredirectUrl opcional a la mateixa sol·licitud. Quan el client finalitza el checkout allotjat, la pàgina de checkout obre aquesta URL per fer tornar el client a la teva aplicació.
Request body with redirectUrl
redirectUrl ha de ser una URL HTTPS absoluta de com a màxim 2048 caràcters i no ha de contenir credencials incrustades. Enviar redirectUrl per a una cotització que no admet navegació de retorn falla la validació en lloc d’ignorar-se.
L’arribada a redirectUrl és només navegació del navegador. No confirma que el pagament ni la transferència s’hagin completat. Determina la finalització a partir de l’estat de la transferència al pas 4 i dels esdeveniments de webhook.
Preselecciona el mètode de checkout per a una cotització de targeta
Per a una cotització de targeta, pots incloure uncheckoutMethod opcional a la mateixa sol·licitud per triar amb quina opció de finançament s’obre el checkout allotjat. Els valors actuals són card, apple_pay, google_pay, cash_app, sepa i blik. La llista és oberta i pot créixer, així que tolera els valors que no reconeguis a les lectures de la transferència. El checkout s’obre amb el mètode sol·licitat quan està disponible per al client i el seu dispositiu, i el client encara pot triar qualsevol altre mètode que ofereixi el checkout. Omet-lo per mantenir la preselecció per defecte.
Request body with checkoutMethod
checkoutMethod és una preferència, no una garantia. La disponibilitat depèn del client, del seu dispositiu i del checkout, de manera que sol·licitar un mètode no el fa disponible. Aquí sepa i blik són opcions de finançament dins del checkout de targeta, no capacitats, rails ni comptes de Swipelux. La preselecció no canvia la capacitat, els imports ni les comissions de la cotització, i el checkout confirma les comissions finals. Les lectures de la transferència retornen el valor sol·licitat; no confirmen quin mètode ha utilitzat el client. Enviar checkoutMethod per a una cotització que no és de targeta falla la validació en lloc d’ignorar-se, i una repetició amb la mateixa clau d’idempotència ha d’enviar el mateix checkoutMethod.
3. Recupera les instruccions de finançament
LlegeixGET /v3/transfers/{transferId}/instructions. Renderitza la variant data.instructions retornada sense assumir el seu tipus.
Aquests detalls són específics de la transferència. No reutilitzis mai les coordenades bancàries, el codi, la URL allotjada, l’import, la referència o la data de caducitat d’una transferència per a un altre cobrament.
Per a instruccions bancàries, quan reference.required és true, mostra el reference.value exacte al costat de les coordenades bancàries i fes-lo copiable. Mostra l’import i la moneda retornats del mateix conjunt d’instruccions.
Les instruccions bancàries també poden incloure els camps opcionals bankName, bankAddress, accountHolderName i accountHolderAddress. Mostra cada camp retornat al costat de les altres coordenades bancàries. Els bancs emissors sovint requereixen l’adreça del banc receptor per a swift i altres transferències internacionals, així que mostra bankAddress sempre que es retorni.
Bank instructions
4. Fes el seguiment de la liquidació
LlegeixGET /v3/transfers/{transferId} després de l’execució i després de cada esdeveniment. Impulsa l’estat mostrat al client a partir de l’últim data.state.
Utilitza data.stateDetail i data.openTaskIds quan la transferència necessiti una altra acció. No la marquis com a completada a partir d’un calendari previst.
A continuació, afegeix Webhooks i manté l’estat de la transferència sincronitzat fins que arribi a un resultat que el teu producte gestioni.