Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Wallets

Search Wallets

Endpoint to search Wallets using filtering parameters.

get/business/v2/wallets

Query parameters

type'main' | 'company' | 'employee' | 'dedicated'

The type of resource assigned to the Wallet.

Example:company

The type of resource assigned to the Wallet.

idstring

The ID of the type resource.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

The ID of the type resource.

customreferenceIdstring

The custom reference ID of the type resource.

Example:123456-user-1

The custom reference ID of the type resource.

groupIdstring

The ID of the Group the Wallet is related to.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa

The ID of the Group the Wallet is related to.

namestring

The full or partial name of the Wallet.

Example:John Doe

The full or partial name of the Wallet.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The returned resource is an array containing Wallets.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "CompanyWallet1",
      "available_amount": 100,
      "primary_user_type": "company",
      "primary_user_public_id": "XMPL1234-000001",
      "custom_reference_id": "123456-usa-1",
      "group_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "groups": [
        "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
      ],
      "label": "CompanyWallet1",
      "visible": true,
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-01T12:48:40Z",
      "deposit_account_info": [
        "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
      ],
      "description": "CompanyWallet1"
    }
  ]
}