/v2/beneficiaries/{id}

GET

Get a beneficiary.

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
NameInTypeDescription
X-Auth-Token header string Authentication token.
id path string Beneficiary UUID.
Optional
NameInTypeDescription
on_behalf_of query string Contact UUID.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/beneficiaries/{id}

Response

{
    "id": "3bc3a5fe-8257-4aee-ac6c-1abc15770f53",
    "bank_account_holder_name": "My Test Account Holder",
    "name": "My Test Beneficiary 1",
    "email": null,
    "payment_types": [
        "regular"
    ],
    "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-06-27T13:21:27+00:00",
    "updated_at": "2018-06-27T13:21:27+00:00",
    "beneficiary_external_reference": null
}
Error Codes
HTTP Status Code Description Params
400 beneficiary_not_found Beneficiary was not found for this id
contact_not_found Contact was not found for this id
on_behalf_of_self You cannot act on behalf of your own Contact
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