Request a withdrawal

post

https://myapi.xegora.com/api/v1/withdrawals

Moves unused prefund toward the workspace's registered payout destination (the default an owner chose for the currency, approved by Xegora and past its cooling-off) after a business-day hold; cancellable until the hold ends; never names a destination. Requires the opt-in wallet.withdraw scope. With an Idempotency-Key the request is safe to retry: the first request answers 201 with a Location header, a retry under the same key 200 with the withdrawal the first one made (as it stands now), and the same key with another amount or currency 409 idempotency_conflict. Without the header every request is a new withdrawal. With the quote's fee and net (both or neither), a request under terms that changed since is 409 withdrawal_terms_changed. A withdrawal above the review amount Xegora set for the workspace is still created (201) and comes back with heldForReview: true: it cannot be paid until Xegora releases it. The workspace's owners and admins are told by message as soon as a withdrawal is requested.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

required

Positive, in at most the currency's minor-unit digits.

currency

string

required

fee

number | null

With net, the terms a quote showed: a request under terms that changed since is refused (409 withdrawal_terms_changed). Send both or neither.

net

number | null

With fee, the terms a quote showed.

Headers

Idempotency-Key

string

length between 16 and 128

Optional retry token for a withdrawal request: 16–128 characters without control characters, trimmed. A retry under the same key answers 200 with the withdrawal the first request made; the same key with another amount or currency is 409 idempotency_conflict. Keys belong to the API key that sends them and are spent for good.

X-Correlation-Id

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.

X-Language

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

200A retry under the same Idempotency-Key — the withdrawal the first request made, as it stands now.

201The withdrawal was created.

400The request is malformed (code = invalid_request): a bad parameter or header, a missing or malformed Idempotency-Key, or a body member the contract does not have — named, by its path in the body, in errors. Do not retry unchanged.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.

413The request body is over 256 KiB (code = payload_too_large).

415The request body is not application/json (code = unsupported_media_type).