Skip to main content

Processing Modes

When creating orders, you can choose between two processing modes: synchronous and asynchronous. The processing mode determines when you receive the delivery information for the order.

Available Processing Modes

Synchronous (sync)

With synchronous processing, the API request will only return once the order has been fully processed and the delivery information is available. This means:

  • The response includes complete order details with delivery information (codes, URLs, etc.)
  • You can immediately present the gift card or voucher to the customer
  • The request may take longer to complete (typically a few seconds)
  • Best for real-time scenarios where you need immediate results

Asynchronous (async)

With asynchronous processing, the API request returns as soon as the order has been created, and processing continues in the background. This means:

  • The response confirms the order was created but delivery information is not yet available
  • You need to poll the order status endpoint or use webhooks to receive delivery information once processing completes
  • Best for batch processing or when you do not need immediate results

Product Support

Not all products support both processing modes. Each product specifies which modes it supports via the processing_modes field:

  • ["async"] - Only asynchronous processing is supported
  • ["sync", "async"] - Both synchronous and asynchronous processing are supported

You can check the supported processing modes for a product by retrieving product details from the /products or /products/{code} endpoints.

Using Webhooks with Async Mode

When using asynchronous processing, we recommend configuring webhooks to be notified when order processing completes. This is more efficient than polling the order status endpoint repeatedly.

See Webhooks for more information about setting up webhook notifications for order events.