Get payment details

Last updated: March 27, 2024

You can retrieve information about a payment or payout using a:

Payment ID – Returned in the response to your payment or payout request
Session ID – Provided in the cko-session-id query parameter included in the redirect URL back to your site – for example, http://example.com/success?cko-session-id=sid_ubfj2q76miwundwlk72vxt2i7

Note

The cko-session-id expires 15 minutes after creation.

You can also retrieve a list of payments that match a specific payment reference.

For the full API specification, refer to the API reference.

get

https://api.checkout.com/payments/{id}

The response will contain information about the payment or payout that matches the ID you provided. If you performed the request with a cko-session-id, the response will include an additional actions object in the response.

Note

If a payment matching the ID you provided was not found, you'll receive a 404 – Payment not found error.


1{
2  "id": "pay_f2ws3hn4ijquzbytp3v5lsfxge",
3  "requested_on": "2022-04-21T13:39:44.3167397Z",
4  "source": {
5    "id": "src_3yk7vgcu4yxedktczvd6dnialy",
6    "type": "card",
7    "expiry_month": 1,
8    "expiry_year": 2099,
9    "name": "John Smith",
10    "scheme": "Visa",
11    "last4": "4242",
12    "fingerprint": "2BBAB84F3374A8E6D73A7375D5E3F1D3A10502EDDE4B9F515DE8878561566423",
13    "bin": "424242",
14    "card_type": "CREDIT",
15    "card_category": "CONSUMER",
16    "issuer_country": "GB",
17    "product_id": "F",
18    "product_type": "Visa Classic",
19    "avs_check": "N",
20    "cvv_check": "Y",
21    "payment_account_reference": "V001428640638148739",
22    "billing_address": {
23      "address_line1": "123 High St.",
24      "address_line2": "Flat 456",
25      "city": "London",
26      "zip": "SW1A 1AA",
27      "country": "GB"
28    },
29    "phone": {
30      "country_code": "+44",
31      "number": "1234 567890"
32    }
33  },
34  "expires_on": "2022-05-21T13:40:25.1077817Z",
35  "amount": 2000,
36  "currency": "USD",
37  "payment_type": "Regular",
38  "status": "Captured",
39  "approved": true,
40  "3ds": {
41    "downgraded": false,
42    "enrolled": "Y",
43    "authentication_response": "Y",
44    "cryptogram": "AgAAAAAAAIR8CQrXcIhbQAAAAAA=",
45    "xid": "ad368121-0244-4536-9dab-250857df3d2b",
46    "version": "2.1.0",
47    "challenged": true
48  },
49  "balances": {
50    "total_authorized": 2000,
51    "total_voided": 0,
52    "available_to_void": 0,
53    "total_captured": 2000,
54    "available_to_capture": 0,
55    "total_refunded": 0,
56    "available_to_refund": 2000
57  },
58  "risk": {
59    "flagged": false
60  },
61  "eci": "05",
62  "scheme_id": "290750527988470",
63  "_links": {
64    "self": {
65      "href": "https://api.sandbox.checkout.com/payments/pay_f2ws3hn4ijquzbytp3v5lsfxge"
66    },
67    "actions": {
68      "href": "https://api.sandbox.checkout.com/payments/pay_f2ws3hn4ijquzbytp3v5lsfxge/actions"
69    },
70    "refund": {
71      "href": "https://api.sandbox.checkout.com/payments/pay_f2ws3hn4ijquzbytp3v5lsfxge/refunds"
72    }
73  }
74}


1{
2  "id": "pay_gwlowf7eap7uzm4cyaaqoq62au",
3  "requested_on": "2024-06-12T13:49:19.085546Z",
4  "source": {
5    "id": "ca_y3oqhf46pyzuxjbcn2giaqnb44",
6    "type": "currency_account"
7  },
8  "destination": {
9    "id": "src_4pakgjwmv5re5m5ivqohsqpxnm",
10    "type": "bank_account"
11  },
12  "amount": 1000,
13  "currency": "GBP",
14  "reference": "PO-215-5721",
15  "billing_descriptor": {
16    "reference": "Withdrawal"
17  },
18  "status": "Returned",
19  "approved": true,
20  "sender": {
21    "type": "instrument",
22    "reference": "8285282045818"
23  },
24  "instruction": {
25    "value_date": "2024-06-13T01:49:19.1864428Z",
26    "purpose": "Wallet withdrawal"
27  },
28  "_links": {
29    "self": {
30      "href": "https://api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au"
31    },
32    "actions": {
33      "href": "https://api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au/actions"
34    }
35  }
36}

Note

Note

Response example