Custom payout schedules (sweeps)
Get all sweeps for a balance account
Returns a list of the sweeps configured for a balance account.
To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use /balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10.
get/balanceAccounts/{balanceAccountId}/sweeps
Path parameters
balanceAccountIdstring required
The unique identifier of the balance account.
Query parameters
offsetinteger
The number of items that you want to skip.
limitinteger
The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.
Response
OK - the request has succeeded.