Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
wallet

List all wallets

This endpoint retrieves a list of wallets based on specified filters and parameters, including team ID, wallet name, wallet ID, external ID, and more. Supports pagination and sorting to manage large sets of data effectively.

get/v2/wallets

Query parameters

pageTokenstring

Use this token to paginate through the list of wallets. Pass it in subsequent requests to continue from where the previous call left off.

pageSizestring int64

Define the number of wallets to return per page. Defaults to 20 if not specified.

teamIdstring

Filter the list to include only wallets that belong to the specified team.

archivedboolean

Filters results to show only archived wallets when set to true.

namestring

Filters wallets by the specified wallet name.

sortOptions.key'SORT_OPTION_KEY_NAME' | 'SORT_OPTION_KEY_AVAILABLE_BALANCE'

Defines the key for sorting wallets, enabling you to tailor wallet organization to your needs. You can sort by keys such as name and available balance, and set the order to either ascending (ASC) or descending (DESC). Specify both the key and order to achieve precise sorting results.

sortOptions.order'SORT_OPTION_ORDER_ASC' | 'SORT_OPTION_ORDER_DESC'

Specifies the order in which the wallets are sorted. Choose from ascending (SORT_OPTION_ORDER_ASC) or descending (SORT_OPTION_ORDER_DESC) order.

idstring

Filter wallets using specified wallet IDs. You can include up to 50 wallet IDs in your request, separated by commas.

externalIdstring

Filters wallets using the specified external ID. This field allows the storage of custom identifiers for tracking purposes, such as Placement IO numbers, purchase order numbers, or Salesforce numbers. It is available for partners to associate external identifiers with the wallet. Ensure the external ID is less than 255 characters, as no additional validation is applied.

requestTeamIdstring

The team ID used to verify access. Recommended for all requests.

Response

A list of wallets and a pagination token.

nextPageTokenstring

The page token for requesting the next page of the pagination. Should be used as "pageToken" in the request.

totalCountstring int64

The total number of wallets that meet the specified criteria.

Example response

{
  "wallets": [
    {
      "id": "wallet_12345ABC",
      "namespaceId": "namespace_xyz987",
      "teamId": "team_456DEF",
      "name": "MainCompanyWallet",
      "externalId": "ext_789GHI",
      "currencyCode": "USD",
      "creditLimit": "50000.00",
      "dailyBudget": "1000.00",
      "currentBalance": "20000.00",
      "availableBalance": "15000.00",
      "cappedAvailableBalance": "500.00"
    }
  ]
}