/v2/beneficiaries/find

GET

Find beneficiaries attached to the account or any sub-account owned by the authenticating user.

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
NameInTypeDescriptionEnumFormatDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumFormatDefault
on_behalf_of query string Contact UUID.
bank_account_holder_name query string Bank account holder's name.
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.
currency query string Currency in which money is held in the beneficiary's bank account. Three-digit currency code.
account_number query string Bank account number.
routing_code_type query string Local payment routing system. sort_code
bsb_code
institution_no
bank_code
branch_code
aba
clabe
cnaps
ifsc
routing_code_value query string Routing code.
bic_swift query string BIC/SWIFT code.
iban query string IBAN code.
default_beneficiary query boolean Payments are made automatically to default beneficiaries when a beneficiary is not specified.
bank_name query string Bank name.
bank_account_type query string Bank account type. checkings
savings
name query string Beneficiary name.
beneficiary_entity_type query string Legal entity. individual
company
beneficiary_company_name query string Required if "beneficiary_entity_type" is "company".
beneficiary_first_name query string Required if "beneficiary_entity_type" is "individual".
beneficiary_last_name query string Required if "beneficiary_entity_type" is "individual".
beneficiary_city query string City.
beneficiary_postcode query string Post code.
beneficiary_state_or_province query string State or province.
beneficiary_date_of_birth query string If "beneficiary_entity_type" is "company", date of registration. If "beneficiary_entity_type" is "individual", date of birth. ISO 8601 format YYYY-MM-DD. date
scope query string Search "own" account, "clients" sub-accounts, or "all" accounts. own
clients
all
 own
page query integer Page number.
per_page query integer Number of results per page.
order query string Any field name to change the sort order.
order_asc_desc query string Sort records in ascending or descending order. asc
desc
 asc
beneficiary_external_reference query string Beneficiary external reference 
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/beneficiaries/find

Response

