Get Wallets List

The API retrieves wallets' details and fetches comprehensive information about all the wallets associated with the organization account.

GET /payments/wallets

Body Parameters Request

Name	Location	Type	Format / Values	Description
id	url params	string		The id of the wallet
active_only	url params	boolean		If active_only is set to true, only active wallets will be returned. If active_only is set to false, all existing wallets will be returned.
currency	url params	array	string:/^[A-Z]{3,3}$/	list of currency codes to filter by
tag:*	url params	object		a key/values[] set of user tags to filter wallets by
skip	url params	integer		number of items to skip in the result set
take	url params	integer		number of items to return from result set (defaults to 50)

Body Parameters Response

Name	Type	Format / Values	Description
items	array	object
items[].type	string		Entity type (wallet)
items[].id	string		Unique id of wallet
items[].currency	string		3 letter ISO currency code used by wallet
items[].name	string		User given name of wallet
items[].owner	string		id of legal entity owning this wallet
items[].funding	object		Funding account information (banking info needed to send money to wallet)
items[].balance	integer		If wallet state is ACTIVE, returns the current available ballance of the wallet
items[].user_tags	object		A k/v part of user tags assigned to the wallet
items[].state	string	DISABLED, REQUIRES_INPUT, ACTIVE	The current state of the wallet
paging	object
paging.take	integer		number of items requested to be returned from the result set
paging.skip	integer		Number of items requested to skip from the result set

Response

200 - OK

{
   "items": [
      {
         "id": "1b15bd2e-2ccb-453e-a873-33eb1230a225",
         "currency": "USD",
         "name": "Demo USD Wallet",
         "type": "wallet",
         "owner": "entity://business/customer/demo:standalone:1708959835/legal/7ed4e296-3b8f-43f1-9e33-9de88cadc35a",
         "funding": {
            "name": "RONKIֹ LTD CMA - EUR",
            "country": "GB",
            "account_number": "UKNWBK60161529100039",
            "bic": "CHASGB2L",
            "iban": "UKNWBK60161529100039"
         },
         "balance": 120000,
         "user_tags": {
            "department": "sales"
         },
         "state": "ACTIVE"
      },
      {
         "id": "1fd071bc-df1e-4947-a162-d50c39629204",
         "currency": "GBP",
         "name": "Demo GBP Wallet",
         "type": "wallet",
         "owner": "entity://business/customer/demo:standalone:1708959835/legal/7ed4e296-3b8f-43f1-9e33-9de88cadc35a",
         "funding": {
            "country": "GB",
            "account_number": "GBAB1236bb7f",
            "iban": "GBAB1236bb7f",
            "coffee": "ES",
            "name": "RAUL LTD CMA - EUR",
            "bic": "CHASGB2L"
         },
         "balance": 120000,
         "user_tags": {},
         "state": "ACTIVE"
      },
      {
         "id": "bcc045d6-ea6f-4830-939e-a0e8b5e17f08",
         "currency": "EUR",
         "name": "Demo EUR Wallet",
         "type": "wallet",
         "owner": "entity://business/customer/demo:standalone:1708959835/legal/7ed4e296-3b8f-43f1-9e33-9de88cadc35a",
         "funding": {
            "name": "POIKN LTD CMA - EUR",
            "country": "GB",
            "account_number": "UKNWBK601614291000019",
            "bic": "CHASGB2L",
            "iban": "UKNWBK601614291000019"
         },
         "balance": 120000,
         "user_tags": {},
         "state": "ACTIVE"
      }
   ],
   "paging": {
      "skip": 0,
      "take": 50
   }
}

400 - Bad Request

{
  "error": "bad_request",
  "description": "Validation errors: \"/^[A-Z]{3,3}$/\" at #/filter/currency/0 failed against #/properties/filter/properties/currency/items with \"Did not match pattern: ^[A-Z]{3,3}$\"",
  "error_code": 400
}