external_account

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
live_mode	boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
created_at	string
updated_at	string
discarded_at	string
account_type	object
party_type	string	Either `individual` or `business`.
party_address	object	The address associated with the owner or `null`.
name	string	A nickname for the external account. This is only for internal usage and won't affect any payments
counterparty_id	string
account_details	array
routing_details	array
external_id	string	An optional user-defined 180 character unique identifier.
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.
party_name	string	The legal name of the entity which owns the account.
contact_details	array
ledger_account_id	string	If the external account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here.
verification_status	string
verification_source	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/external_account",
  "title": "external_account",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "discarded_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "account_type": {
      "$ref": "#/components/schemas/external_account_type"
    },
    "party_type": {
      "type": "string",
      "enum": [
        "business",
        "individual"
      ],
      "nullable": true,
      "description": "Either `individual` or `business`."
    },
    "party_address": {
      "$ref": "#/components/schemas/address",
      "description": "The address associated with the owner or `null`."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "A nickname for the external account. This is only for internal usage and won't affect any payments"
    },
    "counterparty_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "account_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_detail"
      }
    },
    "routing_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/routing_detail"
      }
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "An optional user-defined 180 character unique identifier."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      },
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings."
    },
    "party_name": {
      "type": "string",
      "description": "The legal name of the entity which owns the account."
    },
    "contact_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact_detail"
      }
    },
    "ledger_account_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "If the external account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here."
    },
    "verification_status": {
      "type": "string",
      "enum": [
        "pending_verification",
        "unverified",
        "verified"
      ]
    },
    "verification_source": {
      "type": "string",
      "enum": [
        "ach_prenote",
        "microdeposits",
        "plaid"
      ],
      "nullable": true
    }
  },
  "additionalProperties": false,
  "minProperties": 20,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "discarded_at",
    "account_type",
    "party_type",
    "party_address",
    "name",
    "counterparty_id",
    "account_details",
    "routing_details",
    "external_id",
    "metadata",
    "party_name",
    "contact_details",
    "ledger_account_id",
    "verification_status",
    "verification_source"
  ]
}