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.

The request

Use the details below to set up your request.

Endpoints

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

Header and path parameters

HeaderValue

Authorization

REQUIRED

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub

Content-Type

REQUIRED

application/json
PathValue

id

REQUIRED

The payment ID (prefixed with pay_) or the session ID (prefixed with sid_).

The response

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

{
  "id": "pay_jkpegpvbjviu5pu6xkewah5r6y",
  "requested_on": "2019-01-28T11:12:54Z",
  "source": {
    "id": "src_v2fgh6u6ijmehgmu5efkbgw4d4",
    "type": "card",
    "expiry_month": 8,
    "expiry_year": 2025,
    "scheme": "Dinersclub",
    "last4": "9019",
    "fingerprint": "792A3B9CCCEE7E940E41CC40E92D08E1DE48BAD0F61BAFAF3809C93270241F83",
    "bin": "301234",
    "card_type": "Credit",
    "card_category": "Commercial",
    "issuer": "US Bank",
    "issuer_country": "US",
    "product_id": "L",
    "product_type": "Commercial Credit",
    "avs_check": "S",
    "cvv_check": ""
  },
  "amount": 6500,
  "currency": "USD",
  "payment_type": "Regular",
  "reference": "ORD-5023-4E89",
  "status": "Captured",
  "approved": true,
  "risk": {
    "flagged": false
  },
  "customer": {
    "id": "cus_ebxdsbvjgxcuxpkluxpwwychka"
  },
  "billing_descriptor": {
    "name": "Fiona's Fashion",
    "city": "New York"
  },
  "eci": "05",
  "scheme_id": "638284745624527",
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_jkpegpvbjviu5pu6xkewah5r6y"
    },
    "actions": {
      "href": "https://api.sandbox.checkout.com/payments/pay_jkpegpvbjviu5pu6xkewah5r6y/actions"
    },
    "refund": {
      "href": "https://api.sandbox.checkout.com/payments/pay_jkpegpvbjviu5pu6xkewah5r6y/refunds"
    }
  }
}

If unsuccessful, you may get a 404 – Payment not found error.

Response parameters

Find out what the different fields in your successful response mean.

Field nameDescription

id

STRING

The unique identifier of the payment action.

requested_on

STRING

The date and time the payment was requested.

source

OBJECT

Details about the payment source.

source.type

STRING

The payment source type.

For any payment request sources that result in a card token (for example, token) this is set to card, otherwise it displays the name of the alternative payment method.

amount

INTEGER

The original payment amount.

currency

STRING

The three-letter ISO currency code of the payment.

payment_type

STRING

Specified for card payments where the cardholder is not present (recurring or Merchant Offline Telephone Order).

Default: "Regular". Other values: "Recurring""MOTO"

reference

STRING

The payment reference, like an order number.

status

STRING

The status of the payment, which can be:

  • Pending
  • Authorized
  • Card Verified
  • Voided
  • Partially Captured
  • Captured
  • Partially Refunded
  • Refunded
  • Declined
  • Canceled
  • Paid

approved

BOOLEAN

Whether the authorization or capture was successful.

risk

OBJECT

Returns the payment's risk assessment results.

risk.flagged

STRING

Whether the payment was flagged by a risk check.

customer

OBJECT

Details about the customer.

billing_descriptor

OBJECT

Details about the dynamic billing descriptor displayed on the cardholder's statement.

eci

STRING

The final Electronic Commerce Indicator (ECI) security level used to authorize the payment. Applicable for 3D Secure, digital wallet, and network token payments.

scheme_id

STRING

The scheme transaction identifier.

actions

ARRAY

A summary of actions related to the payment.

Only returned if you used the session ID in the request.

_links

OBJECT

The links related to the payment.

Can we help?

Thanks for using Checkout.com. If you need help or have a question, message our Support team at support@checkout.com.