Payment Types & Required Fields

🏦 Bank Account Transfer

🇺🇸 United States

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • routingNumber - Required for US beneficiaries (no bankId needed)

🇪🇺 European Union (EUR)

• Payment Type: bank_account
• Required Fields:
  • accountNumber - In IBAN format
  • BIC - Bank Identifier Code (required for EUR payments)
• Supported in all EU member states

🇬🇧 United Kingdom

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • sortCode - Required for UK payments

🇨🇦 Canada

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • bankId - Get from Banks API
  • branchCode - Combined format of Institution Number (3 digits) and Transit Number (5 digits)
    • Format: 000XXXXX where:
      • First 3 digits: Institution Number (e.g., 006 for RBC)
      • Last 5 digits: Branch/Transit Number (e.g., 07621)
    • Example: 00607621
  • accountType - Either "savings" or "checking"

🇮🇳 India

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • accountType - Either "savings" or "checking"
  • bankId - Get from Banks API
  • ifscCode - Required for India

🇨🇴 Colombia

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • accountType - Either "savings" or "checking"
  • bankId - Get from Banks API

🇦🇷 Argentina

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • accountType - Either "savings" or "checking"
  • bankId - Get from Banks API
  • bankDocumentNumber - Required for Argentina (11 digit code)

All Other Countries

• Payment Type: bank_account
• Required Fields:
  • accountNumber - Bank account number
  • accountType - Either "savings" or "checking"
  • bankId - Get from Banks API

💸 PIX (Brazil)

• Payment Type: pix
• Required Fields:
  • pixKeyId - PIX key identifier
  • taxId - Brazilian tax ID (CPF/CNPJ)

🇲🇽 SPEI (Mexico)

• Payment Type: spei
• Required Fields:
  • targetName - Beneficiary name
  • targetBankAccountId - CLABE number

🇵🇭 Philippines Payment Methods

Instapay (amounts < 50,000)

• Payment Type: instapay
• Required Fields:
  • channelSubject - Transaction subject
  • extendInfo
    • recipientAccountNumber - Account number
    • recipientName - Beneficiary name

Pesonet (amounts ≥ 50,000)

• Payment Type: swiftpay_pesonet
• Required Fields:
  • channelSubject - Transaction subject
  • extendInfo
    • recipientAccountNumber - Account number
    • recipientName - Beneficiary name

Payment Requirements by Region

🌏 Asia Pacific

🇮🇳 India

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API
• ifscCode - Required for India

🇸🇬 Singapore, 🇲🇾 Malaysia, 🇰🇷 South Korea, 🇹🇭 Thailand, 🇻🇳 Vietnam, 🇮🇩 Indonesia, 🇦🇺 Australia

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API

🇯🇵 Japan

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API

🇭🇰 Hong Kong

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API
• beneficiaryPhone - Required

🌍 Europe and UK

🇪🇺 European Union (SEPA)

• accountNumber - In IBAN format
• BIC - Bank Identifier Code (required for EUR payments)
• Supported in all EU member states

🇬🇧 United Kingdom

• accountNumber - Bank account number
• sortCode - Required for UK payments

🌎 Americas

🇺🇸 United States

• accountNumber - Bank account number
• routingNumber - Required for US payments

🇧🇷 Brazil (PIX)

• pixKeyId - PIX key identifier
• taxId - Brazilian tax ID (CPF/CNPJ)

🇲🇽 Mexico (SPEI)

• targetName - Beneficiary name
• targetBankAccountId - CLABE number

🇨🇴 Colombia

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API

🇦🇷 Argentina

• accountNumber - Bank account number
• accountType - Either "savings" or "checking"
• bankId - Get from Banks API
• bankDocumentNumber - Required (11 digit code)

🌏 Southeast Asia

🇵🇭 Philippines

Instapay (amounts < 50,000)

• Payment Type: instapay
• channelSubject - Transaction subject
• extendInfo
  • recipientAccountNumber - Account number
  • recipientName - Beneficiary name

Pesonet (amounts ≥ 50,000)

• Payment Type: swiftpay_pesonet
• channelSubject - Transaction subject
• extendInfo
  • recipientAccountNumber - Account number
  • recipientName - Beneficiary name

💡

Important Notes

To get supported payment types for a specific country:

GET /v1/validation-rules/beneficiaries/payment-types?ownerType=individual&country=XX

Replace XX with the country code (e.g., CO, IN, GB)

📚

API References

• Banks API: GET /v1/beneficiaries/banks
  Use this to fetch the correct bankId for each country
• Payment Types API: GET /v1/validation-rules/beneficiaries/payment-types
  Required query parameters:
  • ownerType: "individual" or "business"
  • country: ISO country code

⚠️

Validation Rules

• Always check validation rules before creating a beneficiary
• Bank ID is required for bank_account payments except for:
  • US (uses routingNumber instead)
  • EU (uses IBAN and BIC)
  • UK (uses sortCode)
• IBAN format is mandatory for SEPA transfers in Europe
• BIC (Bank Identifier Code) code is required for EUR payments
• Special fields (IFSC, sortCode, bankDocumentNumber) are validated based on country-specific rules
• For US beneficiaries, use routingNumber instead of bankId