/v2/payers/{id}

GET

Get a payer record.

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 Payer 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/payers/{id}

Response

{
    "id": "68561f01-b5d8-4fad-9bcb-d1712a1bc0c8",
    "legal_entity_type": "company",
    "company_name": "Currency Cloud Dev Centre",
    "first_name": null,
    "last_name": null,
    "address": "12 Steward Street",
    "city": "London",
    "state_or_province": null,
    "country": "GB",
    "postcode": "E1 6FQ",
    "date_of_birth": null,
    "identification_type": "incorporation_number",
    "identification_value": "123456789",
    "created_at": "2018-04-26T15:05:16+00:00",
    "updated_at": "2018-05-23T12:44:45+00:00"
}
Error Codes
HTTP Status Code Description Params
400 payer_not_found Payer was not found for this id
contact_not_found Contact was not found for this id
id_is_not_valid_uuid id should be in UUID format
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