Manage Issuing transactions

You can access transactional data about a transaction's lifecycle using the Transactions API, or through webhooks. The API can help you investigate a specific transaction or monitor performance, with granular or aggregated data.

Call the Get a list of transactions endpoint

Use the optional query parameters to:

Limit the number of transactions to return, skip a certain number of transactions, or set a search time frame.
Search for a specific cardholder, card, entity, or transaction status.

get

https://api.checkout.com/issuing/transactions?limit=0&skip=0&cardholder_id=crh_d3ozhf43pcq2xbldn2g45qnb44&card_id=crd_fa6psq242dcd6fdn5gifcq1491&entity_id=ent_fa6psq242dcd6fdn5gifcq1491&status=authorized&from=string&to=string


1{
2  "limit":5,
3  "skip":10,
4  "total_count":100,
5  "data":[
6    {
7      "id":"trx_aayhhfwbdyxwcaeyhhfwbd4xga",
8      "created_on":null,
9      "status":"authorized",
10      "transaction_type":"purchase",
11      "client":{
12        "id":"cli_vkuhvk4vjn2edkps7dfsq6emqm"
13      },
14      "entity":{
15        "id":"ent_fa6psq242dcd6fdn5gifcq1491"
16      },
17      "card":{
18        "id":"crd_fa6psq242dcd6fdn5gifcq1491",
19        "network":"mastercard"
20      },
21      "digital_card":{
22        "id":"dcr_5ngxzsynm2me3oxf73esbhda6q",
23        "wallet_type":"googlepay"
24      },
25      "cardholder":{
26        "id":"crh_d3ozhf43pcq2xbldn2g45qnb44"
27      },
28      "amounts":{
29        "total_held":{
30          "amount":100,
31          "currency":"USD"
32        },
33        "total_authorized":{
34          "amount":100,
35          "currency":"USD"
36        },
37        "total_reversed":{
38          "amount":100,
39          "currency":"USD"
40        },
41        "total_cleared":{
42          "amount":100,
43          "currency":"USD"
44        },
45        "total_refunded":{
46          "amount":100,
47          "currency":"USD"
48        }
49      },
50      "merchant":{
51        "id":"(*)123456789",
52        "name":"My Merchant",
53        "city":"Paris",
54        "state":"",
55        "country_code":"FR",
56        "category_code":5331
57      },
58      "reference_transaction":{
59        "transaction_id":"trx_aayhhfwbdyxwcaeyhhfwbd4xga",
60        "reference_type":"original_mit"
61      },
62      "messages":[
63        {
64          "id":"msg_fa6psq242dcd6fdn5gifcq1491",
65          "initiator":"cardholder",
66          "type":"authorization",
67          "result":"declined",
68          "is_relayed":true,
69          "indicator":"incremental_preauthorization",
70          "decline_reason":"expiry_date_invalid",
71          "authorization_code":"03C0C0",
72          "billing_amount":100,
73          "billing_currency":"USD",
74          "created_on":"2019-09-10T10:11:12Z"
75        }
76      ],
77      "_links":{
78        "self":{
79          "href":"string",
80          "actions":[
81            
82          ],
83          "types":[
84            
85          ]
86        },
87        "card":{
88          "href":"string",
89          "actions":[
90            
91          ],
92          "types":[
93            
94          ]
95        },
96        "cardholder":{
97          "href":"string",
98          "actions":[
99            
100          ],
101          "types":[
102            
103          ]
104        },
105        "reference_transaction":{
106          "href":"string",
107          "actions":[
108            
109          ],
110          "types":[
111            
112          ]
113        }
114      }
115    }
116  ]
117}

Call the Get a single transactions endpoint and provide the {transactionId} path parameter.

get

https://api.checkout.com/issuing/transactions/{transactionId}


