Operations
paymentRequest
Process a payment for a QR code scan.
POST /payments
A merchant has displayed a QR code which was subsequently scanned by your application. A notification of a successful scan has been successfully linked to a payment request from a Merchant and thus a request to authorise said payment is being made.
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 left with the 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 |
scanNotification
Notification of a QR scan.
POST /scanNotifications
Notify the system of the scan by your application of a QR code. Information in this notification will be used to subsequently submit a payment to you for authorisation.
Security
httpBasic
Request
Content-type: application/json
Parameters
| Name | Located in | Required | Description | Schema |
|---|---|---|---|---|
| body | body | Yes | Notification that a customer has scanned a QR code to effect tender. | ScanNotification |
Response
Content-type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Success | |
| 400 | Bad request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 501 | Not implemented | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |