Get payment actions

Last updated: April 24, 2024

You can retrieve information about the history and lifecycle of a payment or payout using the payment id returned in the response to your payment or payout request.

For the full API specification, refer to the API reference.

Information

Your base URL [prefix] is unique. To learn how to retrieve your unique base URLs for the sandbox and production environments, see API endpoints.

get

https://[prefix].api.checkout.com/payments/{id}/actions

The response will contain the history and lifecycle of the payment or payout that matches the ID you provided.

Note

If a payment matching the ID you provided was not found, you'll receive a 404 – Payment not found error.


1[
2  {
3    "id": "act_fd3h6evhpn3uxdoqbuu3lqnqbm",
4    "type": "Refund",
5    "processed_on": "2024-01-20T10:30:48Z",
6    "amount": 1000,
7    "approved": true,
8    "response_code": "10000",
9    "response_summary": "Approved"
10  },
11  {
12    "id": "act_gefycn3jcvuupboxfmqrhk2aym",
13    "type": "Capture",
14    "processed_on": "2024-01-17T10:30:48Z",
15    "amount": 6540,
16    "approved": true,
17    "response_code": "10000",
18    "response_summary": "Approved",
19    "processing": {
20      "acquirer_reference_number": "24021219099007452440793",
21      "acquirer_transaction_id": "00745244079"
22    },
23    "metadata": {
24      "shipping_ref": "MQIBN2"
25    }
26  },
27  {
28    "id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
29    "type": "Authorization",
30    "processed_on": "2024-01-17T09:30:48Z",
31    "amount": 6540,
32    "approved": true,
33    "auth_code": "643381",
34    "response_code": "10000",
35    "response_summary": "Approved",
36    "reference": "ORD-5023-4E89",
37    "processing": {
38      "retrieval_reference_number": "909913440644",
39      "acquirer_transaction_id": "440644309099499894406"
40    }
41  }
42]


1[
2  {
3    "id": "act_cvrbczl5llgehjzjqdupeezwt4",
4    "type": "Return",
5    "processed_on": "2024-06-12T13:49:19.145592Z",
6    "amount": 1000,
7    "approved": true,
8    "response_code": "30046",
9    "response_summary": "Bank Account Closed"
10  },
11  {
12    "id": "act_rhpascoezcwuxbez3qhsbtgpd4",
13    "type": "Payout",
14    "processed_on": "2024-06-12T13:49:19.1050138Z",
15    "amount": 1000,
16    "approved": true,
17    "response_code": "10000",
18    "response_summary": "Approved"
19  }
20]

The history of a payment or payout is described through the payment actions that occurred during its lifecycle.

The following table describes the possible payment actions you may see in your response:

Payment action	Description
`Authorization`	The payment request was sent successfully.
`Capture`	The authorized payment was captured in full.
`Card Verification`	The card verification request has been approved and the cardholder’s details have been saved to their account.
`Payout`	The payout request was processed successfully. To check whether the payout itself was successful, check the `approved` field in the response.
`Refund`	Part or all of the captured amount was refunded.
`Return`	The payout was returned. For example, because the destination account has been closed.
`Void`	The payment was voided and never captured; the funds were returned to the customer.

Some payment actions will expire after a period of time. The following table describes the expiry timelines for each scheme:

Information

You can request a manual partial or full refund within 365 days of the initial payment, or within 180 days for Automated Clearing House (ACH). This applies to all schemes.

Scheme	Initial authorization	Estimated authorization	Incremental authorization	Final partial captures
Visa	10 days or 30 days, depending on your processing configuration	10 days	10 days	No further actions are allowed Manual voids return a `403` status code Automatic void is triggered after 30 days
Mastercard	7 days or 30 days, depending on your processing configuration	30 days	30 days	No further actions are allowed Manual voids return a `403` status code Automatic void is triggered after 30 days
American Express	30 days	Not applicable	Not applicable	Not applicable
Cartes Bancaires	7 days	Not applicable	Not applicable	Not applicable
Diners Club International	30 days	Not applicable	Not applicable	Not applicable
Discover	30 days	Not applicable	Not applicable	Not applicable

For a full list of authorization validity periods as set by the card schemes, see Authorization validity period.

Get payment actions

Information

Note

Response example

Payment action definitions

Payment actions expiry

Information