Guides
API Reference

Our reference library for integrating with our API

FAQ

Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

Get payment details

This endpoint enables you to fetch and view relevant information and parameters related to a specific payment. Before you start, make sure you have the payment ID or session ID of the payment in question.

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

The cko-session-id expires 15 minutes after being created.


Use the details below to set up your request.

Endpoints

For the full API specification, see the API reference.

GEThttps://api.checkout.com/payments/{id}
GEThttps://api.sandbox.checkout.com/payments/{id}

Response example

If your request is successful, the response will return information about the payment.

{
  "id": "pay_mbabizu24mvu3mela5njyhpit4",
  "requested_on": "2021-01-21T09:20:51Z",
  "source": {
    "type": "card",
    "id": "src_nwd3m4in3hkuddfpjsaevunhdy",
    "billing_address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "destination": {
    "type": "card",
    "id": "src_wmlfc3zyhqzehihu7giusaaawu",
    "billing_address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "amount": 6540,
  "currency": "USD",
  "payment_type": "Recurring",
  "reference": "ORD-5023-4E89",
  "description": "Set of 3 masks",
  "approved": true,
  "status": "Authorized",
  "3ds": {
    "downgraded": false,
    "enrolled": "Y",
    "signature_valid": "Y",
    "authentication_response": "Y",
    "cryptogram": "hv8mUFzPzRZoCAAAAAEQBDMAAAA=",
    "xid": "MDAwMDAwMDAwMDAwMDAwMzIyNzY=",
    "version": "2.1.0"
  },
  "risk": {
    "flagged": true
  },
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44"
  },
  "billing_descriptor": {
    "name": "SUPERHEROES.COM",
    "city": "GOTHAM"
  },
  "shipping": {
    "address": {
      "address_line1": "Checkout.com",
      "address_line2": "90 Tottenham Court Road",
      "city": "London",
      "state": "London",
      "zip": "W1T 4TJ",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "4155552671"
    }
  },
  "payment_ip": "90.197.169.245",
  "recipient": {
    "dob": "1985-05-15",
    "account_number": "5555554444",
    "zip": "W1T",
    "first_name": "John",
    "last_name": "Jones"
  },
  "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
  },
  "eci": "06",
  "scheme_id": "488341541494658",
  "actions": [
    {
      "id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
      "type": "Authorization",
      "response_code": "10000",
      "response_summary": "Approved"
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
    },
    "actions": {
      "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"
    },
    "refund": {
      "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/refund"
    }
  }
}

If unsuccessful, you may get a 404 โ€“ Payment not found error.