v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

List Bank Accounts

get/bank_account

Query parameters

pageinteger

per_pageinteger

fromstring date

2021-05-30

tostring date

2099-05-30

currency'USD' | 'NGN' | 'EUR' | 'GBP'

settlement_currency'USD' | 'NGN' | 'EUR' | 'GBP'

labelstring

status'active' | 'inactive'

provider'internal' | 'anchor'

kind'standard'

type'person' | 'business'

holder_type'person' | 'business'

holder_idstring

autosweep_enabledboolean

Response

200

messagestring

statusstring

Example response

{
  "data": [
    {
      "id": "548d6eb668f111eda78fe041a4724e32",
      "holder_id": "6289dedc686511eda78fe041a4724e32",
      "holder_type": "person",
      "label": "David's Account",
      "account_name": "David Mark",
      "account_number": "9992740191426913",
      "routing_number": "084106768",
      "bank_name": "Evolve Bank and Trust",
      "bank_address": {
        "city": "Memphis",
        "country": "US",
        "line1": "6070 Poplar Ave",
        "line2": "Suite 200",
        "postal_code": "38119",
        "state": "TN"
      },
      "routing_options": [
        {
          "routing_number": "101019644",
          "supported_rails": [
            "ach"
          ]
        }
      ],
      "currency": "USD",
      "type": "personal_checking",
      "status": "active",
      "created_at": "2022-11-20T17:35:23Z",
      "updated_at": "2022-11-20T19:32:50Z"
    }
  ],
  "message": "Bank accounts retrieved successfully",
  "meta": {
    "per_page": 20,
    "page": 1,
    "count_total": 4,
    "page_total": 1
  },
  "status": "success"
}