The Crypto Wallet object

The Crypto Wallet object's attributes, fields, and types
The Crypto Wallet object
 last updated: 
September 16, 2022
Field Type Optional Description
id string read only unique id of the crypto wallet
businessId string yes unique id of the business, if applicable
familyId string yes unique id of the family, if applicable
programId string read only the program ID
createdPersonId string read only person ID of the wallet creator
label string yes friendly account label for program use
cryptoAddress string read only cryto wallet address
cryptoBalance string read only crypto balance
usdBalance string read only crypto balance in USD
currency string no wallet's cryptocurrency (symbol)
custodian string read only crypto wallet custodian
status enum no possible status values:
- active
- blocked (credit and debit are blocked)
- debitBlocked (sell, send are blocked)
- creditBlocked (buy, receive are blocked)
acceptedTerms boolean no true if terms were accepted during wallet creation
metadata string yes see the Metadata sub-object
createdAt string read only time at which the wallet object was created
modifiedAt string read only time at which the wallet object was modified
config object read only crypto config sub-object


SAMPLE RESPONSE

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