Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2024.2-SP5 | To support the POS application with processing digital payment scenarios such as refunds and immediate payment reversals, we introduced the following endpoints: - POST /api/v1/payments/initiateRefund - initiates an asynchronous refund process. - POST /api/v1/payments/initiateReversal - initiates an immediate payment reversal. - PUT /api/v1/payments/{transactionUniqueId}/webhook/refundStatus - checks the status of an asynchronous refund process. - PUT /api/v1/payments/{transactionUniqueId}/webhook/reversalStatus - checks the status of an asynchronous payment reversal process. | v1 |
| 2024.2-SP5 and Patch in API 2024.2 | To enable a service-level health check, we introduced a new endpoint: - GET /api/v1/healthCheck. 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. | v1 |
| 2024.1 | The POS system enables processing of digital payments, for instance mobile payments, digital wallets and other digital payment methods. To support these features, we implemented Payments API, extended by pre-authorization and financial advice methods. We introduced a set of endpoints that make it possible to process payments, preauthorizations and financial advice, use customized payment providers and implement the GUI interactions during the payment process: - POST /api/v1/payments/initiatePayment - enables the POS system to initiate an asynchronous payment process - PUT /api/v1/payments/{transactionUniqueId}/abort - enables the POS system to cancel in-progress payment or preauth transaction - PUT /api/v1/payments/{transactionUniqueId}/webhook/guiRequest - enables the POS system to request the necessary GUI interactions of an asynchronous payment process. - POST /api/v1/payments/{transactionUniqueId}/guiResponse - enables the POS system to send the asynchronous GUI response - PUT /api/v1/payments/{transactionUniqueId}/webhook/paymentStatus - enables the POS system to receive asynchronous payment process status information. - POST /api/v1/payments/preauthorization - enables the POS system to initiate a preauthorization procedure. - PUT /api/v1/payments/ {transactionUniqueId}/webhook/preauthorizationStatus - enables the POS system to receive asynchronous preauthorization process status information. - POST /api/v1/payments/financialAdvice - enables the POS system to initiate an asynchronous financial advice process. - PUT /api/v1/payments/{transactionUniqueId}/webhook/financialAdviceStatus - enables the POS system to receive financial advice process status information. Payments API v1 is decomissioned. It was not migrated to Public API Cloud. | v1 |