Checkout
Get a checkout session
Read back a checkout session. The hosted checkout page calls this to render the amount, merchant branding and available payment methods; you can also call it to check where a session got to.
Authorization
bearerAuth AuthorizationBearer <token>
The access_token returned by POST /api/v1/get-token.
In: header
Path Parameters
checkoutSessionId*string
The public checkout session ID returned when the session was created.
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/sandbox/v1/checkout-sessions/cf488410-37d5-4dba-9b27-8d74f3ad8ae4"{ "id": "cf488410-37d5-4dba-9b27-8d74f3ad8ae4", "amount": 1500, "currency": "KES", "description": "Payment for order #12345", "customerEmail": "customer@example.com", "customerMsisdn": "+254712345678", "externalRef": "ORDER-12345-EXT", "paymentMethods": [ "CARD", "MPESA_STK" ], "merchantDisplayName": "Example Store", "merchantLogoUrl": "https://cdn.example.com/logo.png", "status": "PENDING"}