Skip to main content
POST
Delete a rule
Delete an auto-withdrawal rule by id. Once deleted, the automatic sweep for that currency stops.
cURL

Authorization

Dashboard-only (JWT) with role merchant_admin, merchant_member or super_admin, plus the auto-withdrawals:manage team permission. API keys are not accepted — an API key gets 401 {"error":"Invalid or expired token"}. The body must carry one fresh MFA factor (passkey / TOTP / emailed code — the VERIFICATION_PROPS fields; see the Authentication guide). Email codes come from Send auto-withdrawal email code. Rate limit: 10/min.

Parameters

string
required
The rule id to delete (from List auto-withdrawal rules).
string
The single-use emailed code.
string
A 6-digit code from your authenticator app — an alternative to emailCode. Backup codes are not accepted here: the field is validated against ^[0-9]{6}$ and backup codes are 16 hexadecimal characters. They work only at login (POST /2fa/validate). If you have lost your authenticator, request an emailed code instead.
object
WebAuthn assertion, used together with challengeKey.
string
Accompanies passkeyResponse.
Not verifying with a passkey or TOTP? Request an emailed code via Send auto-withdrawal email code right before this call — the code is single-use.

Full request example

JavaScript

Errors

See also