Skip to main content
GET
Get beneficiary metadata
Describes the fields required to provision a valid beneficiary for a given country/currency combination:
  • All supported countries are described by this API;
  • For each supported country, any currency that has specific requirements is defined in the currencies list. If there are no specific requirements the value default should be used.
  • The response of this endpoint is in line with the SWIFT ISO20022 standards. Please note, the mandatory fields and business rules around beneficiary address defined via this endpoint, does not apply to Ebury Mass Payments customers. Should you have any doubts, please reach out to us.

Authorizations

x-api-key
string
header
required

An API Key.

Response

Beneficiary metadata.

country
string

The country, expressed as an ISO 3166-1 alpha-2 value.

currencies
object[]

The requirements for a given currency for this country.

reason_required
boolean

Whether or not a reason for trade for the country needs to be supplied.