Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
j) Wallet QRCodes

Get QR code details by query parameter

get/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/qr-codes

Path parameters

tenantIdinteger required

Query parameters

codestring required

The QR code value to look up.

Response

OK

acceptedCardSchemesstring

Accepted card appear as the merchant's cards marked as accepted

acceptedPaymentMechanismsstring

Accepted payment mechanisms appear as the merchant's accepted payment marked as accepted

amountnumber

Amount in the major currency unit e.g. 50.80 for 50 GBP and 80 pence

billNumberstring

The merchants bill number

codestring required
consumerIdstring

The merchants consumer id

currencystring

The QR currency code

descriptionstring

Description to appear as the merchant when someone scans the QRCode

expiresstring date-time

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

loyaltyNumberstring

The merchants loyalty number

maxAmountnumber

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

merchantCitystring

The merchant city

merchantIdinteger
merchantIdentifierstring

The merchant identifier

merchantNamestring

Name to appear as the merchant when someone scans the QRCode

minAmountnumber

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

notestring

Some note to attached to the QRCode

partialPaymentAllowedboolean
pspIdinteger
referencestring

A reference for the QRCode which will appear in any payment to the QRCode

storeIdstring

The merchants store id

subMerchantIdstring
subMerchantNamestring
terminalIdstring

The merchants terminal id

type'GLOBAL_EMVCO' | 'ZA_MASTERPASS' required

Possible types of QRCode that can be created. ZA_MASTERPASS:for South Africa Masterpass QR

walletIdinteger

The wallet the QRCode is linked to and hence is credited if the code is paid

Example response

{
  "expires": "2022-03-10T12:15:50-04:00"
}