Specifies the type of beneficiary entity to filter by. Valid values are:

• COMPANY : corporate entities
• INDIVIDUAL : personal accounts

Account number, mostly for non-european countries, either account_number or iban should be filled.

Only English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.

The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.

Currency in which money is held in the beneficiary's bank account. Three-letter ISO 4217 currency code.

First name of the beneficiary, only exist when the entity_type is INDIVIDUAL.

• When payment_method = SWIFT:

  • Only English letters, numbers, special characters (half-width format), and spaces can be included.
  • Allowed special characters: -_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……

• When payment_method = LOCAL:

  • No strict validation rules apply, local language characters are supported.

• No need to pass this field when bank_details.bank_country_code = SG & bank_details.account_currency_code = SGD

Last name of the beneficiary, only exist when the entity_type is INDIVIDUAL.

• When payment_method = SWIFT:

  • Only English letters, numbers, special characters (half-width format), and spaces can be included.
  • Allowed special characters: -_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……

• When payment_method = LOCAL:

  • No strict validation rules apply, local language characters are supported.

• No need to pass this field when bank_details.bank_country_code = SG & bank_details.account_currency_code = SGD

Company name of the beneficiary, only exist when the entity_type is COMPANY.

• When payment_method = SWIFT:

  • Only English letters, numbers, special characters (half-width format), and spaces can be included.
  • Allowed special characters: -_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……

• When payment_method = LOCAL:

  • No strict validation rules apply, local language characters are supported.

• No need to pass this field when bank_details.bank_country_code = SG & bank_details.account_currency_code = SGD

• When bank_country_code = CN & account_currency_code = CNH & payment_method = LOCAL & entity_type = COMPANY, Chinese characters and Chinese parentheses （） are supported.

Specifies the clearing system to be used for the transaction. The available options vary by currency and correspond to the local payment infrastructure.

• USD: ACH, Fedwire, SWIFT
• SGD: FAST, GIRO, RTGS, SWIFT, PayNow
• CNH: LOCAL, SWIFT
• HKD: ACH, FPS, RTGS, SWIFT
• EUR: LOCAL, SWIFT
• CAD: EFT, Interac e-Transfer, SWIFT, Bill Payment
• MYR: LOCAL
• GBP: Faster Payments, CHAPS, SWIFT
• IDR: LOCAL
• JPY: LOCAL, SWIFT
• NZD: Bank Transfer, SWIFT
• AUD: NPP, Bank Transfer, BPAY, SWIFT

For the following countries/regions, IBAN is mandatory (mostly applicable to European and some other countries):

Country Codes:
AL, AD, AT, AZ, BH, BY, BE, BA, BR, BG, CR, HR, CY, CZ, DK, DO, EG, SV, EE, FO, FI, FR, GE, DE, GI, GR, GL, GT, VA, HU, IS, IQ, IE, IL, IT, JO, KZ, XK, KW, LV, LB, LY, LI, LT, LU, MT, MR, MU, MD, MC, ME, NL, MK, NO, PK, PS, PL, PT, QA, RO, LC, SM, ST, SA, RS, SC, SK, SI, ES, SD, SE, CH, TL, TN, TR, UA, AE, GB, VG.

If the beneficiary bank is located in any of the above-listed countries/regions, IBAN must be provided.

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.