Get all sweeps for a balance account

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.

Endpoint destination URL{balanceAccountId}/sweeps
Click to copy

Query parameters

limit integer

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

offset integer

The number of items that you want to skip.

Path parameters

balanceAccountId string Required

The unique identifier of the balance account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Response
  • Click to copy