Skip to main content
GET
/
v2
/
bank-accounts
List Bank Accounts
curl --request GET \
  --url https://api.example.com/v2/bank-accounts \
  --header 'Authorization: Bearer <token>'
[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "archived": true,
    "bank": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "color": "<string>",
      "name": "<string>",
      "countries": [
        "<string>"
      ],
      "archived": true,
      "remote_logo": "<string>",
      "website": "<string>",
      "routing_numbers": [
        {}
      ],
      "object": "<string>"
    },
    "currency": "ADP",
    "erp_account_id": "<string>",
    "erp_account_number": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "last_transaction_sync_at": "2023-11-07T05:31:56Z",
    "ledger_account": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "classification": "asset",
      "currency": "ADP",
      "current_balance": "<string>",
      "description": "<string>",
      "is_active": true,
      "is_direct_posting_enabled": true,
      "name": "<string>",
      "number": "<string>",
      "parent_account_id": "<string>",
      "remote_id": "<string>",
      "subtype": "<string>",
      "type": "<string>",
      "object": "<string>"
    },
    "linked_integration_id": "<string>",
    "iban": "<string>",
    "mask": "<string>",
    "name": "<string>",
    "nickname": "<string>",
    "official_name": "<string>",
    "party_name": "<string>",
    "remote_id": "<string>",
    "remote_data": {},
    "routing_number": "<string>",
    "sync_status": "partial",
    "timezone": "Africa/Abidjan",
    "type": "cash_management",
    "object": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
is_erp_account
boolean

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
archived
boolean
required

Whether the bank account is archived or not

bank
Bank · object
required
currency
enum<string> | null
required

The 3 character ISO 4217 currency code.

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR
erp_account_id
string | null
required

The ID of the ERP bank account associated with this bank account.

erp_account_number
string | null
required

The ERP number of the account.

last_synced_at
string<date-time> | null
required
last_transaction_sync_at
string<date-time> | null
required

The last time transactions were synced.

ledger_account
LedgerAccount · object
required

The ID of the G/L account associated with this bank account.

linked_integration_id
string | null
required
iban
string | null
required

The IBAN of the bank account.

mask
string
required

The last 2-4 alphanumeric characters of an account's official account number.

name
string
required

The name of the account. If not assigned by the user, defaults to the name given by the financial institution itself

nickname
string | null
required
official_name
string | null
required

The name of the account assigned by the financial institution.

party_name
string | null
required

The legal name of the entity which owns the account.

remote_id
string | null
required

The external ID of the bank account. Only exists if this account is related to a bank feed connection.

remote_data
object
required

The original object returned from the third party

routing_number
string | null
required

The bank's routing number.

sync_status
enum<string> | null
required

The sync status for the bank account.

Available options:
partial,
syncing,
synced,
failed
timezone
enum<string> | null
required

IANA canonical timezone.

Available options:
Africa/Abidjan,
Africa/Cairo,
Africa/Johannesburg,
Africa/Lagos,
Africa/Maputo,
Africa/Nairobi,
Africa/Tripoli,
America/Adak,
America/Anchorage,
America/Argentina/Buenos_Aires,
America/Argentina/Catamarca,
America/Argentina/Cordoba,
America/Argentina/Jujuy,
America/Argentina/Mendoza,
America/Chicago,
America/Denver,
America/Detroit,
America/Edmonton,
America/Halifax,
America/Havana,
America/Indiana/Indianapolis,
America/Indiana/Knox,
America/Iqaluit,
America/Jamaica,
America/Kentucky/Louisville,
America/Los_Angeles,
America/Manaus,
America/Mazatlan,
America/Mexico_City,
America/New_York,
America/Noronha,
America/Nuuk,
America/Panama,
America/Phoenix,
America/Puerto_Rico,
America/Regina,
America/Rio_Branco,
America/Santiago,
America/Sao_Paulo,
America/St_Johns,
America/Tijuana,
America/Toronto,
America/Vancouver,
America/Whitehorse,
America/Winnipeg,
Asia/Ashgabat,
Asia/Bangkok,
Asia/Dhaka,
Asia/Dubai,
Asia/Ho_Chi_Minh,
Asia/Hong_Kong,
Asia/Jerusalem,
Asia/Kathmandu,
Asia/Kolkata,
Asia/Kuching,
Asia/Macau,
Asia/Makassar,
Asia/Nicosia,
Asia/Qatar,
Asia/Riyadh,
Asia/Seoul,
Asia/Shanghai,
Asia/Singapore,
Asia/Taipei,
Asia/Tehran,
Asia/Thimphu,
Asia/Tokyo,
Asia/Ulaanbaatar,
Asia/Urumqi,
Asia/Yangon,
Atlantic/Faroe,
Australia/Adelaide,
Australia/Brisbane,
Australia/Broken_Hill,
Australia/Darwin,
Australia/Hobart,
Australia/Lord_Howe,
Australia/Melbourne,
Australia/Perth,
Australia/Sydney,
Etc/GMT,
Etc/UTC,
Europe/Athens,
Europe/Belgrade,
Europe/Berlin,
Europe/Brussels,
Europe/Chisinau,
Europe/Dublin,
Europe/Helsinki,
Europe/Istanbul,
Europe/Kyiv,
Europe/Lisbon,
Europe/London,
Europe/Moscow,
Europe/Paris,
Europe/Prague,
Europe/Rome,
Europe/Warsaw,
Europe/Zurich,
Indian/Maldives,
Pacific/Auckland,
Pacific/Chatham,
Pacific/Easter,
Pacific/Guadalcanal,
Pacific/Guam,
Pacific/Honolulu,
Pacific/Kanton,
Pacific/Kwajalein,
Pacific/Pago_Pago,
Pacific/Port_Moresby,
Pacific/Tarawa
Minimum string length: 1
type
enum<string>
required

The type of bank account.

Available options:
cash_management,
checking,
savings,
cd,
money_market,
paypal,
other
object
string
required

String representing the object's type. Objects of the same type share the same value.