Listing confirmations
You can have access to the complete list of confirmations by reaching the following endpoint:
GET https://confirmation-api.paycertify.com/api/confirmations
Field | Type | Description | Example |
---|---|---|---|
confirmations.*.id |
uuid |
The confirmation ID | baa88e8a-300a-4833-b716-48f85251b839 |
confirmations.*.created_at |
datetime |
Created at date/time | 2018-05-12T21:07:59.508Z |
confirmations.*.updated_at |
datetime |
Updated at date/time | 2018-05-12T21:07:59.508Z |
confirmations.*.state |
string |
Status of this confirmation request. The possible states are: idle , processing , confirmed , refused , failed , confirmations.*.expired |
processing |
confirmations.*.callback_url |
string |
The provided callback URL | http://hooks.my.com/paycertify |
confirmations.*.process_name |
string |
The selected process strategy name | email_ecommerce |
confirmations.*.process.id |
uuid |
Process-specific ID | baa88e8a-300a-4833-b716-48f85251b832 |
confirmations.*.process.state |
string |
Process-specific state. | waiting_response |
confirmations.*.process.email_address |
string |
[email protected] | |
confirmations.*.process.timeout_seconds |
string |
Time in seconds | 300 |
confirmations.*.process.fail_reason |
string |
A fail description when process fails | Delivery Error |
confirmations.*.process.created_at |
datetime |
Process-specific created at date | 2018-07-05T14:09:40.106Z |
confirmations.*.process.updated_at |
datetime |
Process-specific updated at date | 2018-07-05T14:09:40.106Z |
confirmations.*.confirmation_actions.*.id |
uuid |
Action ID | ce388e8a-300a-4833-b716-48f85251b839 |
confirmations.*.confirmation_actions.*.created_at |
datetime |
Action created at date | 2018-07-05T14:09:40.106Z |
confirmations.*.confirmation_actions.*.action_name |
string |
Action name | start |
confirmations.*.confirmation_actions.*.actor |
string |
Action’s actor | merchant |
confirmations.*.confirmation_actions.*.executed |
string |
If action is executed or not | true |
confirmations.*.confirmation_actions.*.error_message |
string |
Error message | Delivery Error |
curl --request GET \
--url 'https://confirmation-api.paycertify.com/api/confirmations' \
--header 'Authorization: Bearer D28A17DFD326A2E255DC4C69C17C2451446A7EC8' \
Responds with:
{
"id": "ca8d77c9-4477-4f48-bbea-9bc52264e74d",
"created_at": "2018-07-05T14:09:40.098Z",
"updated_at": "2018-07-05T14:09:40.110Z",
"state": "processing",
"callback_url": null,
"process_name": "email_ecommerce",
"process": {
"id": "df3a192a-33d2-4d98-8e2d-29709c73e840",
"state": "waiting_response",
"email_address": "[email protected]",
"timeout_seconds": 60,
"fail_reason": null,
"created_at": "2018-07-05T14:09:40.092Z",
"updated_at": "2018-07-05T14:09:40.137Z"
},
"confirmation_actions": [
{
"id": "d198c09a-6713-4fa3-ba75-187a409bf2b5",
"created_at": "2018-07-05T14:09:40.106Z",
"action_name": "start",
"actor": "merchant",
"parameters": {
"email_address": "[email protected]",
"timeout_seconds": "60"
},
"executed": null,
"error_message": null
}
]
}