Get payment details
Last updated: June 29, 2022
This endpoint allows you to retrieve and view information and parameters related to a specific payment, using a payment ID or session ID.
The session ID is provided in the cko-session-id
query parameter included in the redirect URL back to your site. Redirect URLs have the following format:
http://example.com/success?cko-session-id=sid_ubfj2q76miwundwlk72vxt2i7
Note
The cko-session-id
expires 15 minutes after being created.
Use the details below to set up your request.
For the full API specification, see the API reference.
get
https://api.checkout.com/payments/{id}
If your request is successful, the response will return information about the payment. If unsuccessful, you may receive a 404 – Payment not found
error instead.
Note that the actions
array is only returned in the response if the request was made using a cko-session-id
value.
1{2"id": "pay_mbabizu24mvu3mela5njyhpit4",3"requested_on": "2021-01-21T09:20:51Z",4"source": {5"type": "card",6"id": "src_nwd3m4in3hkuddfpjsaevunhdy",7"billing_address": {8"address_line1": "Checkout.com",9"address_line2": "90 Tottenham Court Road",10"city": "London",11"state": "London",12"zip": "W1T 4TJ",13"country": "GB"14},15"phone": {16"country_code": "+1",17"number": "4155552671"18}19},20"destination": {21"type": "card",22"id": "src_wmlfc3zyhqzehihu7giusaaawu",23"billing_address": {24"address_line1": "Checkout.com",25"address_line2": "90 Tottenham Court Road",26"city": "London",27"state": "London",28"zip": "W1T 4TJ",29"country": "GB"30},31"phone": {32"country_code": "+1",33"number": "4155552671"34}35},36"amount": 6540,37"currency": "USD",38"payment_type": "Recurring",39"reference": "ORD-5023-4E89",40"description": "Set of 3 masks",41"approved": true,42"status": "Authorized",43"3ds": {44"downgraded": false,45"enrolled": "Y",46"signature_valid": "Y",47"authentication_response": "Y",48"cryptogram": "hv8mUFzPzRZoCAAAAAEQBDMAAAA=",49"xid": "MDAwMDAwMDAwMDAwMDAwMzIyNzY=",50"version": "2.1.0"51},52"risk": {53"flagged": true54},55"customer": {56"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44"57},58"billing_descriptor": {59"name": "SUPERHEROES.COM",60"city": "GOTHAM"61},62"shipping": {63"address": {64"address_line1": "Checkout.com",65"address_line2": "90 Tottenham Court Road",66"city": "London",67"state": "London",68"zip": "W1T 4TJ",69"country": "GB"70},71"phone": {72"country_code": "+1",73"number": "4155552671"74}75},76"payment_ip": "90.197.169.245",77"recipient": {78"dob": "1985-05-15",79"account_number": "5555554444",80"zip": "W1T",81"first_name": "John",82"last_name": "Jones"83},84"metadata": {85"coupon_code": "NY2018",86"partner_id": 12398987},88"eci": "06",89"scheme_id": "488341541494658",90"actions": [91{92"id": "act_y3oqhf46pyzuxjbcn2giaqnb44",93"type": "Authorization",94"response_code": "10000",95"response_summary": "Approved"96}97],98"_links": {99"self": {100"href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"101},102"actions": {103"href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"104},105"refund": {106"href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/refund"107}108}109}