Actions37
- API Key Info Actions
- Claim Actions
- Claim Document Actions
- Debtor Actions
- Mandate Actions
- Order Actions
- Payment Actions
- Single Mandate Statement Actions
- Statement Actions
Order → Withdraw
AI-generatedSummary
Withdraw an existing order by its Order ID, optionally providing a reason and an idempotency key for safe retries.
Inputs
- Order ID (required) — The unique ID of the order to withdraw.
- Reason — Optional explanation for the withdrawal, up to 5000 characters.
- Idempotency Key — A key to make retries safe: provides idempotency if the same key and body are submitted within 24 hours, preventing duplicate withdrawals.
Output shape
a single object representing the withdrawn order, typically including status and confirmation of withdrawal
The idempotency key ensures that retrying the withdrawal with the same key returns the original result rather than causing duplicate actions.
Examples
Example 1: Withdrawing an order with reason and idempotency key
Specify the required Order ID, include a reason for withdrawal, and provide a unique idempotency key to ensure safe retries.