Skip to main content
POST
payments.order.confirm

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
orderId
string
required

Order in your connected account.

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

The buyer payment source.

returnUrl
string
required

Where the buyer returns after approval; approval alone is not a capture. Accepts a public URL, or http on localhost for a local install.

cancelUrl
string
required

Where the buyer returns when cancelling approval. Accepts a public URL, or http on localhost for a local install.

Response

The result

status
enum<string>
required

Order state. Approval is separate from collection.

Available options:
created,
approval_required,
approved,
completed,
pending,
cancelled
actionUrl
string

Temporary platform link for buyer approval, when needed.