What is an Asynchronous API Call Type?

In an asynchronous payment flow, the payment result is not returned immediately in the API response. Instead, once the payment is initiated, the API responds with a HTTP 202 (accepted) status, while the transaction continues processing in the background.

This model is commonly used for payment methods that require user interaction, such as card payments with 3D Secure authentication. Integrators should ensure their system can handle and respond to asynchronous updates to complete the transaction lifecycle and update the POS or order system accordingly.

How Does an Asynchronous API Call Type Work?

When an asynchronous payment is initiated, the API request triggers the transaction, but the system does not return the final payment result immediately. Instead, it responds with a status such as accepted or queued, and continues processing the payment in the background. Once the payment is processed, the final status (such as approved, declined or failed) is sent to the merchant system via a webhook (callback URL). This allows the POS or backend system to react accordingly once the result is known.

Request

POST

ENDPOINT
/v/1/payment/async

Response

RESPONSE TYPE	DESCRIPTION
Webhook	If the POS is making use of the Asynchronous REST API call, the POS will not receive a JSON BODY response for a sale request, the POS will receive a webhook response for the sale request, the webhook is mandatory when making use of Asynchronous REST API calls. Please refer to the Webhook section to set up webhooks.