ADadyen
Platform

Get all account holders under a balance platform

Changed on

Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters.

For example, to limit the page to 5 account holders and to skip the first 20, use /balancePlatforms/{id}/accountHolders?limit=5&offset=20.

get/balancePlatforms/{id}/accountHolders

Request

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

Path parameters

idstring required

The unique identifier of the balance platform.

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

  • v2dd6159049c95Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

  • v2de1988a0d7b1Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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