Skip to navigation
ExchangeExchangeWithdrawals

Cancel a withdrawal

Cancels a pending withdrawal before dispatch to the rail.

Idempotency: resource-keyed by withdrawalId — no header. Replay on an already-cancelled withdrawal returns 200 with the current state.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Path parameters

withdrawalIdstringRequired

Response

Withdrawal cancelled. Returns the withdrawal with status: cancelled. Reservation released, balance restored.

withdrawalIdstring
statusenum
  • pending — not yet dispatched. Cancellable, unless statusReason is compliance_review: the withdrawal is held by a compliance check and stays pending until compliance clears it.
  • processing — dispatched to the rail. Not cancellable.
  • completed — rail confirms sent; reservation → final debit.
  • cancelled — client-initiated cancel while pending.
  • failed — rejected; reservation released.
  • returned — sent but returned by receiving bank; balance restored.
beneficiaryIdstring
currencystring
amountstring
referencestring
paymentTypeenum
Inherited from the beneficiary's routing.
createdAtdatetime
updatedAtdatetime
clientReferencestring or nullOptional
statusReasonenum or nullOptional

Machine-readable context for the current status. Present when additional detail is available.

  • compliance_review — set with pending; the withdrawal is held by a compliance check and cannot be cancelled.
  • returned_by_bank — set with returned.
Allowed values:

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error