List all Crypto Wallets (Program)

Retrieves list of all crypto wallets that belong to a program
List all Crypto Wallets (Program)
 last updated: 
August 15, 2022

ENDPOINT

  1. GET /v1/program/:id/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
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)
modifiedStartTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedEndTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 1,
  3.     "data": [
  4.         {
  5.             "id": "cpw-4c3560e4-582c-4d9a-be54-e3725de54c8d",
  6.             "businessId": "",
  7.             "label": "Jane's BTC Wallet",
  8.             "cryptoAddress": "tb1qr4kxyzkg9at66rgd2gqmu3nruhc7kuge9qxd2d",
  9.             "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  10.             "status": "active",
  11.             "cryptoBalance": "0.00457436",
  12.             "usdBalance": "107.88",
  13.             "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  14.             "acceptedTerms": true,
  15.             "currency": "BTC",
  16.             "custodian": "Zerohash",
  17.             "config": {
  18.                 "card": {
  19.                     "virtual": {
  20.                         "enabled": true,
  21.                         "count": "25"
  22.                     },
  23.                     "physical": {
  24.                         "enabled": true,
  25.                         "count": "5"
  26.                     }
  27.                 },
  28.                 "buy": {
  29.                     "enabled": true
  30.                 },
  31.                 "sell": {
  32.                     "enabled": true
  33.                 },
  34.                 "send": {
  35.                     "enabled": false
  36.                 },
  37.                 "receive": {
  38.                     "enabled": true
  39.                 }
  40.             },
  41.             "metadata": null,
  42.             "familyId": "",
  43.             "createdAt": "2022-06-21T14:41:32Z",
  44.             "modifiedAt": "2022-08-03T18:00:01Z"
  45.         }
  46.     ]
  47. }