{
    "beneficiaries": [
        {
            "id": "8dc6f3f0-6e7a-4d7b-8eb5-62b4f0813278",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6fe7528ae0",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:19:16+00:00",
            "updated_at": "2018-10-17T09:19:16+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "fce076ca-6f63-4d18-b9d2-62b1d742e3fb",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6feafd09a6",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:20:12+00:00",
            "updated_at": "2018-10-17T09:20:12+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "80c86280-f118-4a20-b62c-382d0d43b1c8",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6feafd09a6",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:20:13+00:00",
            "updated_at": "2018-10-17T09:20:13+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "e8c25b2b-60cf-465d-99e9-cf3825d32fb1",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6fee268373",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:20:42+00:00",
            "updated_at": "2018-10-17T09:20:42+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "a80441a6-a6cd-4b86-9cc2-8113dd653973",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6fee268373",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:20:43+00:00",
            "updated_at": "2018-10-17T09:20:43+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "066d9e3a-535f-480b-ac45-52c81ec65c36",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ff0d2c217",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:21:24+00:00",
            "updated_at": "2018-10-17T09:21:24+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "fc0af531-93a6-472a-af3a-3270106841c9",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ff0d2c217",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:21:25+00:00",
            "updated_at": "2018-10-17T09:21:25+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "0095acc5-f11f-4030-a1cb-6c5474e0b181",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ff6c2e37c",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:23:25+00:00",
            "updated_at": "2018-10-17T09:23:25+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "0a02b990-b59b-4495-8e9c-8b56b87f87af",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ff6c2e37c",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:23:26+00:00",
            "updated_at": "2018-10-17T09:23:26+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "9781d436-ec21-45d8-bb48-858d77ae7fc6",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ffdb60826",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:25:11+00:00",
            "updated_at": "2018-10-17T09:25:11+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "4fa67b97-6975-4763-9516-596aa3f9bcc4",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc6ffdb60826",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:25:12+00:00",
            "updated_at": "2018-10-17T09:25:12+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "af516cc7-d854-4a4f-bf24-bdcd4595479a",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc7021c31363",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:35:03+00:00",
            "updated_at": "2018-10-17T09:35:03+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "6195b9ce-ac6d-4c4e-ba33-c64b68a194d2",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc7021c31363",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:35:04+00:00",
            "updated_at": "2018-10-17T09:35:04+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "36645e57-e887-46bc-8b43-1cea157a88c8",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc702599eeab",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:35:30+00:00",
            "updated_at": "2018-10-17T09:35:30+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "767a7af9-321e-46c0-941d-9b2354b6c545",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc702599eeab",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:35:30+00:00",
            "updated_at": "2018-10-17T09:35:30+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "9901d2a7-41e7-48e8-80b7-e4466df8ac3b",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc7038eac239",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:40:39+00:00",
            "updated_at": "2018-10-17T09:40:39+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "07a17908-f0cd-4ab0-9f10-0cedea301e76",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc7038eac239",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T09:40:40+00:00",
            "updated_at": "2018-10-17T09:40:40+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "6a1749c6-2632-45eb-aed3-9e7d438a632b",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc716274ad4d",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T11:00:13+00:00",
            "updated_at": "2018-10-17T11:00:13+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "46a041e0-eb09-4d91-8aa1-1672466b24b9",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc716274ad4d",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-17T11:00:14+00:00",
            "updated_at": "2018-10-17T11:00:14+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "4cec54b3-01f7-4953-a8a4-7d25e7c0a4ab",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc87bc2c9098",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T12:25:47+00:00",
            "updated_at": "2018-10-18T12:25:47+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "d7f503b1-40e4-490e-affc-85e9f3bf2905",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc87bc2c9098",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T12:25:47+00:00",
            "updated_at": "2018-10-18T12:25:47+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "b1425644-d580-48b7-a472-3ffd85d0044a",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc87c15036da",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T12:27:27+00:00",
            "updated_at": "2018-10-18T12:27:27+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "2d5597cc-e64a-4f70-a6da-4382fea4b6e0",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc87c15036da",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T12:27:28+00:00",
            "updated_at": "2018-10-18T12:27:28+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "7a82e6d3-dad3-4329-b646-e61c2c9fd841",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc88a612d91f",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T13:28:35+00:00",
            "updated_at": "2018-10-18T13:28:35+00:00",
            "beneficiary_external_reference": null
        },
        {
            "id": "f85c4312-ef7e-43c9-a8c4-2a4cd47b3768",
            "bank_account_holder_name": "My Test Account Holder",
            "name": "My Test Beneficiary 5bc88a612d91f",
            "email": null,
            "payment_types": [],
            "beneficiary_address": [],
            "beneficiary_country": null,
            "beneficiary_entity_type": null,
            "beneficiary_company_name": null,
            "beneficiary_first_name": null,
            "beneficiary_last_name": null,
            "beneficiary_city": null,
            "beneficiary_postcode": null,
            "beneficiary_state_or_province": null,
            "beneficiary_date_of_birth": null,
            "beneficiary_identification_type": null,
            "beneficiary_identification_value": null,
            "bank_country": "GB",
            "bank_name": "TEST BANK NAME",
            "bank_account_type": null,
            "currency": "GBP",
            "account_number": "3284734675",
            "routing_code_type_1": "sort_code",
            "routing_code_value_1": "101193",
            "routing_code_type_2": null,
            "routing_code_value_2": null,
            "bic_swift": null,
            "iban": null,
            "default_beneficiary": "false",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "bank_address": [
                "TEST BANK ADDRESS",
                " NOT USING EXTERNAL SERVICE",
                " DEVELOPMENT ENVIRONMENT."
            ],
            "created_at": "2018-10-18T13:28:36+00:00",
            "updated_at": "2018-10-18T13:28:36+00:00",
            "beneficiary_external_reference": null
        }
    ],
    "pagination": {
        "total_entries": 565,
        "total_pages": 23,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 bank_account_holder_name_is_too_short bank_account_holder_name can not be shorter than 1 character(s) { "minlength" => 1 }
bank_account_holder_name_is_too_long bank_account_holder_name can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_country_is_in_invalid_format beneficiary_country is in invalid format
currency_is_in_invalid_format currency is in invalid format
bank_name_is_too_short bank_name can not be shorter than 1 character(s) { "minlength" => 1 }
bank_name_is_too_long bank_name can not be longer than 100 character(s) { "maxlength" => 100 }
bank_account_type_not_in_range bank_account_type should be in range: checking, savings { "range" => "checking, savings" }
account_number_is_too_short account_number can not be shorter than 1 character(s) { "minlength" => 1 }
account_number_is_too_long account_number can not be longer than 50 character(s) { "maxlength" => 50 }
incorrect_mapping Following parameters must have same keys { "parameters" => "routing_code_value,routing_code_type" }
routing_code_type_is_too_short routing_code_type can not be shorter than 1 character(s) { "minlength" => 1, "indices" => ["0", "1"] }
routing_code_type_is_too_long routing_code_type can not be longer than 50 character(s) { "maxlength" => 50, "indices" => ["0", "1"] }
routing_code_type_type_is_wrong routing_code_type should be of hash type { "type" => "hash" }
routing_code_type_not_included_in_list One or more of routing_code_type items are not included in list { "list" => "sort_code,bsb_code,institution_no,bank_code,branch_code,aba,clabe }
routing_code_type_too_many_items routing_code_type should have less than 50 items { "maxcount" => 50 }
beneficiary_date_of_birth_type_is_wrong beneficiary_date_of_birth should be of date type { "type" => "date" }
beneficiary_date_of_birth_is_incorrect beneficiary_date_of_birth is incorrect
beneficiary_date_of_birth_is_earlier beneficiary_date_of_birth should be later than 1900-01-01 { "min_date" => "1900-01-01" }
beneficiary_date_of_birth_is_after beneficiary_date_of_birth should be earlier than todays date { "max_date" => "Todays Date" }
routing_code_value_is_too_short routing_code_value can not be shorter than 1 character(s) { "minlength" => 1, "indices" => ["0", "1"] }
routing_code_value_is_too_long routing_code_value can not be longer than 50 character(s) { "maxlength" => 50, "indices" => ["0", "1"] }
routing_code_value_type_is_wrong routing_code_value should be of hash type { "type" => "hash" }
bic_swift_is_in_invalid_format bic_swift is in invalid format
iban_is_too_long iban can not be longer than 34 character(s) { "maxlength" => 34 }
iban_is_too_short iban can not be shorter than 1 character(s) { "minlength" => 1 }
iban_is_in_invalid_format iban is in invalid format
default_beneficiary_type_is_wrong default_beneficiary should be of boolean type { "type" => "boolean" }
name_is_too_short name can not be shorter than 1 character(s) { "minlength" => 1 }
name_is_too_long name can not be longer than 100 character(s) { "maxlength" => 100 }
order_asc_desc_not_in_range order_asc_desc should be in range: asc, desc { "range" => "asc, desc" }
order_not_in_range order should be in range: bank_account_holder_name, beneficiary_country, currency, account_number, bic_swift, iban, default_beneficiary, bank_address, name, bank_account_type, beneficiary_entity_type, beneficiary_city, beneficiary_address, beneficiary_company_name, beneficiary_first_name, beneficiary_last_name, beneficiary_state_or_province, beneficiary_postcode, created_at, updated_at { "range" => "bank_account_holder_name, beneficiary_country, currency, account_number, bic_swift, iban, default_beneficiary, bank_address, name, bank_account_type, beneficiary_entity_type, beneficiary_city, beneficiary_address, beneficiary_company_name, beneficiary_first_name, beneficiary_last_name, beneficiary_state_or_province, beneficiary_postcode, created_at, updated_at" }
on_behalf_of_self You cannot act on behalf of your own Contact
contact_not_found Contact was not found for this id
on_behalf_of_is_not_valid_uuid on_behalf_of should be in UUID format
beneficiary_external_reference_is_too_short beneficiary_external_reference can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_external_reference_is_too_long beneficiary_external_reference can not be longer than 255 character(s) { "maxlength" => 255 }
cope_not_in_range scope should be in range: own, all, clients { "range" => "own, all, clients" }
beneficiary_entity_type_not_in_range beneficiary_entity_type should be in range: individual, company { "range" => "individual, company" }
beneficiary_company_name_is_too_short beneficiary_company_name can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_company_name_is_too_long beneficiary_company_name can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_first_name_is_too_short beneficiary_first_name can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_first_name_is_too_long beneficiary_first_name can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_last_name_is_too_short beneficiary_last_name can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_last_name_is_too_long beneficiary_last_name can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_city_is_too_short beneficiary_city can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_city_is_too_long beneficiary_city can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_postcode_is_too_short beneficiary_postcode can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_postcode_is_too_long beneficiary_postcode can not be longer than 255 character(s) { "maxlength" => 255 }
beneficiary_state_or_province_is_too_short beneficiary_state_or_province can not be shorter than 1 character(s) { "minlength" => 1 }
beneficiary_state_or_province_is_too_long beneficiary_state_or_province can not be longer than 255 character(s) { "maxlength" => 255 }
page_type_is_wrong page should be of integer type { "type" => "integer" }
page_is_too_small page can not be smaller than 1 { "minvalue" => 1 }
per_page_type_is_wrong per_page should be of integer type { "type" => "integer" }
per_page_is_too_small per_page can not be smaller than 1 { "minvalue" => 1 }
order_asc_desc_not_in_range order_asc_desc should be in range: asc, desc { "range" => "asc, desc" }
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 page helpful?
Yes
No

Start your borderless payments journey today

Talk to an expert

Cookies

This site uses cookies: Read our cookie policy