SupportAPI referenceClassic API docs
Guides
Start typing to search…

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

Live

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

Sandbox

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

Header and path parameters

Header

Value

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

Path

Value

id Required

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

The response

A successful request returns 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"
    }
  }
}

Additional error responses:

  • 404 - Payment not found

Response parameters

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

Field name

Description

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.\ For example, 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 security level used to authorize the payment. Applicable for 3-D Secure, digital wallets 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 any help or support, then message our support team at [email protected].

Updated 5 months ago