Skip to main content
POST
payments.order.capture

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 payment account.

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

Response

The result

status
enum<string>
required

Current payment state; pending does not mean paid.

Available options:
pending,
authorized,
partially_captured,
completed,
cancelled,
failed,
refunded,
partially_refunded
amount
object

Payment amount in minor units.

createdAt
string

Date and time in ISO 8601 UTC.

updatedAt
string

Date and time in ISO 8601 UTC.

expiresAt
string

Date and time in ISO 8601 UTC.

captureId
string

Resulting payment record in your own account.

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