Skip to main content

The account object

Accounts are a representation of an entity's financial accounts. An account can be a checking or savings account (ach) or a credit card, student loan, etc. (liability).

ACH

To create an ach account you will need the routing and account number of the depository account. We recommend using Plaid to retrieve your entity's ach information.

Liability

To create a liability account you can use:
  • 💡 Method Data - you can automatically retrieve all of an entity's liabilities using Method Data. See the retrieve an entity's debts guide to learn more.
  • ⚡ API - You will need the merchant id (mch_id) and the account number of the liability.
ℹ️ Important: the holder_id is the id of the Entity who owns this account. Associating the incorrect Entity will lead to failed/returned payments.

Attributes

id

string
Unique identifier for the account.

holder_id

string
The id of the Entity who is the legal holder of this account.

type

enum
The type of account.
Possible enum values

ach

A bank account (Checking or Savings).

liability

A debt-type account (Credit Card, Mortgage, etc).

ach

object,null
The id of the Entity who is the legal holder of this account.

ach.routing

string
ABA routing number of the ACH account. (maximum of 9 characters).

ach.number

string
Account number of the ACH account. (maximum of 17 characters).

ach.type

enum
Type of ACH account
Possible enum values

checking

savings

liability

object,null
Liability account information

liability.mch_id

string
Unique identifier of the merchant associated with this account.

liability.mask

string,null
The last 4 digits of the associated account number.

liability.type

enum

The type of liability account.

The following are possible values for liability.type. For any of these values except unknown, a corresponding key with the same name will be populated with data for that specific type.
Example: If an account has liability.type equal to credit_card, then liability.credit_card will be populated with credit card information.
Possible enum values

student_loan

credit_card

auto_loan

mortgage

personal_loan

loan

unknown

metadata

object,null
Additional data provided during creation. See metadata.

status

enum
Status of an account.
Possible enum values

active

The account has at least the payments:receive capability.

disabled

The account has been disabled and no longer has capabilities. Accounts can transition into the disabled status if a related payment fails due to invalid account information.

closed

The account was created using Method Data and is either fully paid-off or no longer exists. Accounts in `closed` will not have capabilities.

processing

The account was created using Method Data and is currently being processed. Once that account has successfully been processed, its status will transition to active and will be available to receive payments. Accounts in processing will not have capabilities.

capabilities

enum

Capabilities of the account

The following are possible capabilities an account can have. This indicates if an account is capable of receiving money (as a destination) or sending money (as a source).
ℹ️ ACH accounts, require an additional verification step to start sending money.
Possible enum values

payments:receive

The account can be used as a payment destination.

payments:send

The account can be used as a payment source.

data:retrieve

The account has additional liability information from Method Data.

data:sync

The account has enhanced data and live data refresh from FI via Method Sync.

error

object,null
An object representing an error that occurred while processing this account. See account errors.

created_at

string
Timestamp of when the account was created.

updated_at

string
Timestamp of when the account was last updated.
{
  "id": "acc_b9q2XVAnNFbp3",
  "holder_id": "ent_y1a9e1fbnJ1f3",
  "type": "ach",
  "ach": {
    "routing": "367537407",
    "number": "57838927",
    "type": "checking"
  },
  "liability": null,
  "clearing": null,
  "metadata": null,
  "status": "active",
  "capabilities": [
    "payments:receive"
  ],
  "error": null,
  "created_at": "2020-12-09T00:40:51.107Z",
  "updated_at": "2020-12-09T00:40:51.107Z"
}