CollectionsHosted PaymentsPayment QR Codes

Create a payment QR code

POST
/v1/payment-qr-code

Authorization

authorization
AuthorizationBearer <token>

Set Your Secret API Key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Payment QR code network.

amount*number

Amount to collect, specified in the currency's minor units (e.g. in MYR, specify 1250 for MYR 12.50).

Range1 <= value <= 20000000
currency*string

Three-letter ISO 4217 currency code in full uppercase.

expirySeconds?integer

The QR code will be valid for this duration, after which payment QR code scanning applications will reject it.

Formatint32
internalAccountId*string

ID of the Internal Account to be linked to the payment QR code as the payment recipient. Use List Internal Accounts to find the ID of the account that should receive payments.

Length1 <= length
transactionReference*string

An identifier for this payment, typically unique. The same value will appear in the corresponding transaction notification and bank statement entry, allowing you to reconcile with this payment.

Length0 <= length <= 25

Response Body

*/*

curl -X POST "https://example.com/v1/payment-qr-code" \  -H "Content-Type: application/json" \  -d '{    "type": "string"  }'
{  "amount": 0,  "amountEditable": true,  "currency": "string",  "expirySeconds": 0,  "proxyType": "string",  "proxyValue": "string",  "qrCodeImageUrl": "string",  "transactionReference": "string",  "type": "string"}