Skip to main content
POST
payments.qr-code.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
type
enum<string>
default:instant_transfer

Payment methods accepted by the QR code.

Available options:
instant_transfer,
all_methods
usage
enum<string>
default:multiple

One payment or multiple payments.

Available options:
single,
multiple
fixedAmount
boolean
default:false

Accept only the specified amount.

amount
integer

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

Required range: 1 <= x <= 99999999
currency
string
default:INR

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

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

Your label for this code.

Required string length: 1 - 200
description
string

What the payment is for.

Required string length: 1 - 2048
customerId
string

Customer id in your connected merchant account.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
closesAt
string<date-time>

Date and time in ISO 8601 with a timezone.

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)))$
taxInvoice
object

Optional tax invoice details, including customer name; available only where supported.

notes
object

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

Response

The result

qrCodeId
string
required

QR code id in your connected merchant account.

status
enum<string>
required

Current QR code state.

Available options:
active,
closed,
unknown
type
enum<string>
required

Payment methods the QR code accepts.

Available options:
instant_transfer,
all_methods,
unknown
usage
enum<string>
required

Whether one or multiple payments are accepted.

Available options:
single,
multiple,
unknown
fixedAmount
boolean
required

Whether only a fixed amount is accepted.

amount
object

Fixed payment amount, when set.

amountReceived
object

Total captured amount.

paymentsReceived
integer

Number of captured payments.

Required range: 0 <= x <= 9007199254740991
name
string

Your label for the QR code.

description
string

What the payment is for.

customerId
string

Related customer id.

file
object

QR image copied to platform storage.

notes
object

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

closesAt
string

Actual scheduled closing time, ISO 8601.

closedAt
string

When the code was closed, ISO 8601.

createdAt
string

When the code was created, ISO 8601.