Skip to content

Last updated: April 29, 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
"id": "gateway",
4
"display_name": "Gateway",
5
"description": "Events from the Checkout.com payment gateway",
6
"events": [
7
{
8
"id": "payment_approved",
9
"display_name": "Payment Authorized",
10
"description": "Occurs when a payment is successfully authorized by the Checkout.com payment gateway"
11
}
12
]
13
}
14
]

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
"id": "evt_az5sblvku4ge3dwpztvyizgcau",
3
"source": "gateway",
4
"type": "payment_approved",
5
"timestamp": "2019-08-24T14:15:22Z",
6
"version": "1.0.0",
7
"data": {
8
"id": "pay_mbabizu24mvu3mela5njyhpit4",
9
"action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
10
"amount": 6540,
11
"currency": "USD",
12
"approved": true,
13
"status": "Authorized",
14
"auth_code": "643381",
15
"response_code": "10000",
16
"response_summary": "Approved",
17
"3ds": {
18
"downgraded": true,
19
"enrolled": "N"
20
},
21
"flagged": true,
22
"source": {
23
"type": "card",
24
"id": "src_nwd3m4in3hkuddfpjsaevunhdy",
25
"billing_address": {
26
"address_line1": "123 Anywhere St.",
27
"address_line2": "Apt. 456",
28
"city": "Anytown",
29
"state": "AL",
30
"zip": "123456",
31
"country": "US"
32
},
33
"phone": {
34
"country_code": "+1",
35
"number": "555 123 4567"
36
}
37
},
38
"customer": {
39
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
40
"email": "john.smith@example.com",
41
"name": "John Smith"
42
},
43
"processed_on": "2020-02-27T11:26:59Z",
44
"reference": "ORD-5023-4E89",
45
"metadata": {
46
"coupon_code": "NY2018",
47
"partner_id": 123989
48
}
49
},
50
"action_invocations": [
51
{
52
"workflow_id": "wf_c7svxlvo2bbuva4f6s3xu4f7wm",
53
"workflow_action_id": "wfa_uzkxpffkvpiu5fe3h5ira7sqpa",
54
"status": "pending",
55
"_links": {
56
"self": {
57
"href": "https://api.checkout.com/events/evt_az5sblvku4ge3dwpztvyizgcau/actions/wfa_uzkxpffkvpiu5fe3h5ira7sqpa"
58
}
59
}
60
}
61
],
62
"_links": {
63
"self": {
64
"href": "https://api.checkout.com/workflows/events/evt_az5sblvku4ge3dwpztvyizgcau"
65
},
66
"payment": {
67
"href": "https://api.checkout.com/payments/pay_wlu3wxc26jounofs5iez75qaqa"
68
},
69
"dispute": {
70
"href": "https://api.checkout.com/disputes/dsp_jfh5iqceqau0qw3ccf3p"
71
}
72
}
73
}

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
"data": [
3
{
4
"id": "evt_zrrgsvsr47ou7fng4shy4mtf64",
5
"type": "payment_approved",
6
"timestamp": "2019-05-23T08:25:53Z",
7
"_links": {
8
"self": {
9
"href": "https://api.checkout.com/events/evt_zrrgsvsr47ou7fng4shy4mtf64"
10
}
11
}
12
},
13
{
14
"id": "evt_wgwdfyem4ode5furs5swyy6b2u",
15
"type": "payment_captured",
16
"timestamp": "2019-05-24T07:00:53Z",
17
"_links": {
18
"self": {
19
"href": "https://api.checkout.com/events/evt_zrrgsvsr47ou7fng4shy4mtf64"
20
}
21
}
22
}
23
]
24
}

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
"workflow_id": "wf_c7svxlvo2bbuva4f6s3xu4f7wm",
3
"event_id": "evt_az5sblvku4ge3dwpztvyizgcau",
4
"workflow_action_id": "wfa_uzkxpffkvpiu5fe3h5ira7sqpa",
5
"action_type": "webhook",
6
"status": "successful",
7
"action_invocations": [
8
{
9
"invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau",
10
"timestamp": "2019-05-23T08:26:59Z",
11
"retry": false,
12
"succeeded": true,
13
"final": true,
14
"result_details": {
15
"status_code": 200,
16
"url": "https://example.com/webhooks",
17
"headers": {
18
"Authorization": "<AUTHORIZATION_UUID>"
19
},
20
"response_received_timestamp": "2019-05-23T08:27:01Z"
21
}
22
},
23
{
24
"invocation_id": "ivc_az5sblvku4ge3dwpztvyizgcau",
25
"timestamp": "2019-05-23T08:27:01Z",
26
"retry": true,
27
"succeeded": false,
28
"final": false,
29
"result_details": {
30
"status_code": 500,
31
"url": "https://example.com/webhooks",
32
"headers": {
33
"Authorization": "<AUTHORIZATION_UUID>"
34
},
35
"response_received_timestamp": "2019-05-23T08:27:01Z"
36
}
37
}
38
],
39
"_links": {
40
"self": {
41
"href": "https://api.checkout.com/events/evt_az5sblvku4ge3dwpztvyizgcau/actions/wfa_uzkxpffkvpiu5fe3h5ira7sqpa"
42
}
43
}
44
}

Other possible responses:

  • 401 - Unauthorized
  • 404 - Event not found
  • 500 - Internal error