Required Bank Details for Payees

This guide outlines the mandatory and optional information required when creating different types of payees via the API. The required bankDetails depend on the currency and the payment schemes you intend to use.

General Requirements for All Payees

The following fields are required for all payee types, regardless of currency or payment scheme:

Field	Description	Data Type	Required?
`type`	The type of payee.	`BUSINESS` or `PERSON`	Yes
`name`	The full legal name of the person or business.	String	Yes
`currency`	The currency of the payee's bank account.	ISO 4217 Code (e.g., `GBP`)	Yes
`address`	The full postal address of the payee.	Object	Yes
`address.state`	Please note that state field is required for entity with address in CA and US - regardless of currency	String	Yes

Bank Details by Currency

GBP Payees

FPS and CHAPS

For making payments via UK domestic rails (FPS and CHAPS).

Field	Description	Data Type	Required?
`bankDetails.accountNumber`	The 8-digit UK bank account number.	String	Yes
`bankDetails.routingCodeType`	The type of routing code. Must be `"SORT_CODE"`.	String	Yes
`bankDetails.routingCodeValue`	The 6-digit UK Sort Code.	String	Yes

EUR Payees (SEPA)

SEPA

For making payments via SEPA rails (SCT and SEPA Instant).

Field	Description	Data Type	Required?
`bankDetails.iban`	The International Bank Account Number.	String	Yes
`bankDetails.bic`	The Business Identifier Code (SWIFT code).	String	Yes

AUD Payees (Australia)

Direct Entry

For making payments via the Australian Direct Entry and NPP rail.

Field	Description	Data Type	Required?
`bankDetails.accountNumber`	The Australian bank account number.	String	Yes
`bankDetails.routingCodeType`	The type of routing code. Must be `"BSB"`.	String	Yes
`bankDetails.routingCodeValue`	The 6-digit Australian Bank-State-Branch (BSB) number.	String	Yes

USD Payees

International Wire

I. Beneficiary Bank Details (USD)

Field Name	Description	Data Type	Required?
Account Identification			One of the following combinations is Required:
`bankDetails.iban`	International Bank Account Number.	String	Yes (if `accountNumber` is not provided)
`bankDetails.accountNumber`	The account number.	String	Yes (if `iban` is not provided)
`bankDetails.bic`	Bank Identifier Code (SWIFT BIC).	String	Yes (used with either `iban` or `accountNumber`)

`bankDetails.bankName`	Name of the beneficiary's bank.	String	Yes
`bankDetails.bankAddressLine1`	Address line 1 of the beneficiary's bank.	String	Yes
`bankDetails.bankAddressCity`	City of the beneficiary's bank.	String	Yes
`bankDetails.bankAddressPostalCode`	Postal code of the beneficiary's bank.	String	Yes
`bankDetails.bankCountry`	Country of the beneficiary's bank.	String (ISO 3166-1 alpha-2)	Yes (if `bankAddressCountry` is not provided and it cannot be resolved by other bank details)
`bankDetails.bankAddressCountry`	Country component of the beneficiary's bank address.	String (ISO 3166-1 alpha-2)	Yes (if `bankCountry` is not provided and it cannot be resolved by other bank details)
`bankDetails.routingCodes`	For USD, the ABA code of the Receiving Bank's US Correspondent is required. Please contact the sending bank if this ABA code isn't immediately available. Example :`[{"type": "ABA", "value": "021000021"}]`	Object or Array	Yes
`bankDetails.routingCodes.type`	Type of the routing code, e.g. `ABA`	String	Yes
`bankDetails.routingCodes.value`	Value of the routing code	String	Yes

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 International Wire payments ifbankDetails.intermediaryBicSwift is provided.

Field Name	Type	Requirement (if `intermediaryBicSwift` is provided for USD)	Description
`bankDetails.intermediaryBicSwift`	String	(Trigger field for below requirements)	SWIFT BIC of the intermediary bank.
`bankDetails.intermediaryBankName`	String	Yes	Name of the intermediary bank.
`bankDetails.intermediaryBankAddressLine1`	String	Yes	Address line 1 of the intermediary bank.
`bankDetails.intermediaryBankAddressCity`	String	Yes	City of the intermediary bank.
`bankDetails.intermediaryBankAddressPostalCode`	String	Yes	Postal code of the intermediary bank.
`bankDetails.intermediaryBankAddressCountry`	String (ISO 3166-1 alpha-2)	Yes	Country of the intermediary bank.

ACH

For making payments via ACH rails ( ACH and ACH_SAME_DAY).

Field	Description	Data Type	Required?
`bankDetails.accountNumber`	Bank Account Number.	String	Yes
`bankDetails.accountType`	Us Account Type (CHECKING/SAVINGS).	String	Yes
`bankDetails.routingCodes`	For USD, the ABA (RTN) code of the US Recipient Bank is required. Example :`[{"type": "ABA", "value": "021000021"}]`	Object or Array	Yes
`bankDetails.routingCodes.type`	Type of the routing code, e.g. `ABA`	String	Yes
`bankDetails.routingCodes.value`	Valid nine digit US ABA Routing Transit Number.	String	Yes

Domestic WIRE

For making payments via FedWire rails.

Field	Description	Data Type	Required?
`bankDetails.accountNumber`	Bank Account Number.	String	Yes
`bankDetails.routingCodes`	For USD, the WIRE (RTN) code of the US Recipient Bank is required. Example :`[{"type": "WIRE", "value": "021000021"}]`	Object or Array	Yes
`bankDetails.routingCodes.type`	Type of the routing code, e.g. `WIRE`	String	Yes
`bankDetails.routingCodes.value`	Valid nine digit US ABA Routing Transit Number.	String	Yes
`bankDetails.bankName`	Name of the beneficiary's bank.	String	Yes

Special Case: Payees for CHAPS Payments with Purpose Codes

When making a CHAPS payment to Financial Institution, you must provide additional structured data - LEI code - within the paymentSchemeDetails object at the time of payment initiation. These fields are not part of the payee creation itself, but are required for the payment. You can find the details here

Field	Description	Data Type	Required for CHAPS?
`paymentSchemeDetails.scheme`	The payment scheme. Must be `"CHAPS"`.	String	Yes
`paymentSchemeDetails.purposeCode`	The specific 4-letter code for the payment's purpose.	String	Yes
`paymentSchemeDetails.categoryPurposeCode`	The broader 4-letter category for the payment's purpose.	String	Yes