List all Crypto Wallets

Retrieves all the Crypto Wallets for a given person ID, business ID, or family ID
List all Crypto Wallets
 last updated: 
September 16, 2022

ENDPOINT

  1. GET /v1/crypto/

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
id string crypto wallet ID
businessId string business ID
familyId string family ID
status enum crypto wallet status possible values:
- active
- blocked (debit and credit blocked)
- debitBlocked (sell and send blocked)
- creditBlocked (buy and receive blocked)
startTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
endTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)


RESPONSE

  1. {
  2.     "total": 1,
  3.     "data": [
  4.         {
  5.             "id": "cpw-c8b351d4-95d6-423b-a984-7907d273f817",
  6.             "businessId": "",
  7.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  8.             "createdPersonId": "per-b1216152-0d54-401f-816f-de392b5ba77f",
  9.             "label": "Jane's BTC Wallet",
  10.             "cryptoAddress": "tb1qscc2j3358fsrhtzkh3qdklayhndfckzlha330h",
  11.             "cryptoBalance": "0.00000000",
  12.             "usdBalance": "0.00",
  13.             "currency": "BTC",
  14.             "custodian": "Zerohash",
  15.             "status": "",
  16.             "acceptedTerms": true,
  17.             "metadata": null,
  18.             "config": {
  19.                 "card": {
  20.                     "virtual": {
  21.                         "enabled": true,
  22.                         "count": "5"
  23.                     },
  24.                     "physical": {
  25.                         "enabled": true,
  26.                         "count": "5"
  27.                     }
  28.                 },
  29.                 "buy": {
  30.                     "enabled": true
  31.                 },
  32.                 "sell": {
  33.                     "enabled": true
  34.                 },
  35.                 "send": {
  36.                     "enabled": true
  37.                 },
  38.                 "receive": {
  39.                     "enabled": true
  40.                 }
  41.             },
  42.             "createdAt": "2022-04-01T00:51:08Z",
  43.             "modifiedAt": "2022-04-01T00:51:08Z",
  44.             "familyId": ""
  45.         }
  46.     ]
  47. }