GET /balanceAccounts/{id}/paymentInstruments

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.

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the balance account.

Query parameters

Name Type Required Description
limit Integer No

The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.

status String No

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

offset Integer No

The number of items that you want to skip.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.