SessionsGet checkout session

Get checkout session

Returns checkout session status and details.

curl -X GET "https://api.example.com/api/v1/sessions/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)"
{
  "id": "e4b8c1a2-1234-5678-abcd-ef1234567890",
  "orderReference": "ORD-12345",
  "status": "PENDING",
  "failureReason": "EXPIRED",
  "providerName": "stripe",
  "paymentMethod": "card",
  "expiresAt": "2024-01-15T12:00:00.000Z",
  "createdAt": "2024-01-15T11:00:00.000Z",
  "updatedAt": "2024-01-15T11:30:00.000Z",
  "refunds": [
    {
      "id": "3d72f30c-2977-44bf-b2e8-ff09b9b3216d",
      "amount": 45.01,
      "currency": "USD",
      "status": "PENDING",
      "failureReason": "LOST_OR_STOLEN_CARD",
      "reason": "REQUESTED_BY_CUSTOMER",
      "createdAt": "2024-01-15T11:00:00.000Z",
      "updatedAt": "2024-01-15T11:30:00.000Z"
    }
  ]
}
GET
/api/v1/sessions/{sessionId}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

Bearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically

path
sessionIdstring
Required

Checkout session identifier.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). Authentication token required.

Path Parameters

sessionIdstring
Required

Checkout session identifier.

Responses

idstring
Required
orderReferencestring
Required
statusstring
Required
Allowed values:PENDINGSUCCEEDEDFAILED
failureReasonobject
providerNameobject
paymentMethodstring
Required
expiresAtobject
createdAtstring
Required
updatedAtstring
Required
refundsarray

Associated refund records. Populated when the session is in SUCCEEDED, PARTIALLY_REFUNDED, REFUNDED, or REVERSED status. Null otherwise.