General

If a ion_url is defined in the merchant object, we will notify the specified URL via a POST request seconds after a new order has been completed.

A JSON object is sent in the request body.

{
  "order_id": int
}

The endpoint has to return a HTTP status in range 2xx. The notification is sent at least once – the notification handler must be idempotent.

After initial testing and set up of the ion_url the handler can send an (authorized) POST request to /refb.merchant.v1.OrderService/GetOrder with the order_idin request body like this:

{
  "id": "string"
}

to receive all order details and consume them further.

<aside> ℹ️ We will attempt to deliver order notifications for up to two days with an increasing interval between retries.

</aside>

Testing

A notification request can be simulated with following command:

$ curl -d '{"order_id": 1234}' <https://example.com/handler>

You can use the -v flag for checking the returned status code.

Setup

If you wish to use the Instant Order Notifications, send an email to [email protected] with your account name and your notification handler URL.