Get payment instruments linked to a balance account

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

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

Changed in 13 of the 51 revisions of this API.31127

Jun 17, 2026v20ec7e1e654c71See the full diff
- ○
  added discriminator to paymentInstruments/items/additionalBankAccountIdentifications/items/ response property for the response status 200
  response-property-discriminator-added
May 1, 2026v2a4fab1c7333b2See the full diff
- ○
  added the optional property paymentInstruments/items/additionalBankAccountIdentifications/items/oneOf[IbanAccountIdentification]/bic to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/card/configuration/printLine to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 2025v24cd18d5551af11See the full diff
- ▲
  the response property paymentInstruments/items/card/number became optional for the status 200
  response-property-became-optional
- ○
  added the optional property paymentInstruments/items/card/configuration/bulkAddress/name to the response with the 200 status
  response-optional-property-added
Sep 12, 2025v2c6628742df823See the full diff
- ○
  added the optional property paymentInstruments/items/card/configuration/bulkAddress/line1 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/card/configuration/bulkAddress/line2 to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/card/configuration/bulkAddress/line3 to the response with the 200 status
  response-optional-property-added
Jul 29, 2025v29fede8325f6d1See the full diff
- ○
  added the optional property paymentInstruments/items/card/usage to the response with the 200 status
  response-optional-property-added
Apr 29, 2025v2508e86c65b0b2See the full diff
- ○
  added the optional property paymentInstruments/items/replacedById to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/replacementOfId to the response with the 200 status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 10, 2024v280dfacd37eec1See the full diff
- ○
  added the optional property paymentInstruments/items/bankAccount/branchNumber to the response with the 200 status
  response-optional-property-added
Jun 20, 2024v2f874764bcf8b1See the full diff
- ○
  added the optional property paymentInstruments/items/statusComment to the response with the 200 status
  response-optional-property-added
Apr 26, 2024v26f1fad79c6c01110See the full diff
- ▲
  the paymentInstruments/items/bankAccount response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ●
  removed the optional property paymentInstruments/items/additionalBankAccountIdentifications/items/oneOf[IbanAccountIdentification]/formFactor from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property paymentInstruments/items/bankAccount/accountNumber to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/bankAccount/accountType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/bankAccount/formFactor to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/bankAccount/iban to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/bankAccount/routingNumber to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/bankAccount/sortCode to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentInstruments/items/card/deliveryContact/company to the response with the 200 status
  response-optional-property-added
- ○
  response property paymentInstruments/items/additionalBankAccountIdentifications deprecated
  response-property-deprecated
- ○
  removed IbanAccountIdentification UKLocalAccountIdentification USLocalAccountIdentification from the paymentInstruments/items/bankAccount response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  added the required property paymentInstruments/items/bankAccount/type to the response with the 200 status
  response-required-property-added
Mar 4, 2024v212b2826f399011See the full diff
- ▲
  added UKLocalAccountIdentification to the paymentInstruments/items/bankAccount response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added the optional property paymentInstruments/items/additionalBankAccountIdentifications to the response with the 200 status
  response-optional-property-added

Full history (13 revisions)