Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
h) Wallets

Create a new QRCode linked to the wallet or link an existing unlinked QRCode to the wallet or link existing reserved qrCode to wallet

Creates a new QRCode if code is not suppled . If code is supplied and merchantId and useReservedQrCode is false then all other fields are ignored and the existing code is looked up and linked to the wallet. Note a code can only be linked to one wallet at a time. Once created/linked it will appear under the wallets mappings. The behaviour of the QRCode depends on the type. Typical behaviour is when a compatible App pays the QRCode, the value will appear in the mapped wallet. If code is supplied and merchantId, useReservedQrCode is true then code will be linked to wallet for supplied merchantId

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

Path parameters

tenantIdinteger required
walletIdinteger required

Request body

amountnumber

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

codestring

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

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

maxAmountnumber

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

merchantIdinteger

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

merchantNamestring

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

minAmountnumber

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

notestring

Some note to attach to the QRCode

referencestring
saveboolean

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

type'GLOBAL_EMVCO' | 'ZA_MASTERPASS'

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

useReservedQrCodeboolean

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

Example request

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

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"
}