List all Accounts

‍Retrieves list of all bank accounts that belong to a business, person, or other parameter
Accounts
List all Accounts
 last updated: 
November 22, 2022

ENDPOINT

  1. GET /v1/account

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)
status enum active, inactive, deactivated, or dormant
type enum businessChecking, personalChecking, cardAccount, clearingAccount, fallbackAccount, fundingAccount
businessId string business ID
familyId string family ID
accountNumber string account number
minBalance num minimum balance (up two decimal places)
maxBalance num maximum balance (up two decimal places)
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
metadata.query string searches for a string in the metadata


RESPONSE

  1. {
  2.   "total": 1,
  3.   "data": [
  4.     {
  5.       "id": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  6.       "businessId": "",
  7.       "familyId": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa”,
  8.       "label": "Doe Money",
  9.       "routingNumber": "084106768",
  10.       "accountNumber": "9991238158805732",
  11.       "status": "active",
  12.       "type": "personalChecking",
  13.       "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  14.       "isVerified": false,
  15.       "verifiedAt": "",
  16.       "acceptedTerms": true,
  17.       "interest": "0.00",
  18.       "fees": "0.00",
  19.       "currency": "USD",
  20.       "availableBalance": "170.00",
  21.       "sponsorBankName": "Test Bank",
  22.       "createdAt": "2022-06-21T14:23:48Z",
  23.       "modifiedAt": "2022-08-03T17:59:56Z",
  24.       "pendingDebit": "0",
  25.       "pendingCredit": "0",
  26.       "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  27.       "accountInterestFrequency": "monthly",
  28.       "metadata": null,
  29.       "config": {
  30.         "card": {
  31.           "virtual": {
  32.             "enabled": true,
  33.             "count": "25"
  34.           },
  35.           "physical": {
  36.             "enabled": true,
  37.             "count": "5"
  38.           }
  39.         },
  40.         "send": {
  41.           "intrabank": {
  42.             "enabled": true
  43.           },
  44.           "ach": {
  45.             "enabled": true,
  46.             "sameDay": true
  47.           },
  48.           "wire": {
  49.             "enabled": true
  50.           },
  51.           "check": {
  52.             "enabled": true
  53.           },
  54.           "card": {
  55.             "enabled": true
  56.           },
  57.           "debitCard": {
  58.             "enabled": true
  59.           },
  60.           "internationalWire": {
  61.             "enabled": true
  62.           },
  63.           "digitalCheck": {
  64.             "enabled": false
  65.           },
  66.           "physicalCard": {
  67.             "enabled": false
  68.           }
  69.         },
  70.         "receive": {
  71.           "intrabank": {
  72.             "enabled": true
  73.           },
  74.           "ach": {
  75.             "enabled": true,
  76.             "sameDay": true
  77.           },
  78.           "check": {
  79.             "enabled": true
  80.           },
  81.           "debitCard": {
  82.             "enabled": true
  83.           }
  84.         },
  85.         "limits": {
  86.           "receive": {
  87.             "daily": "1000.00",
  88.             "monthly": "10000.00",
  89.             "intrabank": {
  90.               "daily": "0.00",
  91.               "monthly": "0.00"
  92.             },
  93.             "ach": {
  94.               "daily": "0.00",
  95.               "monthly": "0.00"
  96.             },
  97.             "check": {
  98.               "daily": "0.00",
  99.               "monthly": "0.00"
  100.             },
  101.             "debitCard": {
  102.               "daily": "0.00",
  103.               "monthly": "0.00"
  104.             }
  105.           },
  106.           "send": {
  107.             "daily": "1000.00",
  108.             "monthly": "10000.00",
  109.             "intrabank": {
  110.               "daily": "0.00",
  111.               "monthly": "0.00"
  112.             },
  113.             "ach": {
  114.               "daily": "0.00",
  115.               "monthly": "0.00"
  116.             },
  117.             "domesticWire": {
  118.               "daily": "0.00",
  119.               "monthly": "0.00"
  120.             },
  121.             "internationalWire": {
  122.               "daily": "0.00",
  123.               "monthly": "0.00"
  124.             },
  125.             "check": {
  126.               "daily": "0.00",
  127.               "monthly": "0.00"
  128.             },
  129.             "card": {
  130.               "daily": "0.00",
  131.               "monthly": "0.00"
  132.             },
  133.             "debitCard": {
  134.               "daily": "0.00",
  135.               "monthly": "0.00"
  136.             }
  137.           }
  138.         },
  139.         "fallback": {
  140.           "originated": null,
  141.           "received": null
  142.         },
  143.         "incoming": {
  144.           "achPull": {
  145.             "enabled": true,
  146.             "allowedOriginators": [],
  147.             "blockedOriginators": []
  148.           }
  149.         }
  150.       }
  151.     }
  152.   ]
  153. }