Skip to main content
POST
payments.payment.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
paymentId
string
required

Payment id in your connected merchant account.

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

Whole number in the currency's smallest unit, 1 to 99999999.

Required range: 1 <= x <= 99999999
currency
string
required

Three-letter currency code, such as INR or USD.

Required string length: 1 - 3
Pattern: ^[A-Za-z]{3}$

Response

The result

paymentId
string
required

Payment id in your connected merchant account.

status
enum<string>
required

Confirmed payment state.

Available options:
pending,
authorized,
captured,
refunded,
failed,
canceled,
unknown
amount
object
required

Payment total in minor units.

orderId
string

Related order id.

customerId
string

Related customer id.

amountRefunded
object

Amount already refunded.

method
enum<string>

Payment method without instrument or contact details.

Available options:
card,
bank,
wallet,
installment,
instant_transfer,
unknown
description
string

Payment description.

notes
object

Your own reference notes, at most 15 entries of 256 characters each.

createdAt
string

When the payment was created, ISO 8601.