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.
idempotency-key header with the request. This header must have a randomly generated UUID as its value.
Example idempotency key
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.
Repeat attempts are recognised as idempotent during a time window of at least 24 hours.
The following POST requests require idempotency keys; sending idempotent keys for other endpoints or HTTP methods has no effect:
- Create account
- Create account group
- To be able to collect custom fees, we offer an endpoint where you can send fee collection requests via our API. To collect custom fee amounts from your users' accounts, you need to create a fee collection via the POST method.
- Create a mandate
- Place an order
- Trigger a direct debit
- Trigger a withdrawal
- Create portfolios allocation
- Create portfolios configuration
- Create portfolios liquidation request
- Create portfolios order
- Create portfolios rebalancing strategy
- Trigger portfolio rebalancing
- Create a new reference account for a user
- Update tax residencies
- Create a user
Was this page helpful?