Core Exchange v5.3 API Reference

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.

In: path

`200 OK`

Contact information for the account.

holders

required[object]

Owners of the account. Note that while the FDX specification enables associating holders and their contact information in the full AccountHolder schema, Plaid doesn't consume these associations. Instead, Plaid consumes limited information for each AccountHolder and doesn't associate contact information such as emails, addresses, or telephone numbers to account holders. For more information about Plaid's data model for account contact information, see Identity.

Min items: 1

name

requiredobject

First name, middle initial, last name, suffix fields.

first

requiredstring

First name

middle

string

Middle initial

last

requiredstring

Last name

suffix

string

Generational or academic suffix

prefix

string

Name prefix, e.g. Mr.

relationship

string

Customer's relationship to the account

Possible values: AUTHORIZED_USER, BUSINESS, FOR_BENEFIT_OF, FOR_BENEFIT_OF_PRIMARY, FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED, FOR_BENEFIT_OF_SECONDARY, FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED, FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED, POWER_OF_ATTORNEY, PRIMARY_JOINT_TENANTS, PRIMARY, PRIMARY_BORROWER, PRIMARY_JOINT, SECONDARY, SECONDARY_JOINT_TENANTS, SECONDARY_BORROWER, SECONDARY_JOINT, SOLE_OWNER, TRUSTEE, UNIFORM_TRANSFER_TO_MINOR

emails

required[string]

Email addresses associated with the account.

Min items: 1

addresses

required[object]

Physical mail addresses associated with the account.

Min items: 1

line1

requiredstring

Address line 1

Max length: 64

line2

string

Address line 2

Max length: 64

line3

string

Address line 3

Max length: 64

city

requiredstring

City

Max length: 64

region

string

State or province or territory.

Max length: 64

postalCode

string

Postal code

Max length: 16

country

requiredstring

Country code

Possible values: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

telephones

required[object]

Telephone numbers associated with the account.

Min items: 1

type

requiredstring

Type of phone number: HOME, BUSINESS, CELL, FAX

Possible values: HOME, BUSINESS, CELL, FAX

country

string

Country calling codes defined by ITU-T recommendations E.123 and E.164

Max length: 3

number

requiredstring

Telephone subscriber number defined by ITU-T recommendation E.164

Max length: 15

Pattern: \d+

API Object
1{
"holders": [
  {
    "relationship": "SECONDARY",
    "name": {
      "first": "Ernest",
      "middle": "Miller",
      "last": "Hemingway",
      "suffix": "IV"
    }
  },
  {
    "relationship": "PRIMARY_JOINT",
    "name": {
      "first": "Maya",
      "last": "Angelou",
      "middle": "Annie"
    }
  }
],
"emails": [
  "ernest.m.hemingway@domain.tld",
  "m.angelou@domain.tld"
],
"addresses": [
  {
    "line1": "1850 N Clark St",
    "line2": "Apartment 103",
    "city": "Chicago",
    "region": "IL",
    "postalCode": "60614",
    "country": "US"
  },
  {
    "line1": "2014 N Main St",
    "city": "San Francisco",
    "region": "CA",
    "postalCode": "94105",
    "country": "US"
  }
],
"telephones": [
  {
    "type": "HOME",
    "country": "1",
    "number": "3127771926"
  },
  {
    "type": "CELL",
    "country": "53",
    "number": "45915607"
  },
  {
    "type": "HOME",
    "country": "1",
    "number": "4157771926"
  }
]
59}

Was this helpful?

Error responses

HTTP status code	FDX error code	Example message	Example debug message
401	602	Customer not authorized	Authenticated customer does not have the authorization to perform this action
404	601	Customer not found	A customer with the provided customer ID could not be found
404	701	Account not found	An account with the provided account ID could not be found
409	705	Account is closed	Operation is not supported by the closed account
422	704	Account type not supported	The account type does not support the selected action
500	500	Internal server error	Provider custom developer-level error details for troubleshooting
500	501	Subsystem unavailable	A system required to process the request was not available. Request was not processed
503	503	Scheduled maintenance	System is down for maintenance. Retry-After HTTP header may be used to communicate estimated time of recovery

/accounts

List all accounts

Search and view customer accounts

accounts

Request fields

string

Plaid receives this value from your organization's latest response in a paginated response, and returns it to in a new request to get the next page. Your organization omits nextOffset in the response to indicate the last page.

In: query

integer

Number of elements that the API consumer wishes to receive. Plaid has a default limit of 100 elements. If this value differs from your organization's limit for the number of items to send in one response, then pick the lower of the two different limits and use the lower limit to define the number of items you send on each page of a paginated response. Plaid then gets the next page by making a new request with the opaque nextOffset field that your organization returned in the latest response, until your organization omits nextOffset in the response to indicate the last page.

In: query

200 OK

accounts

Response fields and example

page

object

Contains opaque identifier, nextoffset, for paginated result sets. The nextOffset ID doesn't need to be numeric or have any specific pattern. In other words, your organization can implement this however you prefer. The presence of this offset indicates that there's at least one more page of data available. The absence of this offset indicates that there are no more pages of data left in this paginated array. The API consumer returns this in the offset parameter in a new request to get the next page in the response array.

string

Opaque offset identifier.

accounts

required[object]

An array of accounts. May include accounts of any of the following types: deposit, investment, line of credit, loan
Note: Each object in the accounts array is expected to contain at least one account type.

Min items: 1

API Object
1{
"page": {
  "nextOffset": 25
},
"accounts": [
  {
    "depositAccount": {
      "accountId": "depositAccount0000001",
      "accountType": "CHECKING",
      "accountNumberDisplay": "5820",
      "productName": "Checking",
      "nickname": "Main Checking",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    }
  },
  {
    "loanAccount": {
      "accountId": "loanAccount0000001",
      "accountType": "LOAN",
      "accountNumberDisplay": "4704",
      "productName": "Loan",
      "nickname": "Primary Loan",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    }
  },
  {
    "locAccount": {
      "accountId": "locAccount0000001",
      "accountType": "LINEOFCREDIT",
      "accountNumberDisplay": "8200",
      "productName": "Line of Credit",
      "nickname": "First plaidypus LOC",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    }
  },
  {
    "investmentAccount": {
      "accountId": "investmentAccount0000001",
      "accountType": "TAXABLE",
      "accountNumberDisplay": "1050",
      "productName": "Brokerage Account",
      "nickname": "First plaidypus Brokerage",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    }
  }
]
59}

Was this helpful?

