Required Bank Details

The bankDetails required for a Payee depend on the currency and the type of payment you want to make to the Payee.

Currency Specific Details

CurrencyRequired FieldsSupported Payment Schemes
GBPbankDetails.accountNumber
bankDetails.routingCodeType (SORT_CODE)
bankDetails.routingCodeValue
UK Faster Payments - FPS
CHAPS - CHAPS
EURbankDetails.ibanSEPA Credit Transfer - SCT
AUDbankDetails.accountNumber
bankDetails.routingCodeType (BSB)
bankDetails.routingCodeValue
Direct Entry - DE
USDbankDetails.iban
bankDetails.bic
bankDetails.routingCodes
or
bankDetails.accountNumber
bankDetails.bic
bankDetails.bankAddressCountry
bankDetails.routingCodes
SWIFT - SWIFT

When a Payee is created, the response contains a paymentSchemes param which tells you the Payment Schemes via which the created Payee can be sent a payment.

"paymentSchemes":[
      "FPS",
      "CHAPS"
   ]
"paymentSchemes":[
      "SCT"
   ]
"paymentSchemes":[
      "DE"
   ]
"paymentSchemes":[
      "SWIFT"
   ]

Additional Details for USD Payees

For USD payments, the bankDetails object has specific field requirements as outlined below:

I. Beneficiary Bank Details (USD)

Field NameTypeRequirement (for USD)Description
Account IdentificationOne of the following combinations is Required:
bankDetails.ibanStringRequired (if accountNumber is not provided)International Bank Account Number.
bankDetails.accountNumberStringRequired (if iban is not provided)The account number.
bankDetails.bicStringRequired (used with either iban or accountNumber)Bank Identifier Code (SWIFT BIC).
************
bankDetails.bankNameStringRequiredName of the beneficiary's bank.
bankDetails.bankAddressLine1StringRequiredAddress line 1 of the beneficiary's bank.
bankDetails.bankAddressCityStringRequiredCity of the beneficiary's bank.
bankDetails.bankAddressPostalCodeStringRequiredPostal code of the beneficiary's bank.
bankDetails.bankCountryString (ISO 3166-1 alpha-2)Required (if bankAddressCountry is not provided)Country of the beneficiary's bank.
bankDetails.bankAddressCountryString (ISO 3166-1 alpha-2)Required (if bankCountry is not provided)Country component of the beneficiary's bank address.
bankDetails.routingCodesObject or ArrayRequiredFor USD, the ABA code of the Sending Bank's US Correspondent is required. Please contact the sending bank if this ABA code isn't immediately available.

Example : [{"type": "ABA", "value": "021000021"}]
bankDetails.routingCodes.typeStringRequiredType of the routing code, e.g. ABA
bankDetails.routingCodes.valueStringRequiredValue of the routing code

Note on Account Identification: For USD bank details, you must provide either:

  • (bankDetails.iban , bankDetails.bic AND bankDetails.routingCodes ) OR
  • (bankDetails.accountNumber , bankDetails.bic AND bankDetails.routingCodes ).

Note on Bank Country: For USD bank details, at least one of bankDetails.bankCountry OR bankDetails.bankAddressCountry must also be provided.

II. Intermediary Bank Details (USD)

These fields are required for USD payments if bankDetails.intermediaryBicSwift is provided.

Field NameTypeRequirement (if intermediaryBicSwift is provided for USD)Description
bankDetails.intermediaryBicSwiftString(Trigger field for below requirements)SWIFT BIC of the intermediary bank.
bankDetails.intermediaryBankNameStringRequiredName of the intermediary bank.
bankDetails.intermediaryBankAddressLine1StringRequiredAddress line 1 of the intermediary bank.
bankDetails.intermediaryBankAddressCityStringRequiredCity of the intermediary bank.
bankDetails.intermediaryBankAddressPostalCodeStringRequiredPostal code of the intermediary bank.
bankDetails.intermediaryBankAddressCountryString (ISO 3166-1 alpha-2)RequiredCountry of the intermediary bank.