/v2/payments/{id}/confirmation

GET

Get confirmation for a payment.

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 Payment 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/payments/{id}/confirmation

Response

{
    "id": "e6b30f2d-0088-4d99-bb47-c6b136fcf447",
    "payment_id": "796e0d7d-bae6-4d8a-b217-3cf9ee80a350",
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "short_reference": "PC-2436231-LYODVS",
    "status": "failed",
    "confirmation_url": "",
    "created_at": "2018-08-03T13:18:23+00:00",
    "updated_at": "2018-08-03T13:18:23+00:00",
    "expires_at": 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 page helpful?
Yes
No