Overview
The POS system enables the processing of digital payments, such as mobile payment, digital wallet services, and other digital payment methods. The Payments API makes it possible to process payments, preauthorizations, refunds, immediate payment reversal, financial advice, and use customized payment providers. It also enables to implement the GUI interactions during the payment process.
Features
The Payments API enables the POS system to:
- initiate an asynchronous payment process (POST/payments/initiatePayment)
- cancel in-progress payment or preauthorization transaction (PUT /payments/{transactionUniqueId}/abort)
- send the asynchronous POS GUI response (POST /payments/{transactionUniqueId}/guiResponse)
- initiate the preauthorization procedure (POST /payments/preauthorization)
- initiate an asynchronous financial advice process (POST /payments/financialAdvice)
- initiate an asynchronous refund process (POST /payments/initiateRefund)
- initiate an immediate payment reversal (POST /payments/initiateReversal)
Payments Webhook API enables the payment system to communicate with the VRx system that initiated the payment process in the following use cases:
- request the necessary GUI interactions of an asynchronous payment process (PUT /payments/{transactionUniqueId}/webhook/guiRequest)
- receive asynchronous payment process status information (PUT /payments/{transactionUniqueId}/webhook/paymentStatus)
- receive asynchronous preauthorization process status information (PUT /payments/{transactionUniqueId}/webhook/preauthorizationStatus)
- receive financial advice process status information (PUT /payments/{transactionUniqueId}/webhook/financialAdviceStatus)
- receive asynchronous refund status information (PUT /payments/{transactionUniqueId}/webhook/refundStatus)
- check the status of payment reversal process (PUT /payments/{transactionUniqueId}/webhook/reversalStatus)
Health Check
The GET /healthCheck endpoint enables the API Client a service-level health check. It provides health check status of the API component and dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.
Benefits
The Payments API makes it possible to process payments using different payment providers. It supports the following payment flows:
Payment - electronic payment using a specific external payment provider.
Preauthorization - a temporary hold placed on the customer’s balance to make sure that there are enough funds to cover the cost of the purchase.
Example: fuel filling is pre-authorized before the filling starts. The POS sends the limit values to the pump to avoid any overruns. Once the filling is completed, the POS must clear the filling and send financial advice.
Financial Advice - a mandatory procedure that enables adjusting the previously blocked amount and closing the sales transaction.
Refund - item refund process (the cashier finds one or more items to be returned by checking the Electronic Journal or by scanning the price tag barcode).
Reversal - payment reversals occur when a transaction is canceled and the funds are returned to the original payment method.
Security
The Payments API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Payments API is HTTPS.