Error responses

HTTP status code	FDX error code	Example message	Example debug message
404	601	Customer not found	A customer with the provided customer ID could not be found
500	500	Internal server error	Provider custom developer-level error details for troubleshooting
500	501	Subsystem unavailable	A system required to process the request was not available. Request was not processed
503	503	Scheduled maintenance	System is down for maintenance. Retry-After HTTP header may be used to communicate estimated time of recovery

/accounts/{accountId}

Get account balances and liabilities

Get account balances, liabilities, and other information. Plaid uses this endpoint to:

Get account balances for deposit accounts. For example, CHECKING or SAVINGS. For more information about how Plaid uses this information, see Plaid Balance API.
Get account liabilities for STUDENTLOAN, MORTGAGE, and CREDITCARD loan accounts. For more information about how Plaid uses this information, see Plaid Liabilities API.
Get balances and holdings for investment accounts. For more information about how Plaid uses this information, see Plaid Investments API.

See the response schema below for a full list of possible parameters for each account type.

accounts/{accountId}

Request fields

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.

In: path

200 OK

A 200 response will return one of the following type of accounts:

Full details of a deposit account. Plaid consumes the same information for all types of deposit accounts. Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "currentBalance": 192.00.
The accountType field for deposit accounts may be set to any of the account types listed below.

depositAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: CHECKING, SAVINGS, CD, ESCROW, MONEYMARKET, OTHERDEPOSIT

requirednumber

Current balance of the deposit account

availableBalance

requirednumber

Available balance of the deposit account

API Object
1{
"depositAccount": {
  "accountId": "someLongTermUniqueIDString",
  "accountNumberDisplay": "4321",
  "productName": "string",
  "nickname": "string",
  "status": "CLOSED",
  "currency": {
    "currencyCode": "AED"
  },
  "accountType": "CHECKING",
  "currentBalance": 0,
  "availableBalance": 0
}
15}

Was this helpful?

Error responses

HTTP status code	FDX error code	Example message	Example debug message
401	602	Customer not authorized	Authenticated customer does not have the authorization to perform this action
404	701	Account not found	An account with the provided account ID could not be found
409	705	Account is closed	Operation is not supported by the closed account
422	704	Account type not supported	The account type does not support the selected action
500	500	Internal server error	Provider custom developer-level error details for troubleshooting
500	501	Subsystem unavailable	A system required to process the request was not available. Request was not processed
503	503	Scheduled maintenance	System is down for maintenance. Retry-After HTTP header may be used to communicate estimated time of recovery

/accounts/{accountId}/statements

Search for statements

Get account statements.
Example: GET /accounts/{accountId}/statements?startTime=value1&endTime=value2

accounts/{accountId}/statements

Request fields

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.

In: path

startTime

string

Start time for use in retrieval of elements (ISO 8601). For transactions, Plaid expects this to filter by the postedTimestamp.

Format: date

Max length: 10

In: query

endTime

string

End time for use in retrieval of elements (ISO 8601). For transactions, Plaid expects this to filter by the postedTimestamp.

Format: date

Max length: 10

In: query

string

In: query

integer

In: query

200 OK

accounts/{accountId}/statements

Response fields and example

page

object

string

Opaque offset identifier.

statements

required[object]

An array of statements, each with its own HATEOAS link to retrieve the account statement

string

Corresponds to accountId in Account entity

Max length: 256

statementId

string

Long-term persistent identity of the statement

Max length: 256

statementDate

string

Date of the statement

Format: date

Max length: 10

string

Description of the statement

links

[object]

The HATEOAS links to retrieve this account statement, or to invoke other APIs.
Note: Plaid only accepts one link object in this array.

href

requiredstring

The resource URL

Format: uri-reference

action

string

The HTTP method to use for the request

Possible values: GET, POST, PATCH, DELETE, PUT

rel

string

The relation of this link to its containing entity, as defined by the IETF RFC5988

types

[string]

The content-types that can be used in the Accept header. Note: Plaid currently only accepts the PDF (application/pdf) content type.

Possible values: application/pdf, image/gif, image/jpeg, image/tiff, image/png, application/json

string

Availability status of statement

API Object
1{
"page": {
  "nextOffset": "2",
  "total": 3
},
"statements": [
  {
    "accountId": "10001",
    "statementId": "20001",
    "links": [
      {
        "href": "/accounts/1111/statements?offSet=2&limit=10"
      }
    ]
  }
]
17}

Was this helpful?

/accounts/{accountId}/statements/{statementId}

Get account statement

Get account statement PDF.

accounts/{accountId}/statements/{statementId}

Request fields

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.

In: path

statementId

string

Statement identifier, found in the GET /accounts/{accountId}/statements endpoint response.

In: path

200 OK

A 200 response will return a PDF account statement.

/accounts/{accountId}/transactions

List all account transactions

List all account transactions. Plaid always queries this endpoint a startTime and an endTime, for example, /accounts/{accountId}/transactions?startTime=2022-01-30&endTime=2022-05-30, and expects the time filters to be based on the postedTimestamp.
Plaid consumes data from this endpoint for the following account types only:

Loan
Investment
Deposit
Line of credit (LOC)

accounts/{accountId}/transactions

Request fields

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.

In: path

startTime

string

Start time for use in retrieval of elements (ISO 8601). For transactions, Plaid expects this to filter by the postedTimestamp.

Format: date

Max length: 10

In: query

endTime

string

End time for use in retrieval of elements (ISO 8601). For transactions, Plaid expects this to filter by the postedTimestamp.

Format: date

Max length: 10

In: query

string

In: query

integer

In: query

200 OK

accounts/{accountId}/transactions

Response fields and example

page

object

string

Opaque offset identifier.

transactions

requiredarray

An array of transactions. The transactionType is dependent on the account type. Plaid consumes the following types of transactions: investment, deposit, loan, and line of credit
Plaid expects your organization to return an empty array if this information isn't available.

API Object
1{
"page": {
  "nextOffset": "2"
},
"transactions": [
  {
    "depositTransaction": {
      "checkNumber": 1234,
      "payee": "ACME llc",
      "transactionId": "depositTransaction000000001",
      "postedTimestamp": "2022-04-06T00:00:00.000Z",
      "transactionTimestamp": "2022-04-05T00:00:00.000Z",
      "description": "check for latest ACME invoice",
      "debitCreditMemo": "DEBIT",
      "status": "PENDING",
      "amount": 400
    }
  },
  {
    "depositTransaction": {
      "transactionId": "depositTransaction000000002",
      "postedTimestamp": "2022-04-07T00:00:00.000Z",
      "transactionTimestamp": "2022-04-07T00:00:00.000Z",
      "description": "reconciliation/adjustment of bank statement error",
      "debitCreditMemo": "DEBIT",
      "status": "POSTED",
      "amount": 0.8
    }
  }
]
31}