1{
2  "id":"trx_aayhhfwbdyxwcaeyhhfwbd4xga",
3  "created_on":null,
4  "status":"authorized",
5  "transaction_type":"purchase",
6  "client":{
7    "id":"cli_vkuhvk4vjn2edkps7dfsq6emqm"
8  },
9  "entity":{
10    "id":"ent_fa6psq242dcd6fdn5gifcq1491"
11  },
12  "card":{
13    "id":"crd_fa6psq242dcd6fdn5gifcq1491",
14    "network":"mastercard"
15  },
16  "digital_card":{
17    "id":"dcr_5ngxzsynm2me3oxf73esbhda6q",
18    "wallet_type":"googlepay"
19  },
20  "cardholder":{
21    "id":"crh_d3ozhf43pcq2xbldn2g45qnb44"
22  },
23  "amounts":{
24    "total_held":{
25      "amount":100,
26      "currency":"USD"
27    },
28    "total_authorized":{
29      "amount":100,
30      "currency":"USD"
31    },
32    "total_reversed":{
33      "amount":100,
34      "currency":"USD"
35    },
36    "total_cleared":{
37      "amount":100,
38      "currency":"USD"
39    },
40    "total_refunded":{
41      "amount":100,
42      "currency":"USD"
43    }
44  },
45  "merchant":{
46    "id":"(*)123456789",
47    "name":"My Merchant",
48    "city":"Paris",
49    "state":"",
50    "country_code":"FR",
51    "category_code":5331
52  },
53  "reference_transaction":{
54    "transaction_id":"trx_aayhhfwbdyxwcaeyhhfwbd4xga",
55    "reference_type":"original_mit"
56  },
57  "messages":[
58    {
59      "id":"msg_fa6psq242dcd6fdn5gifcq1491",
60      "initiator":"cardholder",
61      "type":"authorization",
62      "result":"declined",
63      "is_relayed":true,
64      "indicator":"incremental_preauthorization",
65      "decline_reason":"expiry_date_invalid",
66      "authorization_code":"03C0C0",
67      "billing_amount":100,
68      "billing_currency":"USD",
69      "created_on":"2019-09-10T10:11:12Z"
70    }
71  ],
72  "_links":{
73    "self":{
74      "href":"string",
75      "actions":[
76        
77      ],
78      "types":[
79        
80      ]
81    },
82    "card":{
83      "href":"string",
84      "actions":[
85        
86      ],
87      "types":[
88        
89      ]
90    },
91    "cardholder":{
92      "href":"string",
93      "actions":[
94        
95      ],
96      "types":[
97        
98      ]
99    },
100    "reference_transaction":{
101      "href":"string",
102      "actions":[
103        
104      ],
105      "types":[
106        
107      ]
108    }
109  }
110}

The transaction status field in the response indicates the current phase of the transaction as follows:

Status	Description
`Authorized`	At least one authorization is approved, but there has been no movement of funds. A transaction can remain in this status for some time. For example, until a clearing first presentment is received.
`Declined`	The transaction failed authorization.
`Cleared`	A presentment is received of a given amount.
`Canceled`	The transaction is fully reversed by the merchant or the issuer. If the transaction was authorized and is then partially reversed by the merchant or acquirer, it remains in the authorization phase, and the amount is updated accordingly.
`Refunded`	A full or partial refund cleared and the funds returned to the cardholder’s account for a given amount.
`Disputed`	A chargeback has been submitted for a cleared transaction.

The amounts object provides a detailed breakdown of the transaction amount during different lifecycle phases.

Amount type	Description
`total_held`	The amount Checkout.com holds to cover the transaction, which is not debited from your account. It represents the difference between the total amount authorized, the total amount reversed, and the total amount cleared. This value is useful to understand the current liability on the account pending settlement.
`total_authorized`	The amount authorized for the transaction. It aggregates the billing amounts from all approved authorizations for this transaction. This value is useful to track the total amount approved for spending or withdrawal, offering a clear view of the potential financial commitment.
`total_reversed`	The amount reversed by either the merchant or the issuer. It includes the billing amounts from all approved reversals and issuer-initiated reversals for this transaction. This value is useful to understand the actual amounts that have moved through the transaction process and been settled.
`total_cleared`	The amount cleared by the card scheme, which is the total of the billing amounts of all presentments for this transaction. This value is useful to understand the actual amounts that have moved through the transaction process and been settled.
`total_refunded`	The amount refunded to the cardholder. It includes the billing amounts of all presentments of the type `refund` for this transaction. This value is useful to track the total refunds processed, offering insight into the amount returned to the cardholder after th transaction.

Manage Issuing transactions

Get a list of transactions

Response example

Get a single transaction

Response example

Transaction statuses

Transaction amounts

Related topics

Transaction lifecycle

Configure authorization relay

Manage Issuing disputes

Authenticate cardholders for transactions