ADadyen
Balance accounts

Get payment instruments linked to a balance account

Changed on

Returns a paginated list of the payment instruments associated with a balance account.

To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments which are in active status and to skip the first 6, use /balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active.

get/balanceAccounts/{id}/paymentInstruments

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{id}/paymentInstruments
  • 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 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.

statusstring

The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.

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

  • v20ec7e1e654c7Revision changes
    • info

      added discriminator to /// response property for the response status

  • v2a4fab1c7333bRevision changes
    • info

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

    • info

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