Sign in

v3

latestOpenAPI 3.0.32026-07-31489099.0 KB
Financial Institutions

Create External financial institution

Creates a record of an external financial institution that can be used to receive funds.

post/accounts/{account_id}/financial-institutions/external

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

account_numberstring required
account_typestring required
namestring
ownerstring required
ownership'self-owned' | 'customer-owned'

Ownership type of the financial institution

routing_numberstring required
transfer_typesstring[] required

Transfer types to support for this financial institution. When wire is included, bank_address and beneficiary_address are required.

Example request

{
  "account_number": "123456789",
  "account_type": "checking",
  "bank_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "beneficiary_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "name": "First Last Bank",
  "owner": "Jane Doe",
  "ownership": "customer-owned",
  "routing_number": "123456789",
  "transfer_types": [
    "ach_credit",
    "wire"
  ]
}

Response

OK

account_numberstring nullable

Masked account number showing only last 4 digits for security (format: ****1234). Full number never returned.

account_type'checking' | 'savings' nullable
createdstring date-time required

ISO-8601 timestamp that includes date and time

idstring required

ID of the resource

last_updatedstring date_time

Last update timestamp

namestring nullable required
needs_updateboolean

Whether this FI needs Plaid reauthorization

ownerstring nullable

Beneficiary name for wire transfers (maps from POST request owner field)

ownership'self-owned' | 'customer-owned'

Ownership type of the financial institution

routingNumberstring required
status'active' | 'archived' required
transfer_typesstring[] nullable

Example response

{
  "account_number": "****1234",
  "account_type": "checking",
  "bank_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "beneficiary_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "created": "2020-01-01T12:00:00Z",
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
  "last_updated": "2024-01-15T10:30:00Z",
  "name": "First Last Bank",
  "owner": "Jane Doe",
  "ownership": "customer-owned",
  "routingNumber": "123456789",
  "transfer_types": [
    "ach_debit"
  ]
}