Get a list of transactions
<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Returns a list of transactions based on the matching input parameters in reverse chronological order, with the most recent transactions shown first.
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- AuthOAuth 2Client credentialsToken URLstringScopesissuing:transactions-read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The maximum number of transactions returned (between 10-100). The default is 10.
The number of transactions to skip. The default is 0.
The cardholder's unique identifier.
The card's unique identifier.
The entity's unique identifier.
An optional filter for the transaction lifecycle status.
An optional start date filter for transactions, in ISO 8601 format.
An optional end date filter for transactions, in ISO 8601 format.
Response
Transactions returned successfully.
Example response
{
"limit": 5,
"skip": 10,
"total_count": 100,
"data": [
{
"id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga",
"status": "authorized",
"transaction_type": "purchase",
"client": {
"id": "cli_vkuhvk4vjn2edkps7dfsq6emqm"
},
"entity": {
"id": "ent_fa6psq242dcd6fdn5gifcq1491"
},
"card": {
"id": "crd_fa6psq242dcd6fdn5gifcq1491",
"network": "mastercard"
},
"digital_card": {
"id": "dcr_5ngxzsynm2me3oxf73esbhda6q"
},
"cardholder": {
"id": "crh_d3ozhf43pcq2xbldn2g45qnb44"
},
"amounts": {
"total_held": {
"amount": 100,
"currency": "USD"
},
"total_authorized": {
"amount": 100,
"currency": "USD"
},
"total_reversed": {
"amount": 100,
"currency": "USD"
},
"total_cleared": {
"amount": 100,
"currency": "USD"
},
"total_refunded": {
"amount": 100,
"currency": "USD"
}
},
"merchant": {
"id": "(*)123456789",
"name": "My Merchant",
"city": "Paris",
"country_code": "FR",
"category_code": "5331"
},
"reference_transaction": {
"transaction_id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga"
},
"messages": [
{
"id": "msg_fa6psq242dcd6fdn5gifcq1491",
"result": "declined",
"is_relayed": true,
"decline_reason": "expiry_date_invalid",
"authorization_code": "03C0C0",
"billing_amount": 100,
"billing_currency": "USD",
"transaction_amount": 100,
"transaction_currency": "USD",
"created_on": "2019-09-10T10:11:12.0000000+00:00"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.