Skip to main content
POST
payments.checkout.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
checkoutId
string

Checkout ID in your own connected account; needs sessionResult. Send this or ref, not both.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
ref
string

The ref returned by payments.checkout.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
sessionResult
string

Opaque completion token received by your client after checkout; forwarded once and never returned. Required with checkoutId; with ref, only some sources need it.

Required string length: 1 - 20000

Response

The result

status
enum<string>
required

Checkout state. By ref, paid means a captured payment was confirmed and unknown never implies payment; by checkoutId, the snapshot recorded at completion. Completed alone is not proof that money was captured.

Available options:
active,
unpaid,
paid,
cancelled,
completed,
expired,
pending,
refused,
unknown
payments
object[]
required

Payments reported in the checkout completion snapshot; empty when none reported.