External Accounts
List external accounts
Returns a list of all external accounts assigned to customers.
get/external_accounts
Query parameters
customer_idCustomerId[]
A list of customer unique identifiers, with a comma separating any values.
[ "7d943c51-e4ff-4e57-9558-08cab6b963c7" ]
nicknamestring
A user-meaningful name for the account.
include_historyboolean
If true, include old (inactive) records as well.
bank_routingstring
idstring[]
External account ID(s). Multiple IDs can be provided as a comma-separated list.
account_numberstring
page_tokenstring
Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
Example:a8937a0d
limitinteger
Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
Example:100
business_idBusinessId2[]
A list of business unique identifiers, with a comma separating any values.
[ "7d943c51-e4ff-4e57-9558-08cab6b963c7" ]
Response
List of external accounts
Example response
{
"external_accounts": [
{
"account_identifiers": {
"iban": "LI4476584648937N59B00",
"number": "78277121"
},
"account_owner_names": [
"Jane Smith"
],
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"creation_time": "2010-05-06T12:23:34.321Z",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"name": "Plaid Checking",
"nickname": "Vacation savings",
"routing_identifiers": {
"ach_routing_number": "756392185",
"bank_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_countries": [
"US"
],
"bank_name": "Chase",
"correspondent_bank_details": [
{
"bank_address": {
"address_line_1": "100 Main St.",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"country_code": "US",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_name": "Bank of Greece",
"swift_code": "BNGRGRAAXXX"
}
],
"eft_ca_routing_number": "02101140",
"eft_routing_number": "02101140",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"tenant": "abcdef_ghijkl",
"vendor_info": {
"vendor": "SOCURE"
},
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
}
}
],
"next_page_token": "a8937a0d"
}