Skip to main content
POST
payments.qr-code.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

qrCodeId in your connected merchant account.

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

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.