Operations

getQrCode

Request a QR Code to display to allow the initiation of a payment.

POST /qrCodes

Requests a QR code to be generated for display to a customer allowing a scan and payment to be effected.` in cases where a scan is not possible.

Security

httpBasic

Request

Content-type: application/json

Parameters

NameLocated inRequiredDescriptionSchema
bodybodyYesA get QR code requestGetQrCodeRequest

Response

Content-type: application/json

Status CodeReasonResponse Model
200SuccessGetQrCodeResponse
400Bad requestErrorDetail
500Internal Server ErrorErrorDetail
501Not implementedErrorDetail
503Service UnavailableErrorDetail
504Gateway TimeoutErrorDetail

paymentRequest

Tender via QR code.

POST /payments

A request to tender via QR code has been made by a customer and subsequently a QR code was issued and displayed by the merchant. This operation requests a payment be authorised by the partner and linked to said QR code. This call should be made only after the QR code has been successfully displayed to the customer.

Security

httpBasic

Request

Content-type: application/json

Parameters

NameLocated inRequiredDescriptionSchema
bodybodyYesA payment requestPaymentRequest

Response

Content-type: application/json

Status CodeReasonResponse Model
200SuccessPaymentResponse
400Bad requestErrorDetail
500Internal Server ErrorErrorDetail
501Not implementedErrorDetail
503Service UnavailableErrorDetail
504Gateway TimeoutErrorDetail

Confirm completion of tender initiated by a payment request.

POST /payments/{paymentId}/confirmations/{adviceId}

Confirm that the payment previously authorised has now been completed by the merchant and the customer has their goods.

Security

httpBasic

Request

Content-type: application/json

Parameters

NameLocated inRequiredDescriptionSchema
adviceIdpathYesThe randomly generated UUID of this requeststring
paymentIdpathYesThe UUID generated for the original paymentRequest requeststring
bodybodyYesA payment confirmationConfirmationAdvice

Response

Content-type: application/json

Status CodeReasonResponse Model
202AcceptedAdviceResponse
400Bad requestErrorDetail
500Internal Server ErrorErrorDetail
503Service UnavailableErrorDetail
504Gateway TimeoutErrorDetail

reversePayment

Reverse a payment request that failed or timed out

POST /payments/{paymentId}/reversals/{adviceId}

Reverse a previous payment previously authorised. This tender was not used by the merchant and the funds reserved should be released.

Security

httpBasic

Request

Content-type: application/json

Parameters

NameLocated inRequiredDescriptionSchema
adviceIdpathYesThe randomly generated UUID of this requeststring
paymentIdpathYesThe UUID generated for the original paymentRequest requeststring
bodybodyYesA payment reversalReversalAdvice

Response

Content-type: application/json

Status CodeReasonResponse Model
202AcceptedAdviceResponse
400Bad requestErrorDetail
500Internal Server ErrorErrorDetail
503Service UnavailableErrorDetail
504Gateway TimeoutErrorDetail