Quote a withdrawal

Prices a hypothetical withdrawal — fee, net, earliest payout instant after the business-day hold, and current available headroom — with no side effects. It does not check the balance, the payout destination or the limits. Requires the wallet.read scope. Allowed while the subscription is overdue or the entitlement has ended.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

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

string
required
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