Sign in
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.

hasNextboolean required

Indicates whether there are more items on the next page.

hasPreviousboolean required

Indicates whether there are more items on the previous page.

Changes

Changed in 14 of the 51 revisions of this API.62317

  • v287544766dc8e2See the full diff
    • ○

      api tag Custom payout schedules (sweeps) added

      api-tag-added

    • ○

      api tag Balance accounts removed

      api-tag-removed

  • v20d06f978a8b510See the full diff
    • ○

      removed the approvalExpired enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the balanceAccountTemporarilyBlockedByTransactionRule enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the declined enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the declinedByTransactionRule enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the pending enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the pendingApproval enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the pendingExecution enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the refusedByCustomer enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the scaFailed enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the schemeAdvice enum value from the // response property for the response status

      response-property-enum-value-removed

  • v24cd18d5551af1See the full diff
    • ●

      added the new schemeAdvice enum value to the // response property for the response status

      response-property-enum-value-added

  • v2dd6159049c956See the full diff
    • ▲

      the /// response property's maxLength was unset from 3 for the response status

      response-property-max-length-unset

    • ▲

      the /// response property's maxLength was unset from 3 for the response status

      response-property-max-length-unset

    • ▲

      the /// response property's maxLength was unset from 3 for the response status

      response-property-max-length-unset

    • ▲

      the /// response property's minLength was decreased from 3 to 0 for the response status

      response-property-min-length-decreased

    • ▲

      the /// response property's minLength was decreased from 3 to 0 for the response status

      response-property-min-length-decreased

    • ▲

      the /// response property's minLength was decreased from 3 to 0 for the response status

      response-property-min-length-decreased

  • v29fede8325f6d1See the full diff
    • ●

      added the new approvalExpired enum value to the // response property for the response status

      response-property-enum-value-added

  • v2e69e67d2e6921See the full diff
    • ●

      added the new pending enum value to the // response property for the response status

      response-property-enum-value-added

  • v261259c9969a51See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v25c1b264dd7b81See the full diff
    • ●

      added the new refusedByCustomer enum value to the // response property for the response status

      response-property-enum-value-added

  • v280dfacd37eec4See the full diff
    • ●

      added the new accountHierarchyNotActive enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new directDebitNotSupported enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new pendingExecution enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new transferInstrumentDoesNotExist enum value to the // response property for the response status

      response-property-enum-value-added

  • v2f874764bcf8b1See the full diff
    • ●

      added the new declined enum value to the // response property for the response status

      response-property-enum-value-added