Skip to main content

BankAccount

Bank account data. Refer to the Metadata API for valid field combinations. Fields
string
The account number of the bank account
string
The first address line of the bank
string
required
The ISO 3166-1 alpha-2 code of the bank’s country
string
required
The ISO 4217 code of the bank account’s currency
string
The identifier of the bank
string
The identifier type of the bank
string
Name of the bank account holder
string
The account for the correspondent account of the bank
string
The SWIFT code for the correspondent account of the bank
string
The IBAN of the bank account
string
The INN of the bank account
string
The KBK of the bank account
string
The KIO of the bank account
string
The KPP of the bank account
string
The purpose of payment is mandatory when the beneficiary account has specific currency types. See the section PurposeOfPayment for the currencies and their acceptable values.
string
The reason for trade of the bank account
string
The reference information which will be used as the default payment reference during payment initiation.
string
The Russian central account number of the bank account
string
The SWIFT code of the bank account
string
The VO of the bank account
string
required
The identifier of the bank account

BeneficiaryCoreData

This model is a representation of a beneficiary’s core data. Fields
string
required
The name of the beneficiary
array
The list of beneficiary’s email addresses
boolean
required
Whether the beneficiary should receive email notification of payments
string
The first address line of the beneficiary
string
The street name of the beneficiary*
string
The building number of the beneficiary*
string
The floor of the beneficiary*
string
The apartment/office number of the beneficiary*
string
required
The city of the beneficiary*
string
The state/region of the beneficiary*
string
The postcode of the beneficiary
string
required
The ISO 3166-1 alpha-2 code of the beneficiary’s country
* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.

Beneficiary

This model is a representation of a beneficiary. Fields
string
required
The name of the beneficiary (Always)
array
The list of beneficiary’s email addresses
boolean
required
Whether the beneficiary should receive email notification of payments (Always)
string
The first address line of the beneficiary
string
The street name of the beneficiary*
string
The building number of the beneficiary*
string
The floor of the beneficiary*
string
The apartment/office number of the beneficiary*
string
required
The city of the beneficiary* (Always)
string
The state/region of the beneficiary*
string
The postcode of the beneficiary
string
required
The ISO 3166-1 alpha-2 code of the beneficiary’s country (Always)
array
required
The list of beneficiary’s bank accounts (Always)
string
required
The beneficiary ID (Always)
string
required
Creation date of the beneficiary (Always)
string
required
AML status of the beneficiary (Always)
boolean
required
True if beneficiary is active, False otherwise (Always)
string
Unique external reference ID submitted by the client for the beneficiary.
* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.

AMLStatus

AML status of the Beneficiary Values

PurposeOfPayment

Valid purpose of payment values. When country is China, the following purpose of payment values are mandatory only for CNY currency. See values list When country is United Arab Emirates, the following purpose of payment values are mandatory for all currencies. See values list