| Field | Type | Description & Constraints |
|---|---|---|
country | String | Beneficiary Country. ISO 3166-1 alpha-2 format (e.g., US, GB, HK). |
currency | String | Currency. ISO 4217 format (e.g., USD, GBP, HKD). |
bankDetails.| Field | Type | Description & Constraints |
|---|---|---|
accountName | String | Account Holder Name. Must match the entity name. Max length: 60 characters. |
accountNumber | String | Bank Account Number. Max length: 34 characters. |
iban | String | IBAN (International Bank Account Number). Mandatory for Europe (SEPA zone), UK, and other IBAN-compliant countries. |
bankName | String | Bank Name. Max length: 100 characters. |
swiftCode | String | SWIFT / BIC Code. 8 or 11 characters. Mandatory for international wire transfers. |
bankCode | String | Local Clearing Code. Conditional. See Clearing Code Reference below (e.g., ABA for US, Sort Code for UK). |
bankBranchCode | String | Branch Code. Conditional. Required for specific countries (e.g., HK, CA, AU) if not embedded in the Bank Code. |
bankAddress | String | Bank Address. Max length: 255 characters. |
bankCity | String | Bank City. Max length: 50 characters. |
bankCountry | String | Bank Country. ISO 3166-1 alpha-2 format. |
bankDetails.| Field | Type | Description & Constraints |
|---|---|---|
intermediaryBankName | String | Intermediary Bank Name. Optional. |
intermediaryBankSwiftCode | String | Intermediary Bank SWIFT Code. Optional. |
Legend: M= MandatoryO= OptionalC= Conditional (Depends on Country/Currency)
{
// --- General Info ---
"country": "string", // [M] ISO 3166-1 alpha-2 (e.g., US)
"currency": "string", // [M] ISO 4217 (e.g., USD)
// --- Bank Details ---
"bankDetails": {
"accountName": "string", // [M] Max 60 chars
"accountNumber": "string", // [M] Max 34 chars
"iban": "string", // [C] Mandatory for IBAN countries (EU, UK, etc.)
"bankName": "string", // [M] Max 100 chars
"swiftCode": "string", // [M] SWIFT/BIC
"bankCode": "string", // [C] Routing Number / Sort Code / BSB / etc.
"bankBranchCode": "string", // [C] Required for HK, AU, etc.
"bankAddress": "string", // [O] Max 255 chars
"bankCity": "string", // [O] Max 50 chars
"bankCountry": "string", // [M] ISO 3166-1 alpha-2
// --- Intermediary Bank (Optional) ---
"intermediaryBankName": "string", // [O]
"intermediaryBankSwiftCode": "string" // [O]
}
}
bankCode & bankBranchCode)bankCode and bankBranchCode vary by region. Please refer to the guide below:| Country | Currency | Requirement for bankCode | Requirement for bankBranchCode |
|---|---|---|---|
| USA | USD | ABA Routing Number (9 digits). | Not Required. |
| UK | GBP | Sort Code (6 digits). | Not Required. |
| Canada | CAD | CC Code (9 digits). | Not Required. |
| Australia | AUD | BSB Code (6 digits). | Not Required. |
| Hong Kong | HKD | Bank Code (3 digits). | Branch Code (3 digits). |
| Singapore | SGD | Bank Code (4 digits). | Branch Code (3 digits). |
| Japan | JPY | Bank Code (4 digits). | Branch Code (3 digits). |
| Europe | EUR | Not Required (Use IBAN). | Not Required. |