Get Beneficiary Requirements - Currencycloud API Documentation

Home > Get Beneficiary Requirements

/v2/reference/beneficiary_required_details

GET

Find out what information is required to make payments to beneficiaries in specified currencies and countries.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
currency	query	string	Currency in which money is held in the beneficiary's bank account. Three-letter currency code in uppercase.
bank_account_country	query	string	Two-letter country code.
beneficiary_country	query	string	Two-letter country code. If the beneficiary is a company, the country in which the company is registered. If the beneficiary is an individual, a country in which the beneficiary holds nationality.

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/beneficiary_required_details

Response

{
    "details": [
        {
            "payment_type": "priority",
            "beneficiary_entity_type": "individual",
            "beneficiary_address": "^.{1,255}",
            "beneficiary_city": "^.{1,255}",
            "beneficiary_country": "^[A-z]{2}$",
            "beneficiary_first_name": "^.{1,255}",
            "beneficiary_last_name": "^.{1,255}",
            "acct_number": "^\\d{8}$",
            "sort_code": "^\\d{6}$"
        },
        {
            "payment_type": "priority",
            "beneficiary_entity_type": "company",
            "beneficiary_address": "^.{1,255}",
            "beneficiary_city": "^.{1,255}",
            "beneficiary_country": "^[A-z]{2}$",
            "beneficiary_company_name": "^.{1,255}",
            "acct_number": "^\\d{8}$",
            "sort_code": "^\\d{6}$"
        },
        {
            "payment_type": "priority",
            "beneficiary_entity_type": "individual",
            "beneficiary_address": "^.{1,255}",
            "beneficiary_city": "^.{1,255}",
            "beneficiary_country": "^[A-z]{2}$",
            "beneficiary_first_name": "^.{1,255}",
            "beneficiary_last_name": "^.{1,255}",
            "iban": "([A-Z0-9]\\s*){15,34}",
            "bic_swift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$"
        },
        {
            "payment_type": "priority",
            "beneficiary_entity_type": "company",
            "beneficiary_address": "^.{1,255}",
            "beneficiary_city": "^.{1,255}",
            "beneficiary_country": "^[A-z]{2}$",
            "beneficiary_company_name": "^.{1,255}",
            "iban": "([A-Z0-9]\\s*){15,34}",
            "bic_swift": "^[0-9A-Z]{8}$|^[0-9A-Z]{11}$"
        },
        {
            "payment_type": "regular",
            "acct_number": "^\\d{8}$",
            "sort_code": "^\\d{6}$",
            "beneficiary_entity_type": "individual"
        },
        {
            "payment_type": "regular",
            "acct_number": "^\\d{8}$",
            "sort_code": "^\\d{6}$",
            "beneficiary_entity_type": "company"
        }
    ]
}

Error Codes

HTTP Status	Code	Description
400	bank_account_country_is_in_invalid_format	Bank account country is not a valid ISO 3166-1 Alpha-2 country code
	currency_is_in_invalid_format	Currency is not a valid ISO 4217 currency code
	beneficiary_country_is_in_invalid_format	Beneficiary country is not a valid ISO 3166-1 Alpha-2 country code
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this post helpful?

Let us know if you liked the post. That’s the only way we can improve.

Yes

/v2/reference/beneficiary_required_details

GET

API parameters

Required

Response

Error Codes

Start your borderless payments journey today

Cookies