Was this helpful?

Error responses

HTTP status code	FDX error code	Example message	Example debug message
401	602	Customer not authorized	Authenticated customer does not have the authorization to perform this action
404	701	Account not found	An account with the provided account ID could not be found
409	705	Account is closed	Operation is not supported by the closed account
422	704	Account type not supported	The account type does not support the selected action
500	500	Internal server error	Provider custom developer-level error details for troubleshooting
500	501	Subsystem unavailable	A system required to process the request was not available. Request was not processed
503	503	Scheduled maintenance	System is down for maintenance. Retry-After HTTP header may be used to communicate estimated time of recovery

/accounts/{accountId}/payment-networks

Get payment networks supported by the account

Get payment networks supported by an account, for example ACH (Automated Clearing House). For more information about how Plaid uses this information, see the Plaid Auth API.

accounts/{accountId}/payment-networks

Request fields

string

Account identifier, found in the GET /accounts endpoint response. Plaid expects the ID to be a different value from the account number.
Note: If the status of the accountId provided is RESTRICTED, you can send a 200 response with an empty body to indicate that no payment networks are available at this time.

In: path

string

In: query

integer

In: query

200 OK

accounts/{accountId}/payment-networks

Response fields and example

page

object

string

Opaque offset identifier.

paymentNetworks

required[object]

bankId

requiredstring

Bank identifier used by the payment network ie. Routing Number

identifier

requiredstring

The number used to identify the account within the payment network.

type

requiredstring

Suggested values for Payment Network Type. US_ refers to the USA, and CA_ refers to Canada.

Value	Description
CA_ACSS	Automated Clearing House Settlement System
CA_LVTS	Large-Value Transfer System
US_ACH	Automated Clearing House, also called Fed ACH network (mostly small banks)
US_CHIPS	Clearinghouse Interbank Payments System. Also called Clearing House ACH network (primarily big banks)
US_FEDWIRE	Fedwire Funds Service.
US_RTP	US Real Time Payments System.

Possible values: US_ACH, US_FEDWIRE, US_CHIPS, US_RTP, CA_ACSS, CA_LVTS

transferIn

requiredboolean

Can transfer funds to the account using this information. Plaid expect that this value represents the account's current ability to be credited through a payment network. Plaid recommends dynamically updating this value, for example to represent if the account is locked or not.
Note: Both transferIn and transferOut must be true in order for the account to support ACH.

transferOut

requiredboolean

Can transfer funds from the account using this information. Plaid expect that this value represents the account's current ability to be debited through a payment network. Plaid recommends dynamically updating this value, for example to represent if the account is locked or not.
Note: Both transferIn and transferOut must be true in order for the account to support ACH.

API Object
1{
"page": {
  "nextOffset": 25
},
"paymentNetworks": [
  {
    "bankId": "010088889",
    "identifier": "1111222233335820",
    "type": "US_ACH",
    "transferIn": true,
    "transferOut": true
  }
]
14}

Was this helpful?

Error responses

HTTP status code	FDX error code	Example message	Example debug message
401	602	Customer not authorized	Authenticated customer does not have the authorization to perform this action
404	701	Account not found	An account with the provided account ID could not be found
409	705	Account is closed	Operation is not supported by the closed account
500	500	Internal server error	Provider custom developer-level error details for troubleshooting
500	501	Subsystem unavailable	A system required to process the request was not available. Request was not processed
503	503	Scheduled maintenance	System is down for maintenance. Retry-After HTTP header may be used to communicate estimated time of recovery

Data definitions

Accounts

Account objects contain full details of each account type. (Note: Account objects differ from account descriptors, which are lightweight objects that contain minimally necessary account details.) The Core Exchange API supports the following accounts types:

Deposit account

depositAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: CHECKING, SAVINGS, CD, ESCROW, MONEYMARKET, OTHERDEPOSIT

requirednumber

Current balance of the deposit account

availableBalance

requirednumber

Available balance of the deposit account

API Object
1{
"depositAccount": {
  "accountId": "someLongTermUniqueIDString",
  "accountNumberDisplay": "4321",
  "productName": "string",
  "nickname": "string",
  "status": "CLOSED",
  "currency": {
    "currencyCode": "AED"
  },
  "accountType": "CHECKING",
  "currentBalance": 0,
  "availableBalance": 0
}
15}

Was this helpful?

Investment account

The type of investment account. For example, a 401K or IRA. Plaid consumes the same details for all investment accounts. The accountType field for investment accounts may be set to any of the account types listed below.

investmentAccount

object

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: 401A, 401K, 403B, 529, BROKERAGEPRODUCT, COVERDELL, DIGITALASSET, DEFINEDBENEFIT, ESOP, GUARDIAN, INSTITUTIONALTRUST, IRA, KEOGH, NONQUALIFIEDPLAN, OTHERINVESTMENT, ROLLOVER, ROTH, SARSEP, TAXABLE, TDA, TRUST, TERM, UGMA, UTMA

availableCashBalance

requirednumber

Cash balance across all sub-accounts. Plaid expects that this includes sweep funds.

balanceAsOf

string

As-of date of balances.
ISO 8601 date-time in format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] according to IETF RFC3339

Format: date-time

currentValue

requirednumber

Total current value of all investments.

holdings

[object]

Holdings in the investment account. Plaid maps the holding and the investmentAccount FDX models to its securities models, which hold universal information like the ticker symbol, and to its holdings models, which hold account-specific information like balances. For more information, see Plaid investments.

securityId

string

If you return the securityId for a holding, Plaid uses it to look up the closing price from NYSE Group Security Master. If you don't return securityId for a holding that uses security IDs (not recommended), Plaid uses the unitPrice as the closing price. This field, along with securityIdType are required unless symbol is provided. Note: If securityId is provided, securityIdType is required.

securityIdType

string

Plaid consumes solely CUSIP, ISIN, and SEDOL. This field, along with securityId are required unless symbol is provided. Note: If securityIdType is provided, securityId is required.

Possible values: CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN

holdingName

string

Holding name or security name

holdingType

string

Plaid maps the holding type to the Plaid security type. Plaid expects you to return OTHER and set the holdingSubType to indicate cash-type holdings (CASH, MONEYMARKET).

