Internal Accounts

⚠️
The Internal Account API is shared across all Modern Treasury integrations. This page documents the full set of fields available when directly integrating your own bank accounts. PSP customers should reference this page instead.

An internal_account is an account that you can use to make payments and hold money. These accounts contain the relevant name, address, entity type information necessary for making payments. An internal account also has account details and routing details which include attributes like account numbers, routing numbers, and SWIFT codes. An account can have multiple routing details, such as when banks have different routing numbers for ACH and wire payments.

This page covers Internal Accounts for organizations using their own bank connection (BYO Bank). For PSP-specific Internal Accounts documentation, see Internal Accounts.

Attribute	Description
idstring	Unique identifier for the account.
account_type string	The type of account. One of `checking`, `savings`, `other`, or left null.
party_name string	The legal name of the entity which owns the account.
party_type string	Either `individual`, `business` or `null`.
party_address object	The address associated with the owner or `null`.
account_details array object	An array of account detail objects.
routing_details array object	An array of routing detail objects.
name string	A nickname for the account.
metadata object	Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.
live_mode boolean	This field will be true if this object was created with a production API key or false if created with a test API key.
connection object	The Connection that the account belongs to.
currency string	The currency of the account.
parent_account_id string	The UUID of the parent `InternalAccount` that this account belongs to. Optional. Only supported for select bank connections (BNY Mellon, Column, CrossRiver, Goldman Sachs, Grasshopper, US Bank).
counterparty_id string	The UUID of the Counterparty that this account refers to. Optional. Only applicable for nested accounts.
ledger_account_id string	The Ledger Account id linked to this `internal_account`. See Linking to Other Modern Treasury Objects.
contra_ledger_account_id string	The Contra Ledger Account id linked to this `internal_account`. See Linking to Other Modern Treasury Objects.
vendor_id string	The vendor ID associated with this account. This is the identifier your bank uses to reference the account.
account_capabilities array object	An array of account capability objects. Used to define payment origination capabilities for the account. Only supported for CrossRiver connections.
debitable boolean	Whether this account can receive ACH debits. Defaults to `false` and is only configurable on creation. Please reach out to your customer success manager if you are interested in activating this functionality.

{
  "id": "f7b2fc7a-3f22-4f82-b651-fa9e2f8d2653",
  "object": "internal_account",
  "account_type": null,
  "party_name": "Your Company",
  "party_type": null,
  "party_address": {
    "id": "ad326417-4270-4156-8652-dfe1b2ec3ae8",
    "object": "address",
    "line1": "100 Universal City Plaza",
    "line2": null,
    "locality": "Universal City",
    "region": "CA",
    "postal_code": "91608",
    "country": "US"
  },
  "account_details": [
    {
      "id": "f3552822-38f5-4dd5-aa10-a5a2fce00ed6",
      "object": "account_detail",
      "account_number_safe": "934",
      "account_number_type": "other",
      "live_mode": true
    }
  ],
  "routing_details": [
    {
      "id": "2e90da60-405c-44bc-8b33-2bdb9419afe3",
      "object": "routing_detail",
      "payment_type": null,
      "routing_number": "021000021",
      "routing_number_type": "aba",
      "bank_name": "Gringotts Wizarding Bank",
      "bank_address": {
        "id": "fcf5ebe1-b990-4684-880f-f69c277106bb",
        "object": "address",
        "line1": "6000 Universal Boulevard",
        "line2": null,
        "locality": "Orlando",
        "region": "FL",
        "postal_code": "32819",
        "country": "US",
        "live_mode": true
      }
    }
  ],
  "connection": {
    "id": "e680b151-c8a2-4b36-aa6b-059f9f2a969c",
    "object": "connection",
    "vendor_id": "example1",
    "vendor_name": "Gringotts Wizarding Bank"
  },
  "currency": "USD",
  "parent_account_id": "5fcd681b-826c-480c-a565-f2919bcbdb82",
  "counterparty_id": "8646ad4a-f582-454f-9928-148dcb445995",
  "metadata": {},
  "ledger_account_id": null,
  "contra_ledger_account_id": null,
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z",
  "vendor_id": null,
  "debitable": false
}