ExchangeWithdrawals

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 — reserved, awaiting dispatch. Cancellable.
  • processing — dispatched to the rail. Not cancellable.
  • completed — rail confirms sent; reservation → final debit.
  • cancelled — client-initiated cancel while pending.
  • failed — rejected pre-dispatch; 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 null
statusReasonenum or null

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

Allowed values:

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error