/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=ASIAWPXXYKBYJMRZUWX7%2F20201224%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20201224T094926Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECoaCWV1LXdlc3QtMSJHMEUCIHf388tqj%2FYlldrau0mL1UJimsYDgvw%2Bxa4xD90cfOFuAiEA0HnAsEMUsdICLXJ%2FhJ0yUdsdXMT7UsGwJuabmFn6YOwqogUI0%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgw0NDYxMjI0NDY5NjAiDNrzX%2B4U15V9cocopyr2BOZPKsHuZ%2BoA3iDSq2F%2B8%2FkJrTSHJ8YVoGe4S2o3FGDhzo0lQ9xemDRQgTkpAj0EzOEDH3Ku%2FdRIxFqhuf8oGudXQfvkkipUTBjDYh8tapJIJlBL7Kg1wze3t39tw5ybKT9qJF5KbnznhgF2DD5laG%2Ft%2BT%2BLcoPpsFmRMSaU7mb8xL3QgzgD5k%2FP%2Fiv72lKPWBn5%2FNDT15%2BXVXO80qgfbD4MbQbNe989DLj05GRxCLf%2BGz%2F9tEbkfg7RLk60GvIGoV3%2Bxk1%2FE1qn%2BW%2BR%2FZ%2FvBpURQnoz3%2BMCZgD%2F9Apa8mIMB5zlovCMc%2F6FumVwe3aSbO%2Bx7vo72CYPkYcosE105DxNBCF3Yw6nzK%2FDsfyEzVbEh%2BEJvJdN0eI43guR0oQE1oPU5jM4vUjzleROBscCML2Kg4VtHz02bE2Cvriz9uI64e0MlfAQXkx2WmlTwe4XJ3NZBf92AReJx%2BfUGoy1HoFVUuo6cOYFHIaSJ9hFzI1oLYAQagsA%2ByhC%2FePadoFpbginilYNfUFx0WpBnVaamA7X03cserPj8PAhqSbgbVqKxdbLOmGomCOG9dhJck59TXbbwDoPkmpEKDeml0a47YWrVwhLYmUrDvflWD4%2BnnjZsJ65brMQe%2F%2BUMMWpOCWZLgK7V3%2F3D4OkReRGWWtNR374%2BMKEaxUiJBJH3sJQMt0cNDapJPMzvEf41cTsOFuO2mW2yWNdhFjH6PSiIghyp8povdZ%2BPUGTUfJ8afESOOys3iZlByPShVSeV1U7U%2FqjsR9mIDutRyN%2FvD42XzHhTBZp4A4As15TqsDqaUZm94sg5XSCpZLWdea8616FmlI%2Fv%2BE9GQvg1TCmyJH%2FBTqaAVQsvz5aCBR%2FwtNYwprtzQGp1SEMAJ%2B3L4eiY7L6mvXEFJt9yaCtgtJaGwwmjk4P1zPe9ffb6Kqnu5Q4Ev%2FW8KpsywHa6ai%2F%2FK6UPQhvhGcnCH%2BkPGyGkX99IzTo1KPl2BRSzMza5rSiujcqP6fFLY5AvZCiDiC7AXb1K7OYlUsBoAVWuKy7Aoo4cxdVQaawXYyvrcuFqq8i%2Ffs%3D&X-Amz-Signature=93f0906d011855149c5539cefc89be50f9e32843b0a3d13a2085963d25d9c8c0",
    "created_at": "2018-08-03T13:18:23+00:00",
    "updated_at": "2020-12-23T16:47:09+00:00",
    "expires_at": "2020-12-25T00: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