Skip to main content
GET
Get session status

GET /payment-sessions/{token}

Read the result of a partner payment session after the callback. This endpoint is public. You do not need an API key or employee token. Each session permits two successful reads shared with the info endpoint. A pending-status read also consumes one. Call this once after the callback; repeated polling can exhaust the result. cardType is coupon, loyalty, status, or points when completed, and null while pending. amount is set only for coupon deductions; points and status operations return null. completedAt is null while pending. The five-minute deadline prevents new session operations and info reads. Status reads do not directly check expiresAt: a stored session can remain readable until MongoDB’s asynchronous TTL cleanup removes it, if reads remain. Missing or exhausted tokens return 410 PAYMENT_SESSION_UNAVAILABLE, not 404. Treat 410 as an unavailable result. It can mean cleanup or exhausted reads and does not by itself prove tampering. Verify status: completed before confirming the operation. Rate limit: 60 requests per minute per IP.

Example request

Example response

Path Parameters

token
string
required

Secret session token.

Response

Success

status
enum<string>
required
Available options:
pending,
completed
expiresAt
string<date-time>
required
completedAt
string<date-time> | null
required
cardType
enum<string> | null
required
Available options:
coupon,
loyalty,
status,
points
amount
integer | null
required

Coupon deduction in cents; null for other types.