Operations
pay
Requests a payment to be processed via a QR Partner.
POST /payments
This request contains conventional payment information (POS information, transaction amount, date etc.) as well as Partner information. If a merchant is unable to supply the Partner information in this request, then the request is directed to an intermediate system which also receives notifications from Partners of QR scans. This intermediate system will match the payment request from the merchant with the scan notification from the Partner using the QR code information common to both messages. The payment request may then be forwarded to the correct Partner for processing.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | A QR payment request. | PaymentRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | PaymentResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
confirmPayment
Confirms completion of tender initiated by a payment request.
POST /payments/confirmations
This operation confirms that a QR payment transaction has completed successfully between the consumer and the merchant. Such a transaction may be settled between the merchant and the Partner that processed the payment. Such a transaction cannot be reversed.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | A QR payment confirmation. | PaymentConfirmation |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | PaymentConfirmation |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
reversePayment
Reverses a payment request that failed or timed out
POST /payments/reversals
This operation indicates that the sale did not complete and the payment should be reversed if it took place. Once a payment is reversed it cannot be confirmed and need not be settled between the merchant and the QR Partner.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | A QR payment reversal. | PaymentReversal |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | PaymentReversal |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
createQrCode
Requests a QR Code to display to a customer to be scanned.
POST /qrCodes
The customer may scan this code with a Partner's application and thereby allow the Partner to identify the QR code provider.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | Information pertaining to the QR code, which may be available at the time of the request. This may include details such as the entity requesting the QR code, the value of the transaction for which the QR code will be used and the specific purpose of the QR code. The request for a QR code should convey information about the merchant requesting the QR code (e.g. POS information) and not information about the consumer who will scan the QR code (e.g. customer or loyalty information). | CreateQrCodeRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | CreateQrCodeResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
notifyScan
Notify that a QR code has been scanned.
POST /scans
Partners are not notified by a QR code provider when a QR code is generated. Only when a consumer scans a QR code using a Partner's application is the Partner aware that the QR code is available. The Partner subsequently informs the provider of the QR code that their code has been scanned. The QR code provider shall then associate any other transactions pertaining to the QR code with the Partner.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | A get QR code request. | ScanNotification |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |