Create or link a QR code to the wallet

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/qr-codes

Creates a new QR code if no code is supplied. If a code is supplied, links the existing code to the wallet (or, if merchantId and useReservedQrCode are set, links a reserved QR code for that merchant).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

walletId

int64

required

Body Params

A Quick Response code which when paid would credit the wallet to which it is linked. QRCodes can be long-lived permanent codes or short-lived once off for a specific purchase and amount and when paid can be matched to that purchase.

additionalFields

array of objects

Additional fields required when paying the QRCode

additionalFields

additionalMerchantData

object

amount

number

≥ 0

Optional amount the QRCode is for. If not provided then the payer would enter the amount upon payment. Amount is in major currency unit

code

string

If linking an existing unlinked QRCode to the wallet then provide the QRCode and no other fields. For creating a new QRCode dont pass this field

configuration

array of objects

loosely typed configuration for specific QR code generation functionality. Typically used in EMVCo to indicate destination rails desired

configuration

description

string

length between 0 and 100

Description to appear as the merchant when someone scans the QRCode

expires

date-time

Optional ISO 8601 date/time of when the code expires. If not provided then the code will never expire

maxAmount

number

This field specifies the maximum amount of payment if partial payment is allowed

merchantId

int64

The merchantId on which you want to link existing qrcode. only valid if useReservedQrCode is true

merchantName

string

length between 0 and 100

Name to appear as the merchant when someone scans the QRCode. Only applicable to ZA_MASTERPASS. Ignored for GLOBAL_EMVCO

minAmount

number

This field specifies the minimum amount of payment if partial payment is allowed

note

string

length between 0 and 200

Some note to attach to the QRCode

reference

string

length between 5 and 20

save

boolean

whether or not to store the qr code against the wallet (if omitted assumed false unless for Masterpass)

type

string

enum

The type of QRCode to create

Allowed:

useReservedQrCode

boolean

If true then will link the qrcode with provided merchant. Only used if merchantId is provided

Responses

400

Bad Request

200OK

500Internal Server Error