Possible values: ANNUITY, BOND, CD, DIGITALASSET, MUTUALFUND, OPTION, OTHER, STOCK

holdingSubType

string

MONEYMARKET, CASH

Possible values: CASH, MONEYMARKET

symbol

string

Ticker / Market symbol This field is required unless both securityId and securityIdType are provided.

purchasedPrice

number

Price of holding at the time of purchase. Plaid determines an approximate cost basis using the purchase price and the number of units. Plaid cannot take fees into account to determine the cost basis because the FDX holding schema doesn't include fees.

currentUnitPrice

number

Current unit price. Plaid uses this as the institution_price. Plaid falls back to using this as the close price if you don't return securityId for holdings involving securities.

currentUnitPriceDate

string

Current unit price as of date

Format: date

Max length: 10

units

number

Plaid requires this field for holdings and transactions involving securities. For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.
Note: This field is required if the transaction involves a security.

marketValue

requirednumber

Market value at the time of data retrieved

faceValue

number

Required for bonds. Face value at the time of data retrieved. If this isn't present, Plaid assumes the holding isn't a bond and falls back to marketValue.

cashAccount

requiredboolean

If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account. If you don't set a value for isCashEquivalent in the fiAttributes array, then Plaid uses cashAccount in determining the is_cash_equivalent status.

object

Currency information if it is different from Account entity.

requiredstring

ISO 4217 currency code

fiAttributes

[object]

Array of financial institution-specific attributes. Plaid recommends including a value for is_cash_equivalent property in this array. Plaid accepts isCashEquivalent as the attribute name and a string value of true or false. If you return a value for isCashEquivalent, then return the same value for cashAccount as a boolean.

name

string

The attribute's name

value

string

The attribute's value

API Object
1{
"investmentAccount": {
  "accountId": "investmentAccount0000001",
  "accountType": "TAXABLE",
  "accountNumberDisplay": "1050",
  "productName": "Brokerage Account",
  "nickname": "First plaidypus Brokerage",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  },
  "availableCashBalance": 4302.39,
  "balanceAsOf": null,
  "currentValue": 4302.39,
  "holdings": [
    {
      "securityId": "string",
      "securityIdType": "CINS",
      "holdingName": "string",
      "holdingType": "ANNUITY",
      "holdingSubType": "CASH",
      "symbol": "MTSN",
      "purchasedPrice": 12.5,
      "currentUnitPrice": 34.2,
      "currentUnitPriceDate": "2024-07-15",
      "units": 100,
      "marketValue": 3400,
      "faceValue": 3400,
      "cashAccount": true,
      "currency": {
        "currencyCode": "AED"
      },
      "fiAttributes": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}
42}

Was this helpful?

Loan account

Full details of a loan account. The accountType field for loan accounts may be set to any of the account types listed below.
Plaid only consumes the MORTGAGE and STUDENTLOAN types for its Liabilities API. For other loan account types Plaid consumes account details and transactions. Plaid consumes all loan account information as returned in the GET /accounts endpoint, as well as the additional information listed below:
Required for all loan accounts:

principalBalance
interestRate
interestRateType

Optional fields for STUDENTLOAN accounts:

interestPaidYearToDate
lastPaymentAmount
lastPaymentDate
maturityDate
nextPaymentDate
originalPrincipal
originatingDate

Required for MORTGAGE accounts:

accountNumber

Optional fields for MORTGAGE accounts:

escrowBalance
interestPaidYearToDate
lastPaymentAmount
lastPaymentDate
loanTerm
maturityDate
nextPaymentAmount
nextPaymentDate
originalPrincipal
originatingDate

Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "escrowBalance": 192.00.

loanAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: AUTOLOAN, HOMEEQUITYLOAN, INSTALLMENT, LOAN, MILITARYLOAN, MORTGAGE, PERSONALLOAN, SMBLOAN, STUDENTLOAN

accountNumber

string

Full account number for the end user's handle for the account at the owning institution Required for accountType 'MORTGAGE'

requirednumber

Principal balance of loan

escrowBalance

number

Escrow balance of loan

originalPrincipal

number

Original principal of loan

originatingDate

string

Loan origination date

Format: date

Max length: 10

loanTerm

integer

Term of loan in months

number

Amount of next payment

string

Date of next payment

Format: date

Max length: 10

number

Last payment amount

string

Last payment date

Format: date

Max length: 10

maturityDate

string

Maturity date

Format: date

Max length: 10

interestPaidYearToDate

number

Interest paid year to date

interestRate

requirednumber

The account's interest rate

interestRateType

requiredstring

Specifies whether an interest rate is fixed or variable. This information is helpful for personal financial planning and advising. For example, it affects the potential benefits of refinancing, and informs whether a mortgage payment is expected to change in the future

Possible values: FIXED, VARIABLE

API Object
1{
"loanAccount": {
  "accountId": "someLongTermUniqueIDString",
  "accountNumberDisplay": "4321",
  "productName": "string",
  "nickname": "string",
  "status": "CLOSED",
  "currency": {
    "currencyCode": "AED"
  },
  "accountType": "AUTOLOAN",
  "accountNumber": "string",
  "principalBalance": 0,
  "escrowBalance": 0,
  "originalPrincipal": 0,
  "originatingDate": "2021-07-15",
  "loanTerm": 0,
  "nextPaymentAmount": 0,
  "nextPaymentDate": "2021-07-15",
  "lastPaymentAmount": 0,
  "lastPaymentDate": "2021-07-15",
  "maturityDate": "2021-07-15",
  "interestPaidYearToDate": 0,
  "interestRate": 0,
  "interestRateType": "FIXED"
}
27}

Was this helpful?

Line of credit account

Full details of a line of credit account. The accountType field for line of credit accounts may be set to any of the account types listed below.
Plaid may consume all the parameters returned by the GET /accounts endpoint:

availableCredit
creditLine
currentBalance

Additionally, for the CREDITCARD accountType, Plaid consumes the previous information plus the following for its liabilities product:

advancesApr
lastPaymentAmount
lastPaymentDate
lastStmtBalance
lastStmtDate
minimumPaymentAmount
nextPaymentDate
purchasesApr

Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "currentBalance": 192.00.

locAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: LINEOFCREDIT, CHARGE, CREDITCARD, HOMELINEOFCREDIT

creditLine

number

Credit limit

availableCredit

number

Available credit. Required for all accountTypes except for CHARGE

number

Amount of next payment

string

Due date of next payment

Format: date

Max length: 10

number

Principal balance

requirednumber

Current balance of the line of credit

minimumPaymentAmount

number

Minimum payment amount

number

Last payment amount

string

Last payment date

Format: date

Max length: 10

pastDueAmount

number

Amount owed that the account holder failed to pay on the due date

lastStmtBalance

number

Last statement balance

lastStmtDate

string

Last statement date

Format: date

Max length: 10

purchasesApr

number

Purchases APR

advancesApr

number

Advances APR

API Object
1{
"locAccount": {
  "accountId": "loc_01_creditcard",
  "accountNumberDisplay": "8200",
  "productName": "First Plaidypus Credit Card",
  "nickname": "my travel rewards card",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  },
  "minimumPaymentAmount": 100,
  "lastPaymentAmount": 400,
  "lastPaymentDate": "2022-03-30",
  "pastDueAmount": 0,
  "lastStmtBalance": 400,
  "lastStmtDate": "2022-03-25",
  "purchasesApr": 10.25,
  "advancesApr": 15.75,
  "currentBalance": 375,
  "availableCredit": 625,
  "accountType": "CREDITCARD"
}
23}

