/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": "completed",
    "confirmation_url": "https:\/\/ccycloud-payment-confirmations-prod-demo1.s3.eu-west-1.amazonaws.com\/payment_confirmations\/e6b30f2d-0088-4d99-bb47-c6b136fcf447\/180502-PGCRYQ001.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWPXXYKBYHYOZNSNO%2F20210420%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20210420T155630Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECgaCWV1LXdlc3QtMSJHMEUCIFA4iUsQXGpAzSU47yZ62Fq%2FGPqKIEIlj5klXq1JZZCFAiEApnmr4Mj4SIBnaz2wRv%2FeOxANdszhPp2TR9kUTJ1dRa4qogUIkf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgw0NDYxMjI0NDY5NjAiDCrGWH%2FYDYCBQmLKFSr2BOf%2FbRrHWvXRhaNFMMUJztMvrED08rUefOIkrdo3sl0K%2B3CwHMgNRzOXXsqB%2Bhr9vNZP5q6BHyp5U3iT0qKpi1cYrRhYU9UOfXUs%2B%2FSQuqNMKDQFWcwKAb6TFxi%2Bw8IA1Fkl1rYTE87JyWVbq%2BEY7FY1SPqMvyCrWqNj%2BjgFhuyghlFzynw5hgGmmK4hbq5I8spVftcU8ThCGhIdYg4R2sNxwLB9ASZLsT7kldZzzNUqJe7yMRkNtUB2QYfDnj3YbIpaNbm%2BG5DN2qZo6R4d%2FoRzgK9KcmOtNM2aOcvzDtEgTZ%2BpnP8gTpUPsPyR%2BhsPa%2FEJl605cHla82MLB4Lw6WpcIqkTi8nXNPbKJALaUpAVySs%2BZC%2FfbsxSy27cDmglDMkv0LSvGEbVstXGosopz4GConfbjv8fx8nA07lo4SKzAMysmqgDvFZJFkq9pa2hyQb%2B2hjYMor725%2FsIg5n7EKfE1ya3qz75%2BJIx8hg31wL%2BT%2B2mJTtH0iLF8TZDyv%2F5Gh%2FSZBoZD6TP2VvFUdLGkoE5w8%2FV8lbLR9PhmIAQ0oIa5cknzgsQ1LSxninE0IMqE0nFiOqEYR3%2FrXzqGNVT7mD8QXoF%2FrjxdO%2B06CnhkZgFnkhkzfJ2oqp4t0yQdOcBWHHib44Hg9mtQUq5HVzr8C3pkIFTYg2oOslcIxN34rHu6ZrNPIVGztauCyy492VMaq7KC7xzpeaNKK8GGcVSP0u9teAoiYFfdNpM2SuIiouHKY4AeivmE4bSZcK8LsjxNaRokyT1MSiY3o0KcuNkG%2BFdIKXyhanTguztAOx0MdDNnQxRB5lMbPNnLtqBnUDTCzNI7%2BaijCu8%2FuDBjqaAR7%2FLYI9P9EUFF36bK%2F0rbayZXtTSNzf3hjlIrfwC9P8SCMbBXahf59aX6VqctDIHJ5p9C4IB4uJkULAmK4yX7jK0UOrzIBatG3NvEl06qA0ZMSjxN79gf8wvVcKb5CV5dxi%2BzhKlPJT4M7Cja6AhDErR8AnJjjMhTOzUCPAKQJD4aTxbpJNjSIyZxi4b%2FdYRfg%2FGjBlxysKQ%2BM%3D&X-Amz-Signature=06c205b003cf83cf89cfda0c497a36a4e544791f74fa56f4877bca091f7370c9",
    "created_at": "2018-08-03T13:18:23+00:00",
    "updated_at": "2021-04-20T15:51:02+00:00",
    "expires_at": "2021-04-22T00:00:00+00:00"
}
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.
Yes
No