SMART_BANK_TRANSFER_PAYOUT enables disbursing funds to bank accounts using localized and international banking rails. This includes domestic clearing systems (e.g., ACH, SEPA, FPS) and global cross-border payouts using IBAN/SWIFT-based rails. The platform routes payouts based on destination country, currency, and compliance/regional requirements.
Payouts are typically initiated by the platform or merchant to a beneficiary's account and may require security or identity details depending on the country.
Payout Method Regions Supported Notes SEPA Credit Transfer EU, EEA Requires IBAN; optional BIC SWIFT Global IBAN/SWIFT; may include additional identifiers ACH United States Account + ABA routing number FedNow / RTP United States Real-time or faster payments Interac / EFT Canada Transit + institution + account Faster Payments / CHAPS United Kingdom Sort code + account BACS United Kingdom Batch payments; requires sort code SPEI Mexico Account + CLABE or routing PIX Brazil CPF + account or alias MULTIBANCO Portugal Bank code and account Local rails (APAC, CIS, etc.) Country-specific Fields vary by country and bank system
Field Type Required? Description paymentMethodApmMethodYes (default) Always SMART_BANK_TRANSFER paymentTypeApmFlowTypeYes (default) Always BANK_TRANSFER ibanString?✅ (EU/global) Required for SEPA or SWIFT-based payouts bicString?❌/✅ Often required for international payments swiftCodeString?❌ Optional routing for cross-border accountNumberString?✅/❌ Required in US, CA, UK, AU, etc. routingNumberString?✅/❌ Required in US (ABA), UK, some LATAM/APAC sortCodeString?✅/❌ UK-specific routing bankCodeString?❌ Generic bank identifier branchCodeString?❌ Branch-level routing code (e.g., IFSC, MICR, etc.) institutionNumberString?❌ Canada-specific (with transitNumber) transitNumberString?❌ Canada-specific (with institutionNumber) bankNameString?❌ Human-readable name of the bank bankCityString?❌ City where the bank is located countryString?✅ Target country for payout bankAccountTypeString?❌ e.g., checking, savings, etc. bankCleaningSystemIdString?❌ Country-specific system code accountHolderNameString?✅ Beneficiary name securityQuestionString?❌ Optional security validation question (CA/US/others) securityAnswerString?❌ Optional answer to security question
Field Type Required? Description paymentMethodApmMethodYes Always SMART_BANK_TRANSFER paymentTypeApmFlowTypeYes Always BANK_TRANSFER redirectUrlString?Optional Redirect for any verification or post-payout action iframeUrlString?Optional Embeddable payout status (if supported) providerTransactionIdString✅ Unique transaction ID from the payout processor accountHolderNameString?Optional Echoed for reconciliation maskedAccountNumberString?Optional Masked for logs and audit ibanString?Optional Echoed or returned IBAN bicString?Optional Echoed or returned BIC swiftCodeString?Optional Echoed or returned SWIFT code accountNumberString?Optional Echoed or returned account number routingNumberString?Optional ABA, FPS, etc. sortCodeString?Optional UK routing branchCodeString?Optional Branch-specific routing (e.g., IFSC) bankCodeString?Optional Generic identifier institutionNumberString?Optional Canada-specific transitNumberString?Optional Canada-specific bankNameString?Optional Echoed human-readable bank name bankCityString?Optional Echoed city of bank countryString?Optional Echoed payout destination country bankAccountTypeString?Optional Echoed account type bankCleaningSystemIdString?Optional Echoed or reconciled value from processor securityQuestionString?Optional Echoed (if collected) securityAnswerString?Optional Echoed (if collected) bankMetadataMap<String, String>?Optional PSP-specific data for reconciliation, display, or audit
Use iban + bic for EU and global SWIFT payouts.
Use accountNumber + routingNumber for US/Canada.
Use sortCode + accountNumber for UK.
Validate country and format before submission.
Collect securityQuestion/securityAnswer when required for local validations (e.g., Canada).
Use bankMetadata for PSP-specific values (e.g., transfer references, internal IDs).
