SOsoldo
Wallets

Search Wallets

Changed on

Endpoint to search Wallets using filtering parameters.

get/business/v2/wallets

Request

Query parameters

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

The type of resource assigned to the Wallet.

Example:company
idstring

The ID of the type resource.

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

The custom reference ID of the type resource.

Example:123456-user-1
groupIdstring

The ID of the Group the Wallet is related to.

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

The full or partial name of the Wallet.

Example:John Doe
pinteger

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

Example:3
sinteger

It indicates the number of items per page.

Example:25
d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC
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.

[
  "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"
    }
  ]
}

Changes

  • 5470d4c0eb01Revision changes
    • warning

      added the new ACCOUNT_NUMBER enum value to the //// response property for the response status

  • e4706ef36e2aRevision changes
    • warning

      deleted the query request parameter publicId

    • info

      added the new optional query request parameter id

    • info

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