Skip to main content
POST
payments.order.create

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
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}$
expiresAt
string<date-time>

Optional order expiry where supported.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
receipt
string

Your own unique receipt or reference.

Required string length: 1 - 128
notes
object

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

allowPartial
boolean

Accept partial payments, when supported.

minimumFirstPayment
integer

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

Required range: 1 <= x <= 99999999

Response

The result

orderId
string
required

Order id in your connected merchant account.

status
enum<string>
required

Order state; a refund does not necessarily change a paid order.

Available options:
created,
attempted,
paid,
canceled,
unknown
amount
object
required

Order total in minor units.

amountPaid
object

Amount already paid.

amountDue
object

Amount still due.

receipt
string

Your own receipt or reference.

attempts
integer

Number of payment attempts.

Required range: 0 <= x <= 9007199254740991
notes
object

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

createdAt
string

When the order was created, ISO 8601.