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
Name | Located in | Required | Description | Schema |
---|---|---|---|---|
body | body | Yes | A get QR code request | GetQrCodeRequest |
Response
Content-type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Success | GetQrCodeResponse |
400 | Bad request | ErrorDetail |
500 | Internal Server Error | ErrorDetail |
501 | Not implemented | ErrorDetail |
503 | Service Unavailable | ErrorDetail |
504 | Gateway Timeout | ErrorDetail |
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
Name | Located in | Required | Description | Schema |
---|---|---|---|---|
body | body | Yes | A payment request | PaymentRequest |
Response
Content-type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Success | PaymentResponse |
400 | Bad request | ErrorDetail |
500 | Internal Server Error | ErrorDetail |
501 | Not implemented | ErrorDetail |
503 | Service Unavailable | ErrorDetail |
504 | Gateway Timeout | ErrorDetail |
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
Name | Located in | Required | Description | Schema |
---|---|---|---|---|
adviceId | path | Yes | The randomly generated UUID of this request | string |
paymentId | path | Yes | The UUID generated for the original paymentRequest request | string |
body | body | Yes | A payment confirmation | ConfirmationAdvice |
Response
Content-type: application/json
Status Code | Reason | Response Model |
---|---|---|
202 | Accepted | AdviceResponse |
400 | Bad request | ErrorDetail |
500 | Internal Server Error | ErrorDetail |
503 | Service Unavailable | ErrorDetail |
504 | Gateway Timeout | ErrorDetail |
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
Name | Located in | Required | Description | Schema |
---|---|---|---|---|
adviceId | path | Yes | The randomly generated UUID of this request | string |
paymentId | path | Yes | The UUID generated for the original paymentRequest request | string |
body | body | Yes | A payment reversal | ReversalAdvice |
Response
Content-type: application/json
Status Code | Reason | Response Model |
---|---|---|
202 | Accepted | AdviceResponse |
400 | Bad request | ErrorDetail |
500 | Internal Server Error | ErrorDetail |
503 | Service Unavailable | ErrorDetail |
504 | Gateway Timeout | ErrorDetail |