Idempotency

For requests that were interrupted during transmission and to which no response was received, we require idempotency keys. This way, you can safely repeat these requests without us accidentally performing the same operation twice.

How idempotency works

If a request for placing an order is interrupted due to a network connection error, you can repeat it with the same idempotency key to ensure that no more than one order is placed.

Implementing idempotency

Provide an idempotency-key header with the request. This header must have a randomly generated UUID as its value.

Example idempotency key

idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c

Generate a new and unique idempotency-key value for each new request, but make sure that in case you need to retry a previous request, you use the same idempotency-key value as for the repeated request.

The following POST requests require idempotency keys; sending idempotent keys for other endpoints or HTTP methods has no effect:

• Creates an account.

• Creates an account group.

• Creates a fee collection for pre-calculated fee amounts.

• Create account liquidation request

• Create a mandate

• Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously.

• Triggers the creation of a top-up payment.

• Trigger a direct debit

• Trigger a withdrawal

• Create portfolios allocation

• Create portfolios configuration

• Create portfolios order

• Trigger portfolio rebalancing

• Creates a new reference account for a user specified by ID.

• Create savings plan

• Update tax residencies

• Trigger a bank transaction for testing purposes. This can be used to simulate a money transfer for various flows which need cash settlements on one of our bank accounts.

• Creates a user.

• Trigger a virtual cash decrease

• Trigger a virtual cash increase