Cancel a withdrawal before payout

Cancels a withdrawal still in its hold, returning the funds to the available balance; the workspace's owners and admins are told by message. Requires the wallet.withdraw scope. From payableAfterUtc on the payout may already be under way: 409 withdrawal_cancel_window_closed (unless the withdrawal is still held for review). A withdrawal that is no longer Requested returns 409 withdrawal_not_pending; one whose held amount is no longer held on the wallet 409 withdrawal_reconciliation_required. Refused while the workspace's API access is inactive.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string | null

Optional note, trimmed; at most 200 characters are kept.

Headers
string
length ≤ 128
^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

string
enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json