Get payment details
Beta

Last updated: March 25, 2026

You can retrieve information about a sub-entity's payin or payout using one of the following:

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.

Call the Get payment details endpoint, and provide the payment ID or session ID as the {id} path parameter.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

get

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


1{
2  "id": "pay_mbabizu24mvu3mela5njyhpit4",
3  "requested_on": "2019-08-24T14:15:22Z",
4  "source": {
5    "type": "card",
6    "id": "src_nwd3m4in3hkuddfpjsaevunhdy",
7    "billing_address": {
8      "address_line1": "123 High St.",
9      "address_line2": "Flat 456",
10      "city": "London",
11      "state": "str",
12      "zip": "SW1A 1AA",
13      "country": "GB"
14    },
15    "phone": {
16      "country_code": "+44",
17      "number": "1234 567890"
18    },
19    "expiry_month": 6,
20    "expiry_year": 2025,
21    "name": "Toby Arden",
22    "scheme": "VISA",
23    "scheme_local": "Cartes_Bancaires",
24    "local_schemes": [
25      "cartes_bancaires",
26      "visa"
27    ],
28    "last4": "9996",
29    "fingerprint": "F639CAB2745BEE4140BF86DF6B6D6",
30    "bin": "45434748",
31    "card_type": "CREDIT",
32    "card_category": "CONSUMER",
33    "card_wallet_type": "applepay",
34    "issuer": "Test Bank",
35    "issuer_country": "UK",
36    "product_id": "F",
37    "product_type": "CLASSIC",
38    "avs_check": "S",
39    "cvv_check": "Y",
40    "payment_account_reference": "EUNIX9AX7THOOJIEJ2AP6OOFAHGH4",
41    "encrypted_card_number": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz...",
42    "account_update_status": "card_updated",
43    "account_update_failure_code": "VAU009",
44    "account_holder": {
45      "type": "individual"
46    }
47  },
48  "destination": {
49    "type": "bank_account",
50    "id": "string"
51  },
52  "amount": 6540,
53  "amount_requested": 6540,
54  "currency": "USD",
55  "payment_type": "Recurring",
56  "payment_plan": {
57    "amount_variability": "Variable",
58    "days_between_payments": 28,
59    "total_number_of_payments": 5,
60    "current_payment_number": 3,
61    "expiry": "20251031"
62  },
63  "reference": "ORD-5023-4E89",
64  "description": "Set of 3 masks",
65  "approved": true,
66  "expires_on": "string",
67  "status": "Authorized",
68  "balances": {
69    "total_authorized": 6540,
70    "total_voided": 0,
71    "available_to_void": 6540,
72    "total_captured": 0,
73    "available_to_capture": 6540,
74    "total_refunded": 0,
75    "available_to_refund": 0
76  },
77  "3ds": {
78    "downgraded": false,
79    "enrolled": "Y",
80    "signature_valid": "Y",
81    "authentication_response": "Y",
82    "authentication_status_reason": "string",
83    "cryptogram": "hv8mUFzPzRZoCAAAAAEQBDMAAAA=",
84    "xid": "MDAwMDAwMDAwMDAwMDAwMzIyNzY=",
85    "eci": "string",
86    "version": "2.1.0",
87    "exemption": "low_value",
88    "exemption_applied": "string",
89    "challenged": true,
90    "upgrade_reason": "sca_retry",
91    "trusted_listing": {
92      "status": "Y",
93      "source": "01"
94    }
95  },
96  "authentication": {
97    "experience": "3ds"
98  },
99  "risk": {
100    "flagged": true,
101    "score": 22
102  },
103  "customer": {
104    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
105    "email": "toby.arden@example.com",
106    "name": "Toby Arden",
107    "summary": {
108      "registration_date": "2023-05-01",
109      "first_transaction_date": "2023-07-01",
110      "last_payment_date": "2023-08-01",
111      "total_order_count": 15,
112      "last_payment_amount": 500,
113      "is_premium_customer": true,
114      "is_returning_customer": true,
115      "lifetime_value": 500
116    }
117  },
118  "billing_descriptor": {
119    "name": "Test payment",
120    "city": "London",
121    "reference": "string",
122    "local_descriptors": [
123      {
124        "name": "漢字",
125        "character_set": "kanji"
126      }
127    ]
128  },
129  "shipping": {
130    "address": {
131      "address_line1": "123 High St.",
132      "address_line2": "Flat 456",
133      "city": "London",
134      "state": "str",
135      "zip": "SW1A 1AA",
136      "country": "GB"
137    },
138    "phone": {
139      "country_code": "+1",
140      "number": "415 555 2671"
141    }
142  },
143  "payment_ip": "90.197.169.245",
144  "sender": {
145    "type": "instrument",
146    "reference": "8285282045818"
147  },
148  "amount_allocations": [
149    {
150      "id": "ent_w4jelhppmfiufdnatam37wrfc4",
151      "amount": 1000,
152      "reference": "ORD-5023-4E89",
153      "commission": {
154        "amount": 1000,
155        "percentage": 1.125
156      }
157    }
158  ],
159  "recipient": {
160    "dob": "1985-05-15",
161    "account_number": "5555554444",
162    "address": {
163      "address_line1": "123 High St.",
164      "address_line2": "Flat 456",
165      "city": "London",
166      "state": "str",
167      "zip": "SW1A 1AA",
168      "country": "GB"
169    },
170    "zip": "SW1A",
171    "first_name": "John",
172    "last_name": "Jones"
173  },
174  "processing": {
175    "preferred_scheme": "cartes_bancaires",
176    "app_id": "com.iap.linker_portal",
177    "airline_data": [
178      {
179        "ticket": {
180          "number": "045-21351455613",
181          "issue_date": "2023-05-20",
182          "issuing_carrier_code": "AI",
183          "travel_package_indicator": "B",
184          "travel_agency_name": "World Tours",
185          "travel_agency_code": "01"
186        },
187        "passenger": [
188          {
189            "first_name": "John",
190            "last_name": "White",
191            "date_of_birth": "1990-05-26",
192            "address": {
193              "country": "US"
194            }
195          }
196        ],
197        "flight_leg_details": [
198          {
199            "flight_number": "101",
200            "carrier_code": "BA",
201            "class_of_travelling": "J",
202            "departure_airport": "LHR",
203            "departure_date": "2023-06-19",
204            "departure_time": "15:30",
205            "arrival_airport": "LAX",
206            "stop_over_code": "x",
207            "fare_basis_code": "SPRSVR"
208          }
209        ]
210      }
211    ],
212    "accommodation_data": [
213      {
214        "name": "The Sea View Hotel",
215        "booking_reference": "HOTEL123",
216        "check_in_date": "2023-06-20",
217        "check_out_date": "2023-06-23",
218        "address": {
219          "address_line1": "123 Beach Road",
220          "zip": "10001"
221        },
222        "state": "FL",
223        "country": "USA",
224        "city": "Los Angeles",
225        "number_of_rooms": 2,
226        "guests": [
227          {
228            "first_name": "Jane",
229            "last_name": "Doe",
230            "date_of_birth": "1985-07-14"
231          }
232        ],
233        "room": [
234          {
235            "rate": "70",
236            "number_of_nights_at_room_rate": "3"
237          }
238        ]
239      }
240    ],
241    "partner_customer_id": "2102209000001106125F8",
242    "partner_payment_id": "440644309099499894406",
243    "tax_amount": 1000,
244    "locale": "en-US",
245    "retrieval_reference_number": "909913440644",
246    "partner_order_id": "string",
247    "partner_status": "string",
248    "partner_transaction_id": "string",
249    "partner_error_codes": [
250      "string"
251    ],
252    "partner_merchant_advice_code": "24",
253    "partner_error_message": "string",
254    "partner_authorization_code": "string",
255    "partner_authorization_response_code": "string",
256    "partner_fraud_status": "string",
257    "pan_type_processed": "fpan",
258    "custom_payment_method_ids": [
259      "string"
260    ],
261    "aft": true,
262    "merchant_category_code": "5311",
263    "scheme_merchant_id": "123456"
264  },
265  "items": [
266    {
267      "type": "digital",
268      "sub_type": "stablecoin",
269      "name": "Necklace",
270      "quantity": 2,
271      "unit_price": 50,
272      "reference": "858818ac",
273      "commodity_code": "DEF123",
274      "unit_of_measure": "metres",
275      "total_amount": 29000,
276      "tax_rate": 2000,
277      "tax_amount": 1000,
278      "tax_exempt": true,
279      "discount_amount": 1000,
280      "wxpay_goods_id": "1001",
281      "url": "string",
282      "image_url": "string",
283      "service_ends_on": "2025-01-01",
284      "purchase_country": "GB",
285      "foreign_retailer_amount": 200
286    }
287  ],
288  "metadata": {
289    "coupon_code": "NY2018",
290    "partner_id": 123989
291  },
292  "eci": "06",
293  "scheme_id": "488341541494658",
294  "actions": [
295    {
296      "id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
297      "type": "Authorization",
298      "response_code": "10000",
299      "response_summary": "Approved"
300    }
301  ],
302  "retry": {
303    "attempts_made": 0,
304    "max_attempts": 6,
305    "ends_on": "2019-08-24T14:15:22Z",
306    "next_attempt_on": "2019-08-24T14:15:22Z"
307  },
308  "cko_network_token_available": false,
309  "instruction": {
310    "purpose": "financial_services"
311  },
312  "_links": {
313    "self": {
314      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
315    },
316    "actions": {
317      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"
318    },
319    "authorize": {
320      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/authorizations"
321    },
322    "refund": {
323      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/refund"
324    }
325  }
326}


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

Note

Information

Response example