Get payment actions

Find out all you need to know about history of a payment. This API provides details about each step of the payment lifecycle.

The request

Use the details below to set up your request. In the URI, replace {id} with the payment_id.

Endpoints

GEThttps://api.checkout.com/payments/{id}/actions
GEThttps://api.sandbox.checkout.com/payments/{id}/actions

Header and path parameters

HeaderValue

Authorization

REQUIRED

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub

Content-Type

REQUIRED

application/json
PathValue

id

REQUIRED

The payment ID, embedded within the URI.

The response

If successful, you should get a 200 Success response returning a list of data relating to the payment.

[
  {
    "id": "act_gefycn3jcvuupboxfmqrhk2aym",
    "type": "Refund",
    "processed_on": "2018-01-20T10:30:48Z",
    "amount": 6540,
    "approved": true,
    "response_code": "10000",
    "response_summary": "Approved",
    "_links": {
      "response-code": {
        "href": "https://api.checkout.com/refs/response-codes/10000"
      }
    }
  },
  {
    "id": "act_gefycn3jcvuupboxfmqrhk2aym",
    "type": "Capture",
    "processed_on": "2018-01-17T10:30:48Z",
    "amount": 6540,
    "approved": true,
    "response_code": "10000",
    "response_summary": "Approved",
    "metadata": {
      "shipping_ref": "MQIBN2"
    },
    "_links": {
      "response-code": {
        "href": "https://api.checkout.com/refs/response-codes/10000"
      }
    }
  },
  {
    "id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
    "type": "Authorization",
    "processed_on": "2018-01-17T09:30:48Z",
    "amount": 6540,
    "approved": true,
    "auth_code": "643381",
    "response_code": "10000",
    "response_summary": "Approved",
    "reference": "ORD-5023-4E89",
    "_links": {
      "response-code": {
        "href": "https://api.checkout.com/refs/response-codes/10000"
      }
    }
  }
]

If your request is unsuccessful, you may receive a 404 – Payment not found error.

Response parameters

Find out what the different fields in your successful response mean.

Field nameDescription

id

STRING

The unique identifier of the payment action.

type

STRING

The type of payment action (e.g., Authorization).

processed_on

STRING

The date and time the action took place.

amount

INTEGER

The action amount.

auth_code

STRING

The acquirer's authorization code for cards.

response_code

STRING

The gateway response code.

response_summary

STRING

The gateway response summary.

reference

STRING

Your defined reference for the action.

metadata

OBJECT

A set of key/value pairs that you can attach to an action.

_links

OBJECT

The links related to the action.

Payment actions

The table below outlines the different payment actions and their meanings.

Authorization

The payment request was sent successfully.

Capture

The authorized payment was captured in full.

Refund

Part or all of the captured amount was refunded.

Void

The payment was voided and never captured; the funds were returned to the customer.

Card Verification

The card verification request has been approved and the cardholder’s details have been saved to their account.

Payout

The card payout was processed successfully.

Can we help?

Thanks for using Checkout.com. If you need help or have a question, message our Support team at support@checkout.com.