Was this helpful?

Account descriptors

Annuity account descriptor

The type of annuity account. For example, fixed or variable. The accountType field for annuity accounts may be set to any of the account types listed below.

annuityAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: ANNUITY, FIXEDANNUITY, VARIABLEANNUITY

API Object
1{
"annuityAccount": {
  "accountId": "annuityAccount0000001",
  "accountType": "FIXEDANNUITY",
  "accountNumberDisplay": "53901",
  "productName": "Fixed Annuity",
  "nickname": "Fixed annuity 1",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Commercial account descriptor

A commercial account. For example, a business deposit account. The accountType field for commercial accounts may be set to any of the account types listed below.

commercialAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: COMMERCIALDEPOSIT, COMMERCIALINVESTMENT, COMMERCIALLOAN, COMMERCIALLINEOFCREDIT

API Object
1{
"commercialAccount": {
  "accountId": "commercialAccount0000001",
  "accountType": "COMMERCIALLOAN",
  "accountNumberDisplay": "230014",
  "productName": "Commercial Loan",
  "nickname": "Loan 1",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Deposit account descriptor

depositAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: CHECKING, SAVINGS, CD, ESCROW, MONEYMARKET, OTHERDEPOSIT

API Object
1{
"depositAccount": {
  "accountId": "depositAccount0000001",
  "accountType": "CHECKING",
  "accountNumberDisplay": "5820",
  "productName": "Checking",
  "nickname": "Main Checking",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Insurance account descriptor

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: LONGTERMDISABILITY, SHORTTERMDISABILITY, UNIVERSALLIFE, WHOLELIFE

API Object
1{
"insuranceAccount": {
  "accountId": "insuranceAccount0000001",
  "accountType": "LONGTERMDISABILITY",
  "accountNumberDisplay": "5820",
  "productName": "Long-term disability",
  "nickname": "Long term",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Investment account descriptor

investmentAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

API Object
1{
"investmentAccount": {
  "accountId": "investmentAccount0000001",
  "accountType": "TAXABLE",
  "accountNumberDisplay": "1050",
  "productName": "Brokerage Account",
  "nickname": "First plaidypus Brokerage",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Loan account descriptor

principalBalance
interestRate
interestRateType

Optional fields for STUDENTLOAN accounts:

interestPaidYearToDate
lastPaymentAmount
lastPaymentDate
maturityDate
nextPaymentDate
originalPrincipal
originatingDate

Required for MORTGAGE accounts:

accountNumber

Optional fields for MORTGAGE accounts:

escrowBalance
interestPaidYearToDate
lastPaymentAmount
lastPaymentDate
loanTerm
maturityDate
nextPaymentAmount
nextPaymentDate
originalPrincipal
originatingDate

Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "escrowBalance": 192.00.

loanAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: AUTOLOAN, HOMEEQUITYLOAN, INSTALLMENT, LOAN, MILITARYLOAN, MORTGAGE, PERSONALLOAN, SMBLOAN, STUDENTLOAN

accountNumber

string

Full account number for the end user's handle for the account at the owning institution Required for accountType 'MORTGAGE'

requirednumber

Principal balance of loan

escrowBalance

number

Escrow balance of loan

originalPrincipal

number

Original principal of loan

originatingDate

string

Loan origination date

Format: date

Max length: 10

loanTerm

integer

Term of loan in months

number

Amount of next payment

string

Date of next payment

Format: date

Max length: 10

number

Last payment amount

string

Last payment date

Format: date

Max length: 10

maturityDate

string

Maturity date

Format: date

Max length: 10

interestPaidYearToDate

number

Interest paid year to date

interestRate

requirednumber

The account's interest rate

interestRateType

requiredstring

Possible values: FIXED, VARIABLE

API Object
1{
"loanAccount": {
  "accountId": "loanAccount0000001",
  "accountType": "LOAN",
  "accountNumberDisplay": "4704",
  "productName": "Loan",
  "nickname": "Primary Loan",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  }
}
13}

Was this helpful?

Line of credit account descriptor

availableCredit
creditLine
currentBalance

Additionally, for the CREDITCARD accountType, Plaid consumes the previous information plus the following for its liabilities product:

advancesApr
lastPaymentAmount
lastPaymentDate
lastStmtBalance
lastStmtDate
minimumPaymentAmount
nextPaymentDate
purchasesApr

Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "currentBalance": 192.00.

locAccount

requiredobject

This descriptor provides minimal information about the account for use in lightweight arrays.
Note: This object may contain fewer fields than the full account object.

requiredstring

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Max length: 256

string

Account display number for the end user's handle at the owning financial institution. Plaid expects that the last 4 digits of this masked number correspond to the last 4 digits of the account number.

requiredstring

Marketed product name for this account. Used in UIs to assist in account selection

string

Name given by the user. Used in UIs to assist in account selection. Plaid recommends returning this only if the account permits user renaming.

requiredstring

The status of an account.

Possible values: CLOSED, DELINQUENT, NEGATIVECURRENTBALANCE, OPEN, PAID, PENDINGCLOSE, PENDINGOPEN, RESTRICTED

requiredobject

Represents an international currency.

requiredstring

ISO 4217 currency code

requiredstring

The type of an account. Plaid consumes basic balance account information from the accounts/{accountId} endpoint for a subset of the possible account types described in the FDX specification.

Possible values: LINEOFCREDIT, CHARGE, CREDITCARD, HOMELINEOFCREDIT

creditLine

number

Credit limit

availableCredit

number

Available credit. Required for all accountTypes except for CHARGE

number

Amount of next payment

string

Due date of next payment

Format: date

Max length: 10

number

Principal balance

requirednumber

Current balance of the line of credit

minimumPaymentAmount

number

Minimum payment amount

number

Last payment amount

string

Last payment date

Format: date

Max length: 10

pastDueAmount

number

Amount owed that the account holder failed to pay on the due date

lastStmtBalance

number

Last statement balance

lastStmtDate

string

Last statement date

Format: date

Max length: 10

purchasesApr

number

Purchases APR

advancesApr

number

Advances APR

API Object
1{
"locAccount": {
  "accountId": "loc_01_creditcard",
  "accountNumberDisplay": "8200",
  "productName": "First Plaidypus Credit Card",
  "nickname": "my travel rewards card",
  "status": "OPEN",
  "currency": {
    "currencyCode": "USD"
  },
  "accountType": "CREDITCARD"
}
13}

Was this helpful?

Account statuses

See the table below for help in selecting the appropriate account status.

Status	Description
CLOSED	An account that is closed or no longer exists
DELINQUENT	An account with unpaid payments that are past due
NEGATIVECURRENTBALANCE	An account with a current negative balance
PAID	An account that is paid in full
PENDINGCLOSE	An account that is in the process of being closed
PENDINGOPEN	An account that is in the process of being opened
RESTRICTED	An account with restricted access

Account types

Annuity account types

The accountType field for annuity accounts may be set to any of the following:

ANNUITY: A form of insurance or investment entitling the investor to a series of annual sums.
FIXEDANNUITY: A type of insurance contract that promises to pay the buyer a specific, guaranteed interest rate on their contributions to the account.
VARIABLEANNUITY: A type of insurance contract that promises to pay back the buyer based on the performance of an underlying portfolio of mutual funds selected by the buyer.

Commercial account types

The accountType field for accounts may be set to any of the following:

COMMERCIALDEPOSIT: A deposit account for commercial customers, for example a business trust account.
COMMERCIALLOAN: A preset borrowing limit that can be used at any time.
COMMERCIALLINEOFCREDIT: An account with a preset borrowing limit that can be used at any time.
COMMERCIALINVESTMENT: Investment Account for Commercial Customers. e.g. Commercial Brokerage Account.

Deposit account types

The accountType field for deposit accounts may be set to any of the following:

CHECKING: A deposit account held at a financial institution that allows withdrawals and deposits.
SAVINGS: An interest-bearing deposit account held at a bank or other financial institution.
CD: A certificate of deposit (CD) is a product offered by banks and credit unions that provides an interest rate premium in exchange for the customer agreeing to leave a lump-sum deposit untouched for a predetermined period of time.
ESCROW: A contractual arrangement in which a third party (the stakeholder or escrow agent) receives and disburses money or property for the primary transacting parties, with the disbursement dependent on conditions agreed to by the transacting parties.
MONEYMARKET: A deposit account that pays interest based on current interest rates in the money markets.
OTHERDEPOSIT: Use when none of the listed enums apply.

Insurance account types

The accountType field for insurance accounts may be set to any of the following:

LONGTERMDISABILITY: Insurance that replaces a portion of the policyholder's income due to a disability for an extended period of time, usually more than a year.
SHORTTERMDISABILITY: Insurance that replaces a portion of the policyholder's income due to a disability for a short period of time, usually less than a year.
UNIVERSALLIFE: A type of a cash value life insurance where the excess of premium payments above the current cost of insurance is credited to the cash value of the policy, which in turn is credited each month with interest.
WHOLELIFE: Life insurance which is guaranteed to remain in force for the insured's entire lifetime, provided required premiums are paid, or to the maturity date.

Investment account types

The accountType field for investment accounts may be set to any of the following:

401A: An employer-sponsored money-purchase retirement plan that allows dollar or percentage-based contributions from the employer, the employee, or both.
401K: An employer-sponsored defined-contribution pension account defined in subsection 401(k) of the Internal Revenue Code.
403B: A U.S. tax-advantaged retirement savings plan available for public education organizations, some non-profit employers (only Internal Revenue Code 501(c)(3) organizations), cooperative hospital service organizations, and self-employed ministers in the United States.
529: A tax-advantaged savings plan designed to help pay for education.
BROKERAGEPRODUCT: Investment management offered by a licensed brokerage firm that places trades on behalf of the customer, utilizing any number of investment options.
COVERDELL: A trust or custodial account set up in the United States solely for paying qualified education expenses for the designated beneficiary of the account.
DIGITALASSET: An account containing digital assets.
DEFINEDBENEFIT: An employer-sponsored retirement plan where employee benefits are computed using a formula that considers several factors, such as length of employment and salary history.
ESOP: An employee stock ownership plan (ESOP) is an employee benefit plan that gives workers ownership interest in the company.
GUARDIAN: An account of a child in the parent's name, with legal title to the assets in the account, as well as all capital gains and tax liabilities produced from the account belonging to the parent.
INSTITUTIONALTRUST: An institutional trust account.
IRA: An individual retirement account (IRA) is a tax-advantaged account that individuals use to save and invest for retirement.
KEOGH: A tax-deferred pension plan available to self-employed individuals or unincorporated businesses for retirement purposes.
NONQUALIFIEDPLAN: A type of tax-deferred employer-sponsored retirement plan that falls outside of ERISA guidelines.
OTHERINVESTMENT: Use when none of the listed enums apply.
ROLLOVER: An account containing investments rolled over from an employee-sponsored account.
ROTH: An individual retirement account that offers tax-free growth and tax-free withdrawals in retirement.
SARSEP: A simplified employee pension (SEP) plan set up before 1997 that includes a salary reduction arrangement.
TAXABLE: A taxable investment account.
TDA: TreasuryDirect Account.
TRUST: A type of financial account that is opened by an individual and managed by a designated trustee for the benefit of a third party in accordance with agreed-upon terms.
TERM: Life insurance that provides coverage at a fixed rate of payments for a limited period of time.
UGMA: Uniform Gifts to Minors Act account.
UTMA: Uniform Transfers to Minors Act account.

Loan account types

The accountType field for loan accounts may be set to any of the following:

AUTOLOAN: A type of loan used to finance a car purchase.
HOMEEQUITYLOAN: A type of loan in which the borrower uses the equity of his or her home as collateral.
INSTALLMENT: A type of agreement or contract involving a loan that is repaid over time with a set number of scheduled payments.
LOAN: The lending of money by one or more individuals, organizations, or other entities to other individuals, organizations etc.
MILITARYLOAN: A military loan.
MORTGAGE: A type of loan you can use to buy or refinance a home.
PERSONALLOAN: A type of debt that is not protected by a guarantor, or collateralized by a lien on specific assets of the borrower.
SMBLOAN: A small/medium business loan.
STUDENTLOAN: A type of loan designed to help students pay for post-secondary education and the associated fees, such as tuition, books and supplies, and living expenses.

Line of credit account types

The accountType field for line of credit accounts may be set to any of the following:

LINEOFCREDIT: A credit facility extended by a bank or other financial institution to a government, business or individual customer that enables the customer to draw on the facility when the customer needs funds.
CHARGE: An account to which goods and services may be charged on credit.
CREDITCARD: Allows cardholders to borrow funds with which to pay for goods and services with merchants that accept cards for payment.
HOMELINEOFCREDIT: A loan in which the lender agrees to lend a maximum amount within an agreed period, where the collateral is the borrower's equity in their house.

Transactions

Transaction objects

Deposit transaction

Base entity for financial transactions. For monetary amounts, Plaid expects a decimal amount, with two places to represent fractional values of the base currency, for example 101.99.

requiredstring

Long term persistent identity of the transaction (unique to account). Plaid expects that status: PENDING and status: POSTED transactions have different IDs.

Max length: 256

string

For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction

Max length: 256

string

The date and time that the transaction was posted to the account.
This property is required by Plaid when status=POSTED. Plaid expects this property to be omitted when status=PENDING
ISO 8601 date-time in format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] according to IETF RFC3339

Format: date-time

requiredstring

The date and time that the transaction was added to the server backend systems. This acts as postedTimestamp when postedTimestamp is not present (pending transaction).
ISO 8601 date-time in format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] according to IETF RFC3339

Format: date-time

requiredstring

The description of the transaction

requiredstring

The posting type of a transaction. The transaction amount is an absolute value, and this parameter indicates the direction of the transaction. Plaid expects DEBIT or CREDIT for this enum. Plaid expects that your organization indicates the MEMO (i.e., pending) status using the status field in the transaction response rather than this field. If your organization sends MEMO in this DebitCreditMemo enum, Plaid handles this value the same as it handles DEBIT. DEBIT: An amount leaves the account CREDIT: An amount enters the account MEMO: A pending transaction to be completed at the end of this day.

Possible values: CREDIT, DEBIT, MEMO

string

Transaction category, preferably MCC or SIC. Plaid expects your organization to provide MCC, if available and applicable.

string

Transaction category detail

requiredstring

The status of a transaction. Plaid consumes solely the PENDING and POSTED enums, and treats MEMO and AUTHORIZATION as if they were PENDING. Plaid expects that pending and posted transactions have different transactionIds.

AUTHORIZATION
MEMO - A pending transaction to be completed at the end of this day
PENDING - A pending transaction
POSTED - A posted transaction

Possible values: AUTHORIZATION, MEMO, PENDING, POSTED

requirednumber

The amount of money in the account currency. The amount is an absolute value. Plaid relies on the DebitCreditMemo enum to determine the direction (and sign) of the transaction.

number

The amount of money in the foreign currency. If this amount is specified, then Plaid expects that the foreignCurrency property is also set.

string

The ISO 4217 code of the foreign currency

payee

string

Payee name

Max length: 255

checkNumber

integer

Check number. Plaid expects this solely if the transaction involves a check.

API Object
1{
"transactionId": "depositTransaction000000001",
"transactionTimestamp": "2022-04-05T00:00:00.000Z",
"description": "check for latest ACME invoice",
"debitCreditMemo": "DEBIT",
"status": "PENDING",
"amount": 400,
"payee": "Acme LLC",
"checkNumber": 57448
10}

Was this helpful?

Investment transaction

Base entity for financial transactions. For monetary amounts, Plaid expects a decimal amount, with two places to represent fractional values of the base currency, for example 101.99.

requiredstring

Long term persistent identity of the transaction (unique to account). Plaid expects that status: PENDING and status: POSTED transactions have different IDs.

Max length: 256

string

Max length: 256

string

Format: date-time

requiredstring

Format: date-time

requiredstring

The description of the transaction

requiredstring

Possible values: CREDIT, DEBIT, MEMO

string

Transaction category, preferably MCC or SIC. Plaid expects your organization to provide MCC, if available and applicable.

string

Transaction category detail

requiredstring

AUTHORIZATION
MEMO - A pending transaction to be completed at the end of this day
PENDING - A pending transaction
POSTED - A posted transaction

Possible values: AUTHORIZATION, MEMO, PENDING, POSTED

requirednumber

The amount of money in the account currency. The amount is an absolute value. Plaid relies on the DebitCreditMemo enum to determine the direction (and sign) of the transaction.

number

The amount of money in the foreign currency. If this amount is specified, then Plaid expects that the foreignCurrency property is also set.

string

The ISO 4217 code of the foreign currency

transactionType

requiredstring

The type of an investment transaction. Plaid maps these enums to Plaid investment transaction types. Plaid doesn't map these enums to Plaid-specific transaction subtypes. Plaid maps these enums as follows:

ADJUSTMENT - fee
ATM - cash
CASH - cash
CHECK - cash
CLOSURE - Plaid suggests using SOLDTOCLOSE, PURCHASETOCLOSE, OPTIONEXERCISE or OPTIONEXPIRATION to indicate the specific type of closure, instead of using this enum.
CLOSUREOPT - Plaid suggests using SOLDTOCLOSE, PURCHASETOCLOSE, OPTIONEXERCISE or OPTIONEXPIRATION to indicate the specific type of closure, instead of using this enum.
CONTRIBUTION - buy (if transaction involves a security) or cash
DEP - cash
DEPOSIT - cash
DIRECTDEBIT - cash
DIRECTDEP - cash
DIV - cash
DIVIDEND - cash
DIVIDENDREINVEST - buy
EXPENSE - cash
FEE - fee
INCOME - cash
INTEREST - cash
INVEXPENSE - cash
JRNLFUND - transfer
JRNLSEC - transfer
MARGININTEREST - cash
OPTIONEXERCISE - transfer
OPTIONEXPIRATION - transfer
OTHER - cash - (unclassified)
PAYMENT - cash
POS - cash
PURCHASED - buy
PURCHASEDTOCOVER - buy
PURCHASETOCLOSE - buy
PURCHASETOOPEN - buy
REINVESTOFINCOME - buy
REPEATPMT - cash
RETURNOFCAPITAL - cash
SOLD - sell
SOLDTOCLOSE - sell
SOLDTOOPEN - sell
SPLIT - transfer
SRVCHG - fee
TRANSFER - transfer
XFER - transfer

Possible values: ADJUSTMENT, ATM, CASH, CHECK, CLOSURE, CLOSUREOPT, CONTRIBUTION, DEP, DEPOSIT, DIRECTDEBIT, DIRECTDEP, DIV, DIVIDEND, DIVIDENDREINVEST, EXPENSE, FEE, INCOME, INTEREST, INVEXPENSE, JRNLFUND, JRNLSEC, MARGININTEREST, OPTIONEXERCISE, OPTIONEXPIRATION, OTHER, PAYMENT, POS, PURCHASED, PURCHASEDTOCOVER, PURCHASETOCLOSE, PURCHASETOOPEN, REINVESTOFINCOME, REPEATPMT, RETURNOFCAPITAL, SOLD, SOLDTOCLOSE, SOLDTOOPEN, SPLIT, SRVCHG, TRANSFER, XFER

securityId

string

securityIdType

string

Plaid consumes solely CUSIP, ISIN, and SEDOL. This field, along with securityId are required unless symbol is provided. Note: If securityIdType is provided, securityId is required.

Possible values: CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN

securityType

string

STOCK, MUTUALFUND, DEBT, OPTION, SWEEP, OTHER, BOND

Possible values: BOND, DEBT, DIGITALASSET, MUTUALFUND, OPTION, OTHER, STOCK, SWEEP

symbol

string

Ticker symbol.
This field is required unless both securityId and securityIdType are provided.

commission

number

Plaid expects that your organization includes a value for commission if the commission isn't included in fees.

fees

requirednumber

Fees applied to the trade. Plaid expects that the fees include the commission, unless your organization separately provides a value for commission.

unitPrice

number

Unit price. Plaid uses this as the price. Plaid falls back to using this as the close price if you don't return securityId for transactions involving securities.
Note: This field is required if the transaction involves a security.

units

number

unitType

string

SHARES, CURRENCY

Possible values: CURRENCY, SHARES

fiAttributes

[object]

name

string

The attribute's name

value

string

The attribute's value

API Object
1{
"transactionId": "depositTransaction000000001",
"transactionTimestamp": "2022-04-05T00:00:00.000Z",
"description": "check for latest ACME invoice",
"debitCreditMemo": "DEBIT",
"status": "PENDING",
"amount": 400,
"transactionType": "CHECK",
"securityId": "APW881",
"securityIdType": "CMC",
"securityType": "DEBT",
"symbol": "MSFT",
"commission": 0.1,
"unitPrice": 15.3,
"units": 1000,
"unitType": "SHARES",
"fiAttributes": [
  {
    "name": "Vanguard",
    "value": 80
  }
]
23}

Was this helpful?

Loan transaction

Base entity for financial transactions. For monetary amounts, Plaid expects a decimal amount, with two places to represent fractional values of the base currency, for example 101.99.

requiredstring

Long term persistent identity of the transaction (unique to account). Plaid expects that status: PENDING and status: POSTED transactions have different IDs.

Max length: 256

string

Max length: 256

string

Format: date-time

requiredstring

Format: date-time

requiredstring

The description of the transaction

requiredstring

Possible values: CREDIT, DEBIT, MEMO

string

Transaction category, preferably MCC or SIC. Plaid expects your organization to provide MCC, if available and applicable.

string

Transaction category detail

requiredstring

AUTHORIZATION
MEMO - A pending transaction to be completed at the end of this day
PENDING - A pending transaction
POSTED - A posted transaction

Possible values: AUTHORIZATION, MEMO, PENDING, POSTED

requirednumber

The amount of money in the account currency. The amount is an absolute value. Plaid relies on the DebitCreditMemo enum to determine the direction (and sign) of the transaction.

number

The amount of money in the foreign currency. If this amount is specified, then Plaid expects that the foreignCurrency property is also set.

string

The ISO 4217 code of the foreign currency

transactionType

string

The type of a loan transaction. Plaid passes through all loan transaction types.

ADJUSTMENT: Adjustment or correction.
FEE: Fee charge. For example, a late payment fee.
INTEREST: Interest charge.
PAYMENT: Required payment that satisfies the minimum payment (e.g. principal + interest for mortgages).
LUMP_SUM_PAYMENT: A single payment of money, as opposed to a series of payments made over time.
SKIP_PAYMENT: Payment that satisfies deferral of a required payment.
DOUBLE_UP_PAYMENT: Additional payment beyond the required payment to reduce the principal.
PAYOFF: Payment that satisfies the terms of the mortgage loan and completely pays off the debt.

Possible values: ADJUSTMENT, FEE, INTEREST, PAYMENT, LUMP_SUM_PAYMENT, SKIP_PAYMENT, DOUBLE_UP_PAYMENT, PAYOFF

API Object
1{
2  "transactionId": "loanTransaction000000001",
3  "transactionTimestamp": "2022-04-05T00:00:00.000Z",
4  "description": "latest ACME invoice",
5  "debitCreditMemo": "CREDIT",
6  "status": "PENDING",
7  "amount": 400
8}

Was this helpful?

Line of credit transaction

Base entity for financial transactions. For monetary amounts, Plaid expects a decimal amount, with two places to represent fractional values of the base currency, for example 101.99.

requiredstring

Long term persistent identity of the transaction (unique to account). Plaid expects that status: PENDING and status: POSTED transactions have different IDs.

Max length: 256

string

Max length: 256

string

Format: date-time

requiredstring

Format: date-time

requiredstring

The description of the transaction

requiredstring

Possible values: CREDIT, DEBIT, MEMO

string

Transaction category, preferably MCC or SIC. Plaid expects your organization to provide MCC, if available and applicable.

string

Transaction category detail

requiredstring

AUTHORIZATION
MEMO - A pending transaction to be completed at the end of this day
PENDING - A pending transaction
POSTED - A posted transaction

Possible values: AUTHORIZATION, MEMO, PENDING, POSTED

requirednumber

The amount of money in the account currency. The amount is an absolute value. Plaid relies on the DebitCreditMemo enum to determine the direction (and sign) of the transaction.

number

The amount of money in the foreign currency. If this amount is specified, then Plaid expects that the foreignCurrency property is also set.