ADadyen
Custom payout schedules (sweeps)

Get all sweeps for a balance account

Changed on

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

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/sweeps
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

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

  • v287544766dc8eRevision changes
    • info

      api tag Custom payout schedules (sweeps) added

    • info

      api tag Balance accounts removed

  • v20d06f978a8b5Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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