Create a scheduled fiat withdrawal

Configures a recurring sweep of the merchant's fiat balance to a registered bank account. On success returns the newly created schedule in status ACTIVE.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

ID of the fiat withdrawal account to sweep.

string
enum
required

Currency to sweep.

string
enum
required

Sweep cadence.

Allowed:
int32

Day selector for the sweep. Null for DAILY; 1-7 (Monday=1) for WEEKLY; 1-31 for MONTHLY.

number

Optional minimum the net swept amount must reach for a withdrawal to be created. When the sweep is below this value the run is skipped. Omit for no minimum.

number
required

Balance floor in major units of the selected currency. Only the excess above this floor is swept.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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