Checkout.com API logo

Transactions

Get a list of transactions

Beta

Returns a list of transactions based on the matching input parameters in reverse chronological order, with the most recent transactions shown first.

SecurityOAuth2: OAuth
Request
query Parameters
limit
integer <int32> [ 1 .. 100 ]

The maximum number of transactions returned (between 10-100). The default is 10.

skip
integer <int32> [ 1 .. 500 ]

The number of transactions to skip. The default is 0.

cardholder_id
string (IssuingCardholderId) = 30 characters ^crh_[a-z0-9]{26}$

The cardholder's unique identifier.

Example: cardholder_id=crh_d3ozhf43pcq2xbldn2g45qnb44
card_id
string (IssuingCardId) = 30 characters ^crd_[a-z0-9]{26}$

The card's unique identifier.

Example: card_id=crd_fa6psq242dcd6fdn5gifcq1491
entity_id
string (IssuingEntityId) = 30 characters ^ent_[a-z0-9]{26}$

The entity's unique identifier.

Example: entity_id=ent_fa6psq242dcd6fdn5gifcq1491
status
string

An optional filter for the transaction lifecycle status.

Enum: "authorized" "declined" "canceled" "cleared" "refunded" "disputed"
Example: status=disputed
from
string <date-time>

An optional start date filter for transactions, in ISO 8601 format.

Example: from=2023-08-15T17:30:09Z
to
string <date-time>

An optional end date filter for transactions, in ISO 8601 format.

Example: to=2023-09-15T17:30:09Z
Responses
200

Transactions returned successfully.

401

Unauthorized

404

Not Found

422

Matching parameters not valid.

429

Too Many Requests

get/issuing/transactions
Request samples 
Response samples 
application/json
{
  • "limit": 5,
  • "skip": 10,
  • "total_count": 100,
  • "data": [
    ]
}
Get a single transaction
Beta

Get the details of a transaction using its ID.


SecurityOAuth2: OAuth 
Request 
path Parameters
transactionId
required
string (IssuingTransactionId)   = 30 characters ^trx_[a-z0-9]{26}$
The transaction's unique identifier.


 
 Example:  trx_aayhhfwbdyxwcaeyhhfwbd4xga
Responses 
200
Issuing transaction retrieved successfully


401
Unauthorized


403
Forbidden


404
Transaction Not Found


406
Not Acceptable


429
Too Many Requests


default
Issuing transaction response retrieved successfully


get/issuing/transactions/{transactionId}
Request samples 
Response samples 
application/json
{
  • "id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga",
  • "created_on": "2019-08-24T14:15:22Z",
  • "status": "authorized",
  • "transaction_type": "purchase",
  • "client": {
    },
  • "entity": {
    },
  • "card": {
    },
  • "digital_card": {
    },
  • "cardholder": {
    },
  • "amounts": {
    },
  • "merchant": {
    },
  • "reference_transaction": {
    },
  • "messages": [
    ],
  • "_links": {
    }
}
➔ Next to Issuing disputes