Get a payment 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

X-Auth-Token header string Authentication token.
id path string Payment UUID.
with_deleted query boolean Include deleted payments.
purpose_code query string Payment Purpose Code (Mandatory for all INR payments).
on_behalf_of query string A contact UUID for the sub-acccount you're acting on behalf of.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/{id}


    "id": "be6ce38c-c48f-4af6-a706-2e881e4b042f",
    "amount": "10.00",
    "beneficiary_id": "3c654b3b-ea4b-483a-af09-18c699917cbf",
    "currency": "GBP",
    "reference": "This is a test reference.",
    "reason": "This is a test payment.",
    "status": "ready_to_send",
    "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "payment_type": "regular",
    "payment_date": "2021-08-31",
    "estimated_arrival": null,
    "transferred_at": "",
    "authorisation_steps_required": "0",
    "last_updater_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "short_reference": "210831-QS9NXD766",
    "conversion_id": null,
    "failure_reason": "",
    "payer_id": "68561f01-b5d8-4fad-9bcb-d1712a1bc0c8",
    "payer_details_source": "payer",
    "created_at": "2021-08-31T14:40:33+00:00",
    "updated_at": "2021-08-31T14:40:33+00:00",
    "payment_group_id": null,
    "unique_request_id": null,
    "failure_returned_amount": "0.00",
    "ultimate_beneficiary_name": null,
    "purpose_code": null,
    "charge_type": null,
    "fee_amount": null,
    "fee_currency": null
Error Codes
HTTP Status Code Description Params
400 invalid_id ID has invalid format
on_behalf_of_self You cannot act on behalf of your own Contact
payment_not_found Payment was not found for this id
contact_not_found Contact was not found for this id
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.