Skip to main content
GET
List auto-withdrawal rules
List your auto-withdrawal rules — one per currency. A rule says: “whenever my balance reaches X, send it to this whitelisted address automatically.”
cURL
200 OK
The example shows an account with no rules configured.

Authorization

Dashboard-only (JWT) with role merchant_admin, merchant_member or super_admin, plus the auto-withdrawals:view team permission. API keys are not accepted — calling this endpoint with an API key fails with 401 {"error":"Invalid or expired token"}. See the Authentication guide. Rate limit: 60/min. This endpoint takes no parameters — the rules are scoped to the merchant in your dashboard session.

Full request example

JavaScript

Response fields

Errors

Rule fields

string
The rule id.
string
The currency this rule watches.
boolean
Whether the rule fires.
string
The trigger threshold, as an exact decimal string.
string
all (sweep the full available balance) or fixed (send exactly minAmount). Defaults to all.
string
The payout address. Must already be on your withdrawal whitelist.
string
Present only for tag-based currencies (XRP).
string
ISO timestamp of the last firing. Absent until the rule has fired once.
string
ISO timestamp.
string
ISO timestamp.

See also