GET /balanceAccounts/{balanceAccountId}/sweeps

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.

Servers

Path parameters

Name Type Required Description
balanceAccountId String Yes

The unique identifier of the balance account.

Query parameters

Name Type Required Description
limit Integer No

The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.

offset Integer No

The number of items that you want to skip.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.