Get a Session

Returns a session and its current status. Use it to check whether the customer has paid or saved the card.

GET
/checkout/v1/sessions/{id}

Authorization

Authorization
Authorization<token>

Your public API key, with the word Token and a space in front of it. Example: Token 6534bc0a7e1f4d2b9c8e3a5f7b1d2c4e6f8a9b0c — that whole value is the header. Sending the key alone returns 401 'Authentication credentials were not provided'. In this playground you may paste just the key; the prefix is added for you.

In: header

Path Parameters

id*string

The session id returned when the session was created.

Response Body

application/json

application/json

curl -X GET "https://example.com/checkout/v1/sessions/cs_97_41528_42434df6c3644b9610df7b64a1fa9925e3b9562b05972097"
{
  "id": "cs_97_41528_42434df6c3644b9610df7b64a1fa9925e3b9562b05972097",
  "status": "completed",
  "session_type": "payment",
  "payment_id": 41528,
  "payment_flow": "direct",
  "direct_transaction_id": "190e4fd9-6f0a-4a57-9b1e-3c2f1c0d7a11",
  "transaction_status": "Success",
  "amount_total": 150,
  "currency": "MXN",
  "external_id": "ORD-001",
  "paid_at": 1751483767348
}
{
  "code": "E004",
  "message": "The request was invalid. Please check your input and try again.",
  "metadata": {},
  "name": "TNDR004",
  "statusCode": 400
}
Was this page helpful?