Get payment actions
Last updated: July 26, 2023
Find out all you need to know about history of a payment. This API provides details about each step of the payment lifecycle.
Use the following details to set up your request. In the URI, replace {id}
with the payment_id
.
For the full API specification, see the API reference.
get
https://api.checkout.com/payments/{id}/actions
If successful, you should get a 200 Success
response returning a list of data relating to the payment.
1[2{3"id": "act_fd3h6evhpn3uxdoqbuu3lqnqbm",4"type": "Refund",5"processed_on": "2018-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": "2018-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": "2018-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]
Information
If your request is unsuccessful, you may receive a 404 – Payment not found
error.
Find out what the different fields in your successful response mean by looking at our API reference.
The following table outlines the different payment actions and their meanings:
| The payment request was sent successfully. |
| The authorized payment was captured in full. |
| Part or all of the captured amount was refunded. |
| The payment was voided and never captured; the funds were returned to the customer. |
| The card verification request has been approved and the cardholder’s details have been saved to their account. |
| The card payout was processed successfully. |
The following table shows the number of days after which payment actions expire 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 | Either 7 days or 30 days (depending on your processing configuration) | 7 days | 7 days |
|
Mastercard | Either 7 days or 30 days (depending on your processing configuration) | 30 days | 30 days |
|
AMEX | 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 |