v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

External Accounts

Get an external account

Returns an external account, given an external account ID.

get/external_accounts/{external_account_id}

Path parameters

external_account_idstring uuid required

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

External Account ID

Response

The external account

account_owner_namesstring[] required

The names of the account owners. Values may be masked, in which case the array will be empty.

business_idstring uuid

The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id will be returned.

creation_timestring date-time required

currencystring

ISO 4217 alphabetic currency code

customer_idstring uuid

The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id will be returned.

deletion_timestring date-time

idstring uuid required

External account unique identifier

last_updated_timestring date-time required

metadataobject

User-supplied JSON format metadata.

namestring

The official name of the account

nicknamestring nullable

A user-meaningful name for the account

status'ACTIVE' | 'CLOSED' | 'DELETED' | 'INACTIVE' required

The current state of the account

status_reasonstring

The reason for the status for the external account.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

The type of the account

Example response

{
  "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"
  }
}