View events
Last updated: 14th July 2022
Get a list of all event types, view details about a specific event, or get a list of all events related to a specific subject.
Get event types
For the full API specification, see the API reference.
get
https://api.checkout.com/workflows/event-types
Response example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[{"id": "gateway","display_name": "Gateway","description": "Events from the Checkout.com payment gateway","events": [{"id": "payment_approved","display_name": "Payment Authorized","description": "Occurs when a payment is successfully authorized by the Checkout.com payment gateway"}]}]
Other possible responses:
- 401 - Unauthorized
- 422 - Invalid data was sent
- 500 - Internal error
Get an event
For the full API specification, see the API reference.
get
https://api.checkout.com/workflows/events/{eventId}
Response example
Below is an example of a successful response.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{"id": "evt_az5sblvku4ge3dwpztvyizgcau","source": "gateway","type": "payment_approved","timestamp": "2019-08-24T14:15:22Z","version": "1.0.0","data": {"id": "pay_mbabizu24mvu3mela5njyhpit4","action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44","amount": 6540,"currency": "USD","approved": true,"status": "Authorized","auth_code": "643381","response_code": "10000","response_summary": "Approved","3ds": {"downgraded": true,"enrolled": "N"},"flagged": true,"source": {"type": "card","id": "src_nwd3m4in3hkuddfpjsaevunhdy","billing_address": {"address_line1": "Checkout.com","address_line2": "90 Tottenham Court Road","city": "London","state": "London","zip": "W1T 4TJ","country": "GB"},"phone": {"country_code": "+1","number": "415 555 2671"}},"customer": {"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44","email": "brucewayne@gmail.com","name": "Bruce Wayne"},"processed_on": "2020-02-27T11:26:59Z","reference": "ORD-5023-4E89","metadata": {"coupon_code": "NY2018","partner_id": 123989}},"action_invocations": [{"workflow_id": "wf_c7svxlvo2bbuva4f6s3xu4f7wm","workflow_action_id": "wfa_uzkxpffkvpiu5fe3h5ira7sqpa","status": "pending","_links": {"self": {"href": "https://api.checkout.com/events/evt_az5sblvku4ge3dwpztvyizgcau/actions/wfa_uzkxpffkvpiu5fe3h5ira7sqpa"}}}],"_links": {"self": {"href": "https://api.checkout.com/workflows/events/evt_az5sblvku4ge3dwpztvyizgcau"},"payment": {"href": "https://api.checkout.com/payments/pay_wlu3wxc26jounofs5iez75qaqa"},"dispute": {"href": "https://api.checkout.com/disputes/dsp_jfh5iqceqau0qw3ccf3p"}}}
Other possible responses:
- 401 - Unauthorized
- 404 - Event not found
- 500 - Internal error
Get subject events
For the full API specification, see the API reference.
get
https://api.checkout.com/workflows/events/subject/{subjectId}
Response example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{"data": [{"id": "evt_zrrgsvsr47ou7fng4shy4mtf64","type": "payment_approved","timestamp": "2019-05-23T08:25:53Z","_links": {"self": {"href": "https://api.checkout.com/events/evt_zrrgsvsr47ou7fng4shy4mtf64"}}},{"id": "evt_wgwdfyem4ode5furs5swyy6b2u","type": "payment_captured","timestamp": "2019-05-24T07:00:53Z","_links": {"self": {"href": "https://api.checkout.com/events/evt_zrrgsvsr47ou7fng4shy4mtf64"}}}]}
Other possible responses:
- 401 - Unauthorized
- 404 - Subject not found
- 500 - Internal error
Get action invocations
For the full API specification, see the API reference.
get
https://api.checkout.com/workflows/events/{eventId}/actions/{workflowActionId}
Response example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{"workflow_id": "wf_c7svxlvo2bbuva4f6s3xu4f7wm","event_id": "evt_az5sblvku4ge3dwpztvyizgcau","workflow_action_id": "wfa_uzkxpffkvpiu5fe3h5ira7sqpa","action_type": "webhook","status": "successful","action_invocations": [{"invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau","timestamp": "2019-05-23T08:26:59Z","retry": false,"succeeded": true,"final": true,"result_details": {"status_code": 200,"url": "https://example.com/webhooks","headers": {"Authorization": "<AUTHORIZATION_UUID>"},"response_received_timestamp": "2019-05-23T08:27:01Z"}},{"invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau","timestamp": "2019-05-23T08:27:01Z","retry": true,"succeeded": false,"final": false,"result_details": {"status_code": 500,"url": "https://example.com/webhooks","headers": {"Authorization": "<AUTHORIZATION_UUID>"},"response_received_timestamp": "2019-05-23T08:27:01Z"}}],"_links": {"self": {"href": "https://api.checkout.com/events/evt_az5sblvku4ge3dwpztvyizgcau/actions/wfa_uzkxpffkvpiu5fe3h5ira7sqpa"}}}
Other possible responses:
- 401 - Unauthorized
- 404 - Event not found
- 500 - Internal error