Processor partner endpoints

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

 
Select Language
1try {
2  const request: ProcessorAccountGetRequest = {
3    processor_token: processorToken,
4  };
5  const response = await plaidClient.ProcessorAccountGet(request);
6} catch (error) {
7  // handle error
8}

processor/account/get

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

institution_id

string

The Plaid Institution ID associated with the Account.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv",
  "balances": {
    "available": 100,
    "current": 110,
    "limit": null,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Checking",
  "subtype": "checking",
  "type": "depository"
},
"institution_id": "ins_109508",
"request_id": "1zlMf"
19}

Was this helpful?

Retrieve Auth data

The /processor/auth/get endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given processor_token. The endpoint also returns high-level account data and balances when available.
Versioning note: API versions 2019-05-29 and earlier use a different schema for the numbers object returned by this endpoint. For details, see Plaid API versioning.

processor/auth/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

Select group for content switcher

 
Select Language
1const request: ProcessorAuthGetRequest = {
2  processor_token: processorToken,
3};
4const response = plaidClient.processorAuthGet(request);

processor/auth/get

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

numbers

object

An object containing identifying numbers used for making electronic transfers to and from the account. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by the account for which auth data has been requested, a null value will be returned.

ach

nullableobject

Identifying information for transferring money to or from a US account via ACH or wire transfer.

string

The Plaid account ID associated with the account numbers

string

The ACH account number for the account.
Note that when using OAuth with Chase Bank (ins_56), Chase will issue "tokenized" routing and account numbers, which are not the user's actual account and routing numbers. These tokenized account numbers (also known as TANs) should work identically to normal account and routing numbers. The digits returned in the mask field will continue to reflect the actual account number, rather than the tokenized account number; for this reason, when displaying account numbers to the user to help them identify their account in your UI, always use the mask rather than truncating the account number. If a user revokes their permissions to your app, the tokenized numbers will no longer work.

routing

string

The ACH routing number for the account. If the institution is ins_56, this may be a tokenized routing number. For more information, see the description of the account field.

wire_routing

nullablestring

The wire transfer routing number for the account, if available

eft

nullableobject

Identifying information for transferring money to or from a Canadian bank account via EFT.

string

The Plaid account ID associated with the account numbers

string

The EFT account number for the account

institution

string

The EFT institution number for the account

branch

string

The EFT branch number for the account

international

nullableobject

Identifying information for transferring money to or from an international bank account via wire transfer.

string

The Plaid account ID associated with the account numbers

iban

string

The International Bank Account Number (IBAN) for the account

bic

string

The Bank Identifier Code (BIC) for the account

bacs

nullableobject

Identifying information for transferring money to or from a UK bank account via BACS.

string

The Plaid account ID associated with the account numbers

string

The BACS account number for the account

sort_code

string

The BACS sort code for the account

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

API Object
1{
"account": {
  "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
  "balances": {
    "available": 100,
    "current": 110,
    "iso_currency_code": "USD",
    "limit": null,
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Checking",
  "subtype": "checking",
  "type": "depository"
},
"numbers": {
  "ach": {
    "account": "9900009606",
    "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
    "routing": "011401533",
    "wire_routing": "021000021"
  },
  "eft": {
    "account": "111122223333",
    "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
    "institution": "021",
    "branch": "01140"
  },
  "international": {
    "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
    "bic": "NWBKGB21",
    "iban": "GB29NWBK60161331926819"
  },
  "bacs": {
    "account": "31926819",
    "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
    "sort_code": "601613"
  }
},
"request_id": "1zlMf"
42}

Was this helpful?

Retrieve Balance data

The /processor/balance/get endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.

processor/balance/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

min_last_updated_datetime

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

options

object

An optional object to filter /processor/balance/get results.

string

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only necessary when the institution is ins_128026 (Capital One), and the account type is a non-depository account (such as a credit card) in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For all other institutions, as well as for depository accounts at Capital One (including all checking and savings accounts) this field is ignored.
If this field is not ignored, and no acceptable balance is available, an INVALID_RESULT error with the code LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned.

Format: date-time

Select group for content switcher

 
Select Language
1const request: ProcessorBalanceGetRequest = {
2  processor_token: processorToken,
3};
4const response = plaidClient.processorBalanceGet(request);

processor/balance/get

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv",
  "balances": {
    "available": 100,
    "current": 110,
    "limit": null,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Checking",
  "subtype": "checking",
  "type": "depository"
},
"request_id": "1zlMf"
18}

Was this helpful?

Retrieve Identity data

The /processor/identity/get endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.

processor/identity/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

Select group for content switcher

 
Select Language
1const request: ProcessorIdentityGetRequest = {
2  processor_token: processorToken,
3};
4const response = plaidClient.processorIdentityGet(request);

processor/identity/get

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

owners

[object]

Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same owner object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioning

names

[string]

A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's names array.

phone_numbers

[object]

A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

data

string

The phone number.

boolean

When true, identifies the phone number as the primary number on an account.

type

string

The type of phone number.

Possible values: home, work, office, mobile, mobile1, other

emails

[object]

A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

data

string

The email address.

boolean

When true, identifies the email address as the primary email on an account.

type

string

The type of email account as described by the financial institution.

Possible values: primary, secondary, other

addresses

[object]

Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

data

object

Data about the components comprising an address.

city

nullablestring

The full city name

nullablestring

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC"

string

The full street address Example: "564 Main Street, APT 15"

nullablestring

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code

boolean

When true, identifies the address as the primary address on an account.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "XMGPJy4q1gsQoKd5z9R3tK8kJ9EWL8SdkgKMq",
  "balances": {
    "available": 100,
    "current": 110,
    "iso_currency_code": "USD",
    "limit": null,
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Standard 0% Interest Checking",
  "owners": [
    {
      "addresses": [
        {
          "data": {
            "city": "Malakoff",
            "country": "US",
            "postal_code": "14236",
            "region": "NY",
            "street": "2992 Cameron Road"
          },
          "primary": true
        },
        {
          "data": {
            "city": "San Matias",
            "country": "US",
            "postal_code": "93405-2255",
            "region": "CA",
            "street": "2493 Leisure Lane"
          },
          "primary": false
        }
      ],
      "emails": [
        {
          "data": "accountholder0@example.com",
          "primary": true,
          "type": "primary"
        },
        {
          "data": "accountholder1@example.com",
          "primary": false,
          "type": "secondary"
        },
        {
          "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
          "primary": false,
          "type": "other"
        }
      ],
      "names": [
        "Alberta Bobbeth Charleson"
      ],
      "phone_numbers": [
        {
          "data": "1112223333",
          "primary": false,
          "type": "home"
        },
        {
          "data": "1112224444",
          "primary": false,
          "type": "work"
        },
        {
          "data": "1112225555",
          "primary": false,
          "type": "mobile1"
        }
      ]
    }
  ],
  "subtype": "checking",
  "type": "depository"
},
"request_id": "eOPkBl6t33veI2J"
81}

Was this helpful?

Retrieve identity match score

The /processor/identity/match endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.
Fields within the balances object will always be null when retrieved by /identity/match. Instead, use the free /accounts/get endpoint to request balance cached data, or /accounts/balance/get for real-time data.
This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.

processor/identity/match

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

user

object

The user's legal name, phone number, email address and address used to perform fuzzy match. If Financial Account Matching is enabled in the Identity Verification product, leave this field empty to automatically match against PII collected from the Identity Verification checks.

legal_name

string

The user's full legal name.

phone_number

string

The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14151234567". Phone numbers provided in other formats will be parsed on a best-effort basis.

email_address

string

The user's email address.

object

Data about the components comprising an address.

city

string

The full city name

string

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC"

string

The full street address Example: "564 Main Street, APT 15"

string

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

string

The ISO 3166-1 alpha-2 country code

 
Select Language
1const request: ProcessorIdentityMatchRequest = {
2  processor_token: processorToken,
3};
4const response = plaidClient.processorIdentityMatch(request);

processor/identity/match

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

legal_name

nullableobject

Score found by matching name provided by the API with the name on the account at the financial institution. If the account contains multiple owners, the maximum match score is filled.

is_first_name_or_last_name_match

nullableinteger

Match score for name. 100 is a perfect score, 99-85 means a strong match, 84-70 is a partial match, any score less than 70 is a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the name is missing from either the API or financial institution, this is null.

nullableboolean

first or last name completely matched, likely a family member

is_nickname_match

nullableboolean

nickname matched, example Jennifer and Jenn.

is_business_name_detected

deprecatednullableboolean

Is true if the name on either of the names that was matched for the score contained strings indicative of a business name, such as "CORP", "LLC", "INC", or "LTD". A true result generally indicates the entity is a business. However, a false result does not mean the entity is not a business, as some businesses do not use these strings in the names used for their financial institution accounts.

phone_number

nullableobject

Score found by matching phone number provided by the API with the phone number on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.

nullableinteger

Match score for normalized phone number. 100 is a perfect match, 99-70 is a partial match (matching the same phone number with extension against one without extension, etc.), anything below 70 is considered a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the phone number is missing from either the API or financial institution, this is null.

email_address

nullableobject

Score found by matching email provided by the API with the email on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.

nullableinteger

Match score for normalized email. 100 is a perfect match, 99-70 is a partial match (matching the same email with different '+' extensions), anything below 70 is considered a mismatch. Typically, the match threshold should be set to a score of 70 or higher. If the email is missing from either the API or financial institution, this is null.

nullableobject

Score found by matching address provided by the API with the address on the account at the financial institution. The score can range from 0 to 100 where 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.

nullableinteger

Match score for address. 100 is a perfect match, 99-90 is a strong match, 89-70 is a partial match, anything below 70 is considered a weak match. Typically, the match threshold should be set to a score of 70 or higher. If the address is missing from either the API or financial institution, this is null.

is_postal_code_match

nullableboolean

postal code was provided for both and was a match

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
  "balances": {
    "available": null,
    "current": null,
    "iso_currency_code": null,
    "limit": null,
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Standard 0% Interest Checking",
  "legal_name": {
    "score": 90,
    "is_nickname_match": true,
    "is_first_name_or_last_name_match": true,
    "is_business_name_detected": false
  },
  "phone_number": {
    "score": 100
  },
  "email_address": {
    "score": 100
  },
  "address": {
    "score": 100,
    "is_postal_code_match": true
  },
  "subtype": "checking",
  "type": "depository"
},
"request_id": "3nARps6TOYtbACO"
34}

Was this helpful?

Evaluate a planned ACH transaction

Use /processor/signal/evaluate to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If /processor/signal/evaluate is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on item errors and Link in Update Mode.
Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time. To reduce this latency, you can call /signal/prepare on the Item before you need to request Signal data.

processor/signal/evaluate

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

client_transaction_id

requiredstring

The unique ID that you would like to use to refer to this transaction. For your convenience mapping your internal data, you could use your internal ID/identifier for this transaction. The max length for this field is 36 characters.

Min length: 1

Max length: 36

requirednumber

The transaction amount, in USD (e.g. 102.05)

Format: double

user_present

boolean

true if the end user is present while initiating the ACH transfer and the endpoint is being called; false otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).

client_user_id

string

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

is_recurring

boolean

true if the ACH transaction is a recurring transaction; false otherwise

default_payment_method

string

The default ACH or non-ACH payment method to complete the transaction. SAME_DAY_ACH: Same Day ACH by NACHA. The debit transaction is processed and settled on the same day NEXT_DAY_ACH: Next Day ACH settlement for debit transactions, offered by some payment processors STANDARD_ACH: standard ACH by NACHA REAL_TIME_PAYMENTS: real-time payments such as RTP and FedNow DEBIT_CARD: if the default payment is over debit card networks MULTIPLE_PAYMENT_METHODS: if there is no default debit rail or there are multiple payment methods Possible values: SAME_DAY_ACH, NEXT_DAY_ACH, STANDARD_ACH, REAL_TIME_PAYMENTS, DEBIT_CARD, MULTIPLE_PAYMENT_METHODS

user

object

Details about the end user initiating the transaction (i.e., the account holder). When calling /signal/evaluate or /signal/processor/evaluate, this field is optional, but strongly recommended to increase the accuracy of Signal results.

name

object

The user's legal name

prefix

string

The user's name prefix (e.g. "Mr.")

given_name

string

The user's given name. If the user has a one-word name, it should be provided in this field.

middle_name

string

The user's middle name

family_name

string

The user's family name / surname

suffix

string

The user's name suffix (e.g. "II")

phone_number

string

The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14151234567"

email_address

string

The user's email address.

object

Data about the components comprising an address.

city

string

The full city name

string

The region or state Example: "NC"

string

The full street address Example: "564 Main Street, APT 15"

string

The postal code

string

The ISO 3166-1 alpha-2 country code

device

object

Details about the end user's device. When calling /signal/evaluate or /signal/processor/evaluate, this field is optional, but strongly recommended to increase the accuracy of Signal results.

ip_address

string

The IP address of the device that initiated the transaction

user_agent

string

The user agent of the device that initiated the transaction (e.g. "Mozilla/5.0")

/processor/signal/evaluate
Select Language
1const eval_request = {
processor_token: 'processor-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
client_transaction_id: 'txn12345',
amount: 123.45,
client_user_id: 'user1234',
user: {
  name: {
    prefix: 'Ms.',
    given_name: 'Jane',
    middle_name: 'Leah',
    family_name: 'Doe',
    suffix: 'Jr.',
  },
  phone_number: '+14152223333',
  email_address: 'jane.doe@example.com',
  address: {
    street: '2493 Leisure Lane',
    city: 'San Matias',
    region: 'CA',
    postal_code: '93405-2255',
    country: 'US',
  },
},
device: {
  ip_address: '198.30.2.2',
  user_agent:
    'Mozilla/5.0 (iPhone; CPU iPhone OS 13_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1',
},
user_present: true,
30};
31
32try {
const eval_response = await plaidClient.processorSignalEvaluate(eval_request);
const core_attributes = eval_response.data.core_attributes;
const scores = eval_response.data.scores;
36} catch (error) {
// handle error
38}

processor/signal/evaluate

Response fields and example

customer_initiated_return_risk

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

scores

object

Risk scoring details broken down by risk category.

object

The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: "R05", "R07", "R10", "R11", "R29". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.

bank_initiated_return_risk

integer

A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.

Minimum: 1

Maximum: 99

risk_tier

integer

A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return.
In the customer_initiated_return_risk object, there are five risk tiers corresponding to the scores: 1: Predicted customer-initiated return incidence rate between 0.00% - 0.02% 2: Predicted customer-initiated return incidence rate between 0.02% - 0.05% 3: Predicted customer-initiated return incidence rate between 0.05% - 0.1% 4: Predicted customer-initiated return incidence rate between 0.1% - 0.5% 5: Predicted customer-initiated return incidence rate greater than 0.5%

Minimum: 1

Maximum: 5

object

The object contains a risk score and a risk tier that evaluate the transaction return risk because an account is overdrawn or because an ineligible account is used. Common return codes in this category include: "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23". These returns have a turnaround time of 2 banking days.

integer

A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.

Minimum: 1

Maximum: 99

risk_tier

integer

In the bank_initiated_return_risk object, there are eight risk tiers corresponding to the scores: 1: Predicted bank-initiated return incidence rate between 0.0% - 0.5% 2: Predicted bank-initiated return incidence rate between 0.5% - 1.5% 3: Predicted bank-initiated return incidence rate between 1.5% - 3% 4: Predicted bank-initiated return incidence rate between 3% - 5% 5: Predicted bank-initiated return incidence rate between 5% - 10% 6: Predicted bank-initiated return incidence rate between 10% - 15% 7: Predicted bank-initiated return incidence rate between 15% and 50% 8: Predicted bank-initiated return incidence rate greater than 50%

Minimum: 1

Maximum: 8

core_attributes

object

The core attributes object contains additional data that can be used to assess the ACH return risk. Examples of data include:
days_since_first_plaid_connection: The number of days since the first time the Item was connected to an application via Plaid plaid_connections_count_7d: The number of times the Item has been connected to applications via Plaid over the past 7 days plaid_connections_count_30d: The number of times the Item has been connected to applications via Plaid over the past 30 days total_plaid_connections_count: The number of times the Item has been connected to applications via Plaid is_savings_or_money_market_account: Indicates whether the ACH transaction funding account is a savings/money market account
For the full list and detailed documentation of core attributes available, or to request that core attributes not be returned, contact Sales or your Plaid account manager

warnings

[object]

If bank information was not available to be used in the Signal model, this array contains warnings describing why bank data is missing. If you want to receive an API error instead of Signal scores in the case of missing bank data, file a support ticket or contact your Plaid account manager.

warning_type

string

A broad categorization of the warning. Safe for programmatic use.

warning_code

string

The warning code identifies a specific kind of warning that pertains to the error causing bank data to be missing. Safe for programmatic use. For more details on warning codes, please refer to Plaid standard error codes documentation. If you receive the ITEM_LOGIN_REQUIRED warning, we recommend re-authenticating your user by implementing Link's update mode. This will guide your user to fix their credentials, allowing Plaid to start fetching data again for future Signal requests.

warning_message

string

A developer-friendly representation of the warning type. This may change over time and is not safe for programmatic use.

API Object
1{
"scores": {
  "customer_initiated_return_risk": {
    "score": 9,
    "risk_tier": 1
  },
  "bank_initiated_return_risk": {
    "score": 72,
    "risk_tier": 7
  }
},
"core_attributes": {
  "days_since_first_plaid_connection": 510,
  "plaid_connections_count_7d": 6,
  "plaid_connections_count_30d": 7,
  "total_plaid_connections_count": 15,
  "is_savings_or_money_market_account": false
},
"warnings": [],
"request_id": "mdqfuVxeoza6mhu"
21}

Was this helpful?

Retrieve Liabilities data

The /processor/liabilities/get endpoint returns various details about a loan or credit account. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type credit with account subtype credit card or paypal, and account type loan with account subtype student or mortgage.
The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling /processor/liabilities/get.
Note: This request may take some time to complete if liabilities was not specified as an initial product when creating the processor token. This is because Plaid must communicate directly with the institution to retrieve the additional data.

processor/liabilities/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

 
Select Language
1const request: ProcessorLiabilitiesGetRequest = {
2  processor_token: processorToken,
3};
4const response = plaidClient.processorLiabilitiesGet(request);

processor/liabilities/get

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

liabilities

object

An object containing liability accounts

credit

nullable[object]

The credit accounts returned.

last_statement_issue_date

nullablestring

The ID of the account that this liability belongs to.

aprs

[object]

The various interest rates that apply to the account. APR information is not provided by all card issuers; if APR data is not available, this array will be empty.

apr_percentage

number

Annual Percentage Rate applied.

Format: double

apr_type

string

The type of balance to which the APR applies.

Possible values: balance_transfer_apr, cash_apr, purchase_apr, special

balance_subject_to_apr

nullablenumber

Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance.

Format: double

interest_charge_amount

nullablenumber

Amount of money charged due to interest from last statement.

Format: double

is_overdue

nullableboolean

true if a payment is currently overdue. Availability for this field is limited.

last_payment_amount

nullablenumber

The amount of the last payment.

Format: double

last_payment_date

nullablestring

The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). Availability for this field is limited.

Format: date

nullablestring

The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

last_statement_balance

nullablenumber

The total amount owed as of the last statement issued

Format: double

minimum_payment_amount

nullablenumber

The minimum payment due for the next billing cycle.

Format: double

next_payment_due_date

nullablestring

The due date for the next payment. The due date is null if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

mortgage

nullable[object]

The mortgage accounts returned.

origination_principal_amount

string

The ID of the account that this liability belongs to.

account_number

string

The account number of the loan.

current_late_fee

nullablenumber

The current outstanding amount charged for late payment.

Format: double

escrow_balance

nullablenumber

Total amount held in escrow to pay taxes and insurance on behalf of the borrower.

Format: double

has_pmi

nullableboolean

Indicates whether the borrower has private mortgage insurance in effect.

has_prepayment_penalty

nullableboolean

Indicates whether the borrower will pay a penalty for early payoff of mortgage.

interest_rate

object

Object containing metadata about the interest rate for the mortgage.

percentage

nullablenumber

Percentage value (interest rate of current mortgage, not APR) of interest payable on a loan.

Format: double

type

nullablestring

The type of interest charged (fixed or variable).

last_payment_amount

nullablenumber

The amount of the last payment.

Format: double

last_payment_date

nullablestring

The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

loan_type_description

nullablestring

Description of the type of loan, for example conventional, fixed, or variable. This field is provided directly from the loan servicer and does not have an enumerated set of possible values.

loan_term

nullablestring

Full duration of mortgage as at origination (e.g. 10 year).

maturity_date

nullablestring

Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

next_monthly_payment

nullablenumber

The amount of the next payment.

Format: double

next_payment_due_date

nullablestring

The due date for the next payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

origination_date

nullablestring

The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

nullablenumber

The original principal balance of the mortgage.

Format: double

past_due_amount

nullablenumber

Amount of loan (principal + interest) past due for payment.

Format: double

property_address

object

Object containing fields describing property address.

city

nullablestring

The city name.

nullablestring

The ISO 3166-1 alpha-2 country code.

nullablestring

The five or nine digit postal code.

nullablestring

The region or state (example "NC").

nullablestring

The full street address (example "564 Main Street, Apt 15").

ytd_interest_paid

nullablenumber

The year to date (YTD) interest paid.

Format: double

ytd_principal_paid

nullablenumber

The YTD principal paid.

Format: double

student

nullable[object]

The student loan accounts returned.

interest_rate_percentage

nullablestring

The ID of the account that this liability belongs to. Each account can only contain one liability.

account_number

nullablestring

The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).

disbursement_dates

nullable[string]

The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

expected_payoff_date

nullablestring

The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

guarantor

nullablestring

The guarantor of the student loan.

number

The interest rate on the loan as a percentage.

Format: double

is_overdue

nullableboolean

true if a payment is currently overdue. Availability for this field is limited.

last_payment_amount

nullablenumber

The amount of the last payment.

Format: double

last_payment_date

nullablestring

The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

last_statement_issue_date

nullablestring

The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

loan_name

nullablestring

The type of loan, e.g., "Consolidation Loans".

loan_status

object

An object representing the status of the student loan

end_date

nullablestring

The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

type

nullablestring

The status type of the student loan

Possible values: cancelled, charged off, claim, consolidated, deferment, delinquent, discharged, extension, forbearance, in grace, in military, in school, not fully disbursed, other, paid in full, refunded, repayment, transferred, pending idr

minimum_payment_amount

nullablenumber

The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( ins_116861), Firstmark (ins_116295), Commonbond Firstmark Services (ins_116950), Nelnet (ins_116528), EdFinancial Services (ins_116304), Granite State (ins_116308), and Oklahoma Student Loan Authority (ins_116945). Firstmark (ins_116295 ) and Navient (ins_116248) will display as $0 if there is an autopay program in effect.

Format: double

next_payment_due_date

nullablestring

The due date for the next payment. The due date is null if a payment is not expected. A payment is not expected if loan_status.type is deferment, in_school, consolidated, paid in full, or transferred. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

origination_date

nullablestring

The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

origination_principal_amount

nullablenumber

The original principal balance of the loan.

Format: double

outstanding_interest_amount

nullablenumber

The total dollar amount of the accrued interest balance. For Sallie Mae ( ins_116944), this amount is included in the current balance of the loan, so this field will return as null.

Format: double

payment_reference_number

nullablestring

The relevant account number that should be used to reference this loan for payments. In the majority of cases, payment_reference_number will match account_number, but in some institutions, such as Great Lakes (ins_116861), it will be different.

pslf_status

object

Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is FedLoan (ins_116527).

estimated_eligibility_date

nullablestring

The estimated date borrower will have completed 120 qualifying monthly payments. Returned in ISO 8601 format (YYYY-MM-DD).

Format: date

payments_made

nullableinteger

The number of qualifying payments that have been made.

payments_remaining

nullableinteger

The number of qualifying payments remaining.

repayment_plan

object

An object representing the repayment plan for the student loan

description

nullablestring

The description of the repayment plan as provided by the servicer.

type

nullablestring

The type of the repayment plan.

Possible values: extended graduated, extended standard, graduated, income-contingent repayment, income-based repayment, interest-only, other, pay as you earn, revised pay as you earn, standard, saving on a valuable education, null

sequence_number

nullablestring

The sequence number of the student loan. Heartland ECSI (ins_116948) does not make this field available.

servicer_address

object

The address of the student loan servicer. This is generally the remittance address to which payments should be sent.

city

nullablestring

The full city name

nullablestring

The region or state Example: "NC"

nullablestring

The full street address Example: "564 Main Street, APT 15"

nullablestring

The postal code

nullablestring

The ISO 3166-1 alpha-2 country code

ytd_interest_paid

nullablenumber

The year to date (YTD) interest paid. Availability for this field is limited.

Format: double

ytd_principal_paid

nullablenumber

The year to date (YTD) principal paid. Availability for this field is limited.

Format: double

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
  "balances": {
    "available": null,
    "current": 410,
    "iso_currency_code": "USD",
    "limit": 2000,
    "unofficial_currency_code": null
  },
  "mask": "3333",
  "name": "Plaid Credit Card",
  "official_name": "Plaid Diamond 12.5% APR Interest Credit Card",
  "subtype": "credit card",
  "type": "credit"
},
"liabilities": {
  "credit": [
    {
      "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
      "aprs": [
        {
          "apr_percentage": 15.24,
          "apr_type": "balance_transfer_apr",
          "balance_subject_to_apr": 1562.32,
          "interest_charge_amount": 130.22
        },
        {
          "apr_percentage": 27.95,
          "apr_type": "cash_apr",
          "balance_subject_to_apr": 56.22,
          "interest_charge_amount": 14.81
        },
        {
          "apr_percentage": 12.5,
          "apr_type": "purchase_apr",
          "balance_subject_to_apr": 157.01,
          "interest_charge_amount": 25.66
        },
        {
          "apr_percentage": 0,
          "apr_type": "special",
          "balance_subject_to_apr": 1000,
          "interest_charge_amount": 0
        }
      ],
      "is_overdue": false,
      "last_payment_amount": 168.25,
      "last_payment_date": "2019-05-22",
      "last_statement_issue_date": "2019-05-28",
      "last_statement_balance": 1708.77,
      "minimum_payment_amount": 20,
      "next_payment_due_date": "2020-05-28"
    }
  ],
  "mortgage": [],
  "student": []
},
"request_id": "dTnnm60WgKGLnKL"
60}

Was this helpful?

Report whether you initiated an ACH transaction

After calling /processor/signal/evaluate, call /processor/signal/decision/report to report whether the transaction was initiated.
If you are using the Plaid Transfer product to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.

processor/signal/decision/report

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

client_transaction_id

requiredstring

Must be the same as the client_transaction_id supplied when calling /signal/evaluate

Min length: 1

Max length: 36

initiated

requiredboolean

true if the ACH transaction was initiated, false otherwise.
This field must be returned as a boolean. If formatted incorrectly, this will result in an INVALID_FIELD error.

days_funds_on_hold

integer

The actual number of days (hold time) since the ACH debit transaction that you wait before making funds available to your customers. The holding time could affect the ACH return rate.
For example, use 0 if you make funds available to your customers instantly or the same day following the debit transaction, or 1 if you make funds available the next day following the debit initialization.

Minimum: 0

decision_outcome

string

The payment decision from the risk assessment.
APPROVE: approve the transaction without requiring further actions from your customers. For example, use this field if you are placing a standard hold for all the approved transactions before making funds available to your customers. You should also use this field if you decide to accelerate the fund availability for your customers.
REVIEW: the transaction requires manual review
REJECT: reject the transaction
TAKE_OTHER_RISK_MEASURES: for example, placing a longer hold on funds than those approved transactions or introducing customer frictions such as step-up verification/authentication
NOT_EVALUATED: if only logging the Signal results without using them
Possible values: APPROVE, REVIEW, REJECT, TAKE_OTHER_RISK_MEASURES, NOT_EVALUATED

Possible values: APPROVE, REVIEW, REJECT, TAKE_OTHER_RISK_MEASURES, NOT_EVALUATED

amount_instantly_available

string

The payment method to complete the transaction after the risk assessment. It may be different from the default payment method.
SAME_DAY_ACH: Same Day ACH by NACHA. The debit transaction is processed and settled on the same day
NEXT_DAY_ACH: Next Day ACH settlement for debit transactions, offered by some payment processors
STANDARD_ACH: standard ACH by NACHA
REAL_TIME_PAYMENTS: real-time payments such as RTP and FedNow
DEBIT_CARD: if the default payment is over debit card networks
MULTIPLE_PAYMENT_METHODS: if there is no default debit rail or there are multiple payment methods
Possible values: SAME_DAY_ACH, NEXT_DAY_ACH, STANDARD_ACH, REAL_TIME_PAYMENTS, DEBIT_CARD, MULTIPLE_PAYMENT_METHODS

Possible values: SAME_DAY_ACH, NEXT_DAY_ACH, STANDARD_ACH, REAL_TIME_PAYMENTS, DEBIT_CARD, MULTIPLE_PAYMENT_METHODS

number

The amount (in USD) made available to your customers instantly following the debit transaction. It could be a partial amount of the requested transaction (example: 102.05).

Format: double

/processor/signal/decision/report
Select Language
1const decision_report_request = {
2  processor_token: 'processor-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
3  client_transaction_id: 'txn12345',
4  initiated: true,
5  days_funds_on_hold: 3,
6};
7
8try {
9  const decision_report_response = await plaidClient.processorSignalDecisionReport(
10    decision_report_request,
11  );
12  const decision_request_id = decision_report_response.data.request_id;
13} catch (error) {
14  // handle error
15}

processor/signal/decision/report

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "mdqfuVxeoza6mhu"
3}

Was this helpful?

Report a return for an ACH transaction

Call the /processor/signal/return/report endpoint to report a returned transaction that was previously sent to the /processor/signal/evaluate endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
If you are using the Plaid Transfer product to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.

processor/signal/return/report

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

client_transaction_id

requiredstring

Must be the same as the client_transaction_id supplied when calling /processor/signal/evaluate

Min length: 1

Max length: 36

return_code

requiredstring

Must be a valid ACH return code (e.g. "R01")
If formatted incorrectly, this will result in an INVALID_FIELD error.

returned_at

string

Date and time when you receive the returns from your payment processors, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).

Format: date-time

/processor/signal/return/report
Select Language
1const return_report_request = {
2  processor_token: 'processor-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
3  client_transaction_id: 'txn12345',
4  return_code: 'R01',
5};
6
7try {
8  const return_report_response = await plaidClient.processorSignalReturnReport(
9    return_report_request,
10  );
11  const request_id = return_report_response.data.request_id;
12  console.log(request_id);
13} catch (error) {
14  // handle error
15}

processor/signal/return/report

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "mdqfuVxeoza6mhu"
3}

Was this helpful?

Opt-in a processor token to Signal

When a processor token is not initialized with Signal, call /processor/signal/prepare to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score.
If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token.

processor/signal/prepare

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

/processor/signal/prepare
Select Language
1const prepare_request = {
2  processor_token: 'processor-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',
3};
4
5try {
6  const prepare_response = await plaidClient.processorSignalPrepare(
7    prepare_request,
8  );
9  const prepare_request_id = prepare_response.data.request_id;
10} catch (error) {
11  // handle error
12}

processor/signal/prepare

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "mdqfuVxeoza6mhu"
3}

Was this helpful?

Update a processor token's webhook URL

This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED webhook to the newly specified webhook URL.

processor/token/webhook/update

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

webhook

requiredstring

The new webhook URL to associate with the processor token. To remove a webhook from a processor token, set to null.

 
Select Language
1try {
2  const request: ProcessorTokenWebhookUpdateRequest = {
3    processor_token: processorToken,
4    webhook: webhook,
5  };
6  const response = await plaidClient.processorTokenWebhookUpdate(request);
7} catch (error) {
8  // handle error
9}

processor/token/webhook/update

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "vYK11LNTfRoAMbj"
3}

Was this helpful?

Get incremental transaction updates on a processor token

This endpoint replaces /processor/transactions/get and its associated webhooks for most common use-cases.
The /processor/transactions/sync endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /processor/transactions/sync provides the same functionality as /processor/transactions/get and can be used instead of /processor/transactions/get to simplify the process of tracking transactions updates.
This endpoint provides user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). For transaction history from investments accounts, use /investments/transactions/get instead.
Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API.
In the first call to /processor/transactions/sync for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as "adds"), which then generates a next_cursor for that processor token. In subsequent calls, send the next_cursor to receive only the changes that have occurred since the previous call.
Due to the potentially large number of transactions associated with a processor token, results are paginated. The has_more field specifies if additional calls are necessary to fetch all available transaction updates. Call /processor/transactions/sync with the new cursor, pulling all updates, until has_more is false.
When retrieving paginated updates, track both the next_cursor from the latest response and the original cursor from the first call in which has_more was true; if a call to /processor/transactions/sync fails when retrieving a paginated update, which can occur as a result of the TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed.
Whenever new or updated transaction data becomes available, /processor/transactions/sync will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the /processor/transactions/refresh endpoint.
Note that for newly created processor tokens, data may not be immediately available to /processor/transactions/sync. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.

processor/transactions/sync

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

include_original_description

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

cursor

string

The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update. If omitted, the entire history of updates will be returned, starting with the first-added transactions on the item. Note: The upper-bound length of this cursor is 256 characters of base64.

count

integer

The number of transaction updates to fetch.

Default: 100

Minimum: 1

Maximum: 500

Exclusive min: false

options

object

An optional object to be used with the request. If specified, options must not be null.

boolean

Include the raw unparsed transaction description from the financial institution.

Default: false

days_requested

integer

This option only applies to calls for Items that were not initialized with Transactions during Link and are now adding the Transactions product to the Item for the first time. In these cases, this option controls the maximum number of days of transaction history that Plaid will request from the financial institution. For developer accounts created after December 3, 2023, if no value is specified, this will default to 90 days. For developer accounts created on December 3, 2023 or earlier, if no value is specified, this will default to 730 days until June 24, 2024, at which point it will default to 90 days.
If Transactions has already been added to the Item prior to this call, this field will have no effect.
We strongly recommend that customers utilizing Recurring Transactions request at least 180 days of history for optimal results.

Minimum: 1

Maximum: 730

Default: 90

/processor/transactions/sync
Select Language
1// Provide a cursor from your database if you've previously
2// received one for the Item. Leave null if this is your
3// first sync call for this Item. The first request will
4// return a cursor.
5let cursor = database.getLatestCursorOrNull(itemId);
6
7// New transaction updates since "cursor"
8let added: Array<Transaction> = [];
9let modified: Array<Transaction> = [];
10// Removed transaction ids
11let removed: Array<RemovedTransaction> = [];
12let hasMore = true;
13
14// Iterate through each page of new transaction updates for item
15while (hasMore) {
16  const request: ProcessorTransactionsSyncRequest = {
17    processor_token: processorToken,
18    cursor: cursor,
19  };
20  const response = await client.processorTransactionsSync(request);
21  const data = response.data;
22
23  // Add this page of results
24  added = added.concat(data.added);
25  modified = modified.concat(data.modified);
26  removed = removed.concat(data.removed);
27
28  hasMore = data.has_more;
29
30  // Update cursor to the next cursor
31  cursor = data.next_cursor;
32}
33
34// Persist cursor and updated data
35database.applyUpdates(itemId, added, modified, removed, cursor);

processor/transactions/sync

Response fields and example

added

[object]

Transactions that have been added to the Item since cursor ordered by ascending last modified time.

string

The ID of the account in which this transaction occurred.

number

The settled value of the transaction, denominated in the transactions's currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported iso_currency_codes.

deprecatednullable[string]

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

deprecatednullablestring

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). To receive information about the date that a posted transaction was initiated, see the authorized_date field.

Format: date

location

object

A representation of where a transaction took place

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, this field will always appear. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

nullablestring

The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

original_description

nullablestring

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /transactions/get, this field will be omitted unless the client has set options.include_original_description to true.

payment_meta

object

Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Please use the payment_channel field, transaction_type will be deprecated in the future.
digital: transactions that took place online.
place: transactions that were made at a physical location.
special: transactions that relate to banks, e.g. fees or deposits.
unresolved: transactions that do not fit into the other three types.

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

The date that the transaction was authorized. For posted transactions, the date field will indicate the posted date, but authorized_date will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_date, when available, is generally preferable to use over the date field for posted transactions, as it will generally represent the date the user actually made the transaction. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ).

Format: date

authorized_datetime

nullablestring

Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For posted transactions, the datetime field will indicate the posted date, but authorized_datetime will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_datetime, when available, is generally preferable to use over the datetime field for posted transactions, as it will generally represent the date the user actually made the transaction.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

datetime

nullablestring

Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For the date that the transaction was initiated, rather than posted, see the authorized_datetime field.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

payment_channel

string

The channel used to make a payment. online: transactions that took place online.
in store: transactions that were made at a physical location.
other: transactions that relate to banks, e.g. fees or deposits.
This field replaces the transaction_type field.

Possible values: online, in store, other

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

transaction_code

nullablestring

An identifier classifying the transaction type.
This field is only populated for European institutions. For institutions in the US and Canada, this field is set to null.
adjustment: Bank adjustment
atm: Cash deposit or withdrawal via an automated teller machine
bank charge: Charge or fee levied by the institution
bill payment: Payment of a bill
cash: Cash deposit or withdrawal
cashback: Cash withdrawal while making a debit card purchase
cheque: Document ordering the payment of money to another person or organization
direct debit: Automatic withdrawal of funds initiated by a third party at a regular interval
interest: Interest earned or incurred
purchase: Purchase made with a debit or credit card
standing order: Payment instructed by the account holder to a third party at a regular interval
transfer: Transfer of money between accounts

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

The counterparty type.
merchant: a provider of goods or services for purchase financial_institution: a financial entity (bank, credit union, BNPL, fintech) payment_app: a transfer or P2P app (e.g. Zelle) marketplace: a marketplace (e.g DoorDash, Google Play Store) payment_terminal: a point-of-sale payment terminal (e.g Square, Toast) income_source: the payer in an income transaction (e.g., an employer, client, or government agency)

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

A description of how confident we are that the provided counterparty is involved in the transaction.
VERY_HIGH: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. HIGH: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. MEDIUM: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. LOW: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. UNKNOWN: We don’t know the confidence level for this counterparty.

merchant_entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store.

modified

[object]

Transactions that have been modified on the Item since cursor ordered by ascending last modified time.

string

The ID of the account in which this transaction occurred.

number

The settled value of the transaction, denominated in the transactions's currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported iso_currency_codes.

deprecatednullable[string]

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

deprecatednullablestring

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). To receive information about the date that a posted transaction was initiated, see the authorized_date field.

Format: date

location

object

A representation of where a transaction took place

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, this field will always appear. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

nullablestring

The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

original_description

nullablestring

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /transactions/get, this field will be omitted unless the client has set options.include_original_description to true.

payment_meta

object

Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Please use the payment_channel field, transaction_type will be deprecated in the future.
digital: transactions that took place online.
place: transactions that were made at a physical location.
special: transactions that relate to banks, e.g. fees or deposits.
unresolved: transactions that do not fit into the other three types.

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

The date that the transaction was authorized. For posted transactions, the date field will indicate the posted date, but authorized_date will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_date, when available, is generally preferable to use over the date field for posted transactions, as it will generally represent the date the user actually made the transaction. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ).

Format: date

authorized_datetime

nullablestring

Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For posted transactions, the datetime field will indicate the posted date, but authorized_datetime will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_datetime, when available, is generally preferable to use over the datetime field for posted transactions, as it will generally represent the date the user actually made the transaction.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

datetime

nullablestring

Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For the date that the transaction was initiated, rather than posted, see the authorized_datetime field.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

payment_channel

string

The channel used to make a payment. online: transactions that took place online.
in store: transactions that were made at a physical location.
other: transactions that relate to banks, e.g. fees or deposits.
This field replaces the transaction_type field.

Possible values: online, in store, other

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

transaction_code

nullablestring

An identifier classifying the transaction type.
This field is only populated for European institutions. For institutions in the US and Canada, this field is set to null.
adjustment: Bank adjustment
atm: Cash deposit or withdrawal via an automated teller machine
bank charge: Charge or fee levied by the institution
bill payment: Payment of a bill
cash: Cash deposit or withdrawal
cashback: Cash withdrawal while making a debit card purchase
cheque: Document ordering the payment of money to another person or organization
direct debit: Automatic withdrawal of funds initiated by a third party at a regular interval
interest: Interest earned or incurred
purchase: Purchase made with a debit or credit card
standing order: Payment instructed by the account holder to a third party at a regular interval
transfer: Transfer of money between accounts

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

The counterparty type.
merchant: a provider of goods or services for purchase financial_institution: a financial entity (bank, credit union, BNPL, fintech) payment_app: a transfer or P2P app (e.g. Zelle) marketplace: a marketplace (e.g DoorDash, Google Play Store) payment_terminal: a point-of-sale payment terminal (e.g Square, Toast) income_source: the payer in an income transaction (e.g., an employer, client, or government agency)

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

A description of how confident we are that the provided counterparty is involved in the transaction.
VERY_HIGH: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. HIGH: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. MEDIUM: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. LOW: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. UNKNOWN: We don’t know the confidence level for this counterparty.

merchant_entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store.

removed

[object]

Transactions that have been removed from the Item since cursor ordered by ascending last modified time.

string

The ID of the removed transaction.

next_cursor

string

Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by has_more being false) will be valid for at least 1 year. This cursor should be persisted for later calls. If transactions are not yet available, this will be an empty string.

has_more

boolean

Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with cursor set to next_cursor. If has_more is true, it’s important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"added": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 72.1,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Shops",
      "Supermarkets and Groceries"
    ],
    "category_id": "19046000",
    "check_number": null,
    "counterparties": [
      {
        "name": "Walmart",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
        "website": "walmart.com",
        "entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-24",
    "datetime": "2023-09-24T11:01:01Z",
    "authorized_date": "2023-09-22",
    "authorized_datetime": "2023-09-22T10:34:50Z",
    "location": {
      "address": "13425 Community Rd",
      "city": "Poway",
      "region": "CA",
      "postal_code": "92064",
      "country": "US",
      "lat": 32.959068,
      "lon": -117.037666,
      "store_number": "1700"
    },
    "name": "PURCHASE WM SUPERCENTER #1700",
    "merchant_name": "Walmart",
    "merchant_entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
    "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
    "website": "walmart.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "in store",
    "pending": false,
    "pending_transaction_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_GENERAL_MERCHANDISE.png",
    "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "transaction_code": null,
    "transaction_type": "place"
  }
],
"modified": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 28.34,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Food and Drink",
      "Restaurants",
      "Fast Food"
    ],
    "category_id": "13005032",
    "check_number": null,
    "counterparties": [
      {
        "name": "DoorDash",
        "type": "marketplace",
        "logo_url": "https://plaid-counterparty-logos.plaid.com/doordash_1.png",
        "website": "doordash.com",
        "entity_id": "YNRJg5o2djJLv52nBA1Yn1KpL858egYVo4dpm",
        "confidence_level": "HIGH"
      },
      {
        "name": "Burger King",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
        "website": "burgerking.com",
        "entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-28",
    "datetime": "2023-09-28T15:10:09Z",
    "authorized_date": "2023-09-27",
    "authorized_datetime": "2023-09-27T08:01:58Z",
    "location": {
      "address": null,
      "city": null,
      "region": null,
      "postal_code": null,
      "country": null,
      "lat": null,
      "lon": null,
      "store_number": null
    },
    "name": "Dd Doordash Burgerkin",
    "merchant_name": "Burger King",
    "merchant_entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
    "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
    "website": "burgerking.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "online",
    "pending": true,
    "pending_transaction_id": null,
    "personal_finance_category": {
      "primary": "FOOD_AND_DRINK",
      "detailed": "FOOD_AND_DRINK_FAST_FOOD",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_FOOD_AND_DRINK.png",
    "transaction_id": "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
    "transaction_code": null,
    "transaction_type": "digital"
  }
],
"removed": [
  {
    "transaction_id": "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
  }
],
"next_cursor": "tVUUL15lYQN5rBnfDIc1I8xudpGdIlw9nsgeXWvhOfkECvUeR663i3Dt1uf/94S8ASkitgLcIiOSqNwzzp+bh89kirazha5vuZHBb2ZA5NtCDkkV",
"has_more": false,
"request_id": "45QSn"
151}

Was this helpful?

Get transaction data

The /processor/transactions/get endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in /processor/transactions/get. For more details, see Pending and posted transactions.
Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the count and offset parameters in conjunction with the total_transactions response body field to fetch all available transactions.
Data returned by /processor/transactions/get will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the /processor/transactions/refresh endpoint.
Note that data may not be immediately available to /processor/transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions, or upon the first call to /processor/transactions/get, if it wasn't. If no transaction history is ready when /processor/transactions/get is called, it will return a PRODUCT_NOT_READY error.
To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.

processor/transactions/get

Request fields and example

include_original_description

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

options

object

An optional object to be used with the request. If specified, options must not be null.

count

integer

The number of transactions to fetch.

Default: 100

Minimum: 1

Maximum: 500

Exclusive min: false

offset

integer

The number of transactions to skip. The default value is 0.

Default: 0

Minimum: 0

boolean

Include the raw unparsed transaction description from the financial institution.

Default: false

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

start_date

requiredstring

The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

Format: date

end_date

requiredstring

The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

Format: date

/processor/transactions/get
Select Language
1const request: ProcessorTransactionsGetRequest = {
processor_token: processorToken,
start_date: '2018-01-01',
end_date: '2020-02-01'
5};
6try {
const response = await client.processorTransactionsGet(request);
let transactions = response.data.transactions;
const total_transactions = response.data.total_transactions;
// Manipulate the offset parameter to paginate
// transactions and retrieve all available data
while (transactions.length < total_transactions) {
  const paginatedRequest: ProcessorTransactionsGetRequest = {
    processor_token: processorToken,
    start_date: '2018-01-01',
    end_date: '2020-02-01',
    options: {
      offset: transactions.length,
    },
  };
  const paginatedResponse = await client.processorTransactionsGet(paginatedRequest);
  transactions = transactions.concat(
    paginatedResponse.data.transactions,
  );
}
26} catch((err) => {
// handle error
28}

processor/transactions/get

Response fields and example

object

A single account at a financial institution.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

transactions

[object]

An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the count parameter.

string

The ID of the account in which this transaction occurred.

number

The settled value of the transaction, denominated in the transactions's currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported iso_currency_codes.

deprecatednullable[string]

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

deprecatednullablestring

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). To receive information about the date that a posted transaction was initiated, see the authorized_date field.

Format: date

location

object

A representation of where a transaction took place

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, this field will always appear. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

nullablestring

The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

original_description

nullablestring

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /transactions/get, this field will be omitted unless the client has set options.include_original_description to true.

payment_meta

object

Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Please use the payment_channel field, transaction_type will be deprecated in the future.
digital: transactions that took place online.
place: transactions that were made at a physical location.
special: transactions that relate to banks, e.g. fees or deposits.
unresolved: transactions that do not fit into the other three types.

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

The date that the transaction was authorized. For posted transactions, the date field will indicate the posted date, but authorized_date will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_date, when available, is generally preferable to use over the date field for posted transactions, as it will generally represent the date the user actually made the transaction. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ).

Format: date

authorized_datetime

nullablestring

Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For posted transactions, the datetime field will indicate the posted date, but authorized_datetime will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_datetime, when available, is generally preferable to use over the datetime field for posted transactions, as it will generally represent the date the user actually made the transaction.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

datetime

nullablestring

Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For the date that the transaction was initiated, rather than posted, see the authorized_datetime field.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

payment_channel

string

The channel used to make a payment. online: transactions that took place online.
in store: transactions that were made at a physical location.
other: transactions that relate to banks, e.g. fees or deposits.
This field replaces the transaction_type field.

Possible values: online, in store, other

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

transaction_code

nullablestring

An identifier classifying the transaction type.
This field is only populated for European institutions. For institutions in the US and Canada, this field is set to null.
adjustment: Bank adjustment
atm: Cash deposit or withdrawal via an automated teller machine
bank charge: Charge or fee levied by the institution
bill payment: Payment of a bill
cash: Cash deposit or withdrawal
cashback: Cash withdrawal while making a debit card purchase
cheque: Document ordering the payment of money to another person or organization
direct debit: Automatic withdrawal of funds initiated by a third party at a regular interval
interest: Interest earned or incurred
purchase: Purchase made with a debit or credit card
standing order: Payment instructed by the account holder to a third party at a regular interval
transfer: Transfer of money between accounts

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

The counterparty type.
merchant: a provider of goods or services for purchase financial_institution: a financial entity (bank, credit union, BNPL, fintech) payment_app: a transfer or P2P app (e.g. Zelle) marketplace: a marketplace (e.g DoorDash, Google Play Store) payment_terminal: a point-of-sale payment terminal (e.g Square, Toast) income_source: the payer in an income transaction (e.g., an employer, client, or government agency)

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

A description of how confident we are that the provided counterparty is involved in the transaction.
VERY_HIGH: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. HIGH: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. MEDIUM: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. LOW: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. UNKNOWN: We don’t know the confidence level for this counterparty.

merchant_entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store.

total_transactions

integer

The total number of transactions available within the date range specified. If total_transactions is larger than the size of the transactions array, more transactions are available and can be fetched via manipulating the offset parameter.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"account": {
  "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
  "balances": {
    "available": 110.94,
    "current": 110.94,
    "iso_currency_code": "USD",
    "limit": null,
    "unofficial_currency_code": null
  },
  "mask": "0000",
  "name": "Plaid Checking",
  "official_name": "Plaid Gold Standard 0% Interest Checking",
  "subtype": "checking",
  "type": "depository"
},
"transactions": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 28.34,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Food and Drink",
      "Restaurants",
      "Fast Food"
    ],
    "category_id": "13005032",
    "check_number": null,
    "counterparties": [
      {
        "name": "DoorDash",
        "type": "marketplace",
        "logo_url": "https://plaid-counterparty-logos.plaid.com/doordash_1.png",
        "website": "doordash.com",
        "entity_id": "YNRJg5o2djJLv52nBA1Yn1KpL858egYVo4dpm",
        "confidence_level": "HIGH"
      },
      {
        "name": "Burger King",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
        "website": "burgerking.com",
        "entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-28",
    "datetime": "2023-09-28T15:10:09Z",
    "authorized_date": "2023-09-27",
    "authorized_datetime": "2023-09-27T08:01:58Z",
    "location": {
      "address": null,
      "city": null,
      "region": null,
      "postal_code": null,
      "country": null,
      "lat": null,
      "lon": null,
      "store_number": null
    },
    "name": "Dd Doordash Burgerkin",
    "merchant_name": "Burger King",
    "merchant_entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
    "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
    "website": "burgerking.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "online",
    "pending": true,
    "pending_transaction_id": null,
    "personal_finance_category": {
      "primary": "FOOD_AND_DRINK",
      "detailed": "FOOD_AND_DRINK_FAST_FOOD",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_FOOD_AND_DRINK.png",
    "transaction_id": "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
    "transaction_code": null,
    "transaction_type": "digital"
  },
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 72.1,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Shops",
      "Supermarkets and Groceries"
    ],
    "category_id": "19046000",
    "check_number": null,
    "counterparties": [
      {
        "name": "Walmart",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
        "website": "walmart.com",
        "entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-24",
    "datetime": "2023-09-24T11:01:01Z",
    "authorized_date": "2023-09-22",
    "authorized_datetime": "2023-09-22T10:34:50Z",
    "location": {
      "address": "13425 Community Rd",
      "city": "Poway",
      "region": "CA",
      "postal_code": "92064",
      "country": "US",
      "lat": 32.959068,
      "lon": -117.037666,
      "store_number": "1700"
    },
    "name": "PURCHASE WM SUPERCENTER #1700",
    "merchant_name": "Walmart",
    "merchant_entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
    "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
    "website": "walmart.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "in store",
    "pending": false,
    "pending_transaction_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_GENERAL_MERCHANDISE.png",
    "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "transaction_code": null,
    "transaction_type": "place"
  }
],
"total_transactions": 1,
"request_id": "Wvhy9PZHQLV8njG"
158}

Was this helpful?

Fetch recurring transaction streams

The /processor/transactions/recurring/get endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.
This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create; or after Link, by calling /processor/transactions/get or /processor/transactions/sync). Once all historical transactions have been fetched, call /processor/transactions/recurring/get to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE webhook. To know when historical transactions have been fetched, if you are using /processor/transactions/sync listen for the SYNC_UPDATES_AVAILABLE webhook and check that the historical_update_complete field in the payload is true. If using /processor/transactions/get, listen for the HISTORICAL_UPDATE webhook.
After the initial call, you can call /processor/transactions/recurring/get endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE webhook to be notified when new updates are available.
To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.

processor/transactions/recurring/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

/processor/transactions/recurring/get
Select Language
1const request: ProcessorTransactionsGetRequest = {
2  processor_token: processorToken
3};
4try {
5  const response = await client.processorTransactionsRecurringGet(request);
6  let inflowStreams = response.data.inflowStreams;
7  let outflowStreams = response.data.outflowStreams;
8  }
9} catch((err) => {
10  // handle error
11}

processor/transactions/recurring/get

Response fields and example

inflow_streams

[object]

An array of depository transaction streams.

string

The ID of the account to which the stream belongs

stream_id

string

A unique id for the stream

deprecated[string]

A hierarchical array of the categories to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

deprecatedstring

The ID of the category to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

description

string

A description of the transaction stream.

nullablestring

The merchant associated with the transaction stream.

first_date

string

The posted date of the earliest transaction in the stream.

Format: date

last_date

string

The posted date of the latest transaction in the stream.

Format: date

frequency

string

Describes the frequency of the transaction stream.
WEEKLY: Assigned to a transaction stream that occurs approximately every week.
BIWEEKLY: Assigned to a transaction stream that occurs approximately every 2 weeks.
SEMI_MONTHLY: Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.
MONTHLY: Assigned to a transaction stream that occurs approximately every month.
ANNUALLY: Assigned to a transaction stream that occurs approximately every year.
UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY, ANNUALLY

transaction_ids

[string]

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

average_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

The unofficial currency code of the amount. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

last_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

The unofficial currency code of the amount. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

is_active

boolean

Indicates whether the transaction stream is still live.

status

string

The current status of the transaction stream.
MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual recurring stream, we will mark it MATURE after 2 instances).
EARLY_DETECTION: When a recurring transaction first appears in the transaction history and before it fulfills the requirement of a mature stream, the status will be EARLY_DETECTION.
TOMBSTONED: A stream that was previously in the EARLY_DETECTION status will move to the TOMBSTONED status when no further transactions were found at the next expected date.
UNKNOWN: A stream is assigned an UNKNOWN status when none of the other statuses are applicable.

Possible values: UNKNOWN, MATURE, EARLY_DETECTION, TOMBSTONED

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

last_user_modified_datetime

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

is_user_modified

boolean

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

string

The date and time of the most recent user modification. This will only be set if is_user_modified is true.

Format: date-time

outflow_streams

[object]

An array of expense transaction streams.

string

The ID of the account to which the stream belongs

stream_id

string

A unique id for the stream

deprecated[string]

A hierarchical array of the categories to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

deprecatedstring

The ID of the category to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

description

string

A description of the transaction stream.

nullablestring

The merchant associated with the transaction stream.

first_date

string

The posted date of the earliest transaction in the stream.

Format: date

last_date

string

The posted date of the latest transaction in the stream.

Format: date

frequency

string

Describes the frequency of the transaction stream.
WEEKLY: Assigned to a transaction stream that occurs approximately every week.
BIWEEKLY: Assigned to a transaction stream that occurs approximately every 2 weeks.
SEMI_MONTHLY: Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.
MONTHLY: Assigned to a transaction stream that occurs approximately every month.
ANNUALLY: Assigned to a transaction stream that occurs approximately every year.
UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY, ANNUALLY

transaction_ids

[string]

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

average_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

The unofficial currency code of the amount. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

last_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

The unofficial currency code of the amount. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

is_active

boolean

Indicates whether the transaction stream is still live.

status

string

The current status of the transaction stream.
MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual recurring stream, we will mark it MATURE after 2 instances).
EARLY_DETECTION: When a recurring transaction first appears in the transaction history and before it fulfills the requirement of a mature stream, the status will be EARLY_DETECTION.
TOMBSTONED: A stream that was previously in the EARLY_DETECTION status will move to the TOMBSTONED status when no further transactions were found at the next expected date.
UNKNOWN: A stream is assigned an UNKNOWN status when none of the other statuses are applicable.

Possible values: UNKNOWN, MATURE, EARLY_DETECTION, TOMBSTONED

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

last_user_modified_datetime

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

is_user_modified

boolean

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

string

The date and time of the most recent user modification. This will only be set if is_user_modified is true.

Format: date-time

updated_datetime

string

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time transaction streams for the given account were updated on

Format: date-time

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"updated_datetime": "2022-05-01T00:00:00Z",
"inflow_streams": [
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "category": [
      "Transfer",
      "Payroll"
    ],
    "category_id": "21009000",
    "description": "Platypus Payroll",
    "merchant_name": null,
    "personal_finance_category": {
      "primary": "INCOME",
      "detailed": "INCOME_WAGES",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-02-28",
    "last_date": "2022-04-30",
    "frequency": "SEMI_MONTHLY",
    "transaction_ids": [
      "nkeaNrDGrhdo6c4qZWDA8ekuIPuJ4Avg5nKfw",
      "EfC5ekksdy30KuNzad2tQupW8WIPwvjXGbGHL",
      "ozfvj3FFgp6frbXKJGitsDzck5eWQH7zOJBYd",
      "QvdDE8AqVWo3bkBZ7WvCd7LskxVix8Q74iMoK",
      "uQozFPfMzibBouS9h9tz4CsyvFll17jKLdPAF"
    ],
    "average_amount": {
      "amount": -800,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": -1000,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": true,
    "last_user_modified_datetime": "2023-01-19T10:34:50Z"
  }
],
"outflow_streams": [
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff",
    "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nd",
    "category": [
      "Service",
      "Utilities",
      "Electric"
    ],
    "category_id": "18068005",
    "description": "ConEd Bill Payment",
    "merchant_name": "ConEd",
    "personal_finance_category": {
      "primary": "RENT_AND_UTILITIES",
      "detailed": "RENT_AND_UTILITIES_GAS_AND_ELECTRICITY",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-02-04",
    "last_date": "2022-05-02",
    "frequency": "MONTHLY",
    "transaction_ids": [
      "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
      "HPDnUVgI5Pa0YQSl0rxwYRwVXeLyJXTWDAvpR",
      "jEPoSfF8xzMClE9Ohj1he91QnvYoSdwg7IT8L",
      "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
    ],
    "average_amount": {
      "amount": 85,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": 100,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": false
  },
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff",
    "stream_id": "SrBNJZDuUMweodmPmSOeOImwsWt53ZXfJQAfC",
    "category": [
      "Shops",
      "Warehouses and Wholesale Stores"
    ],
    "category_id": "19051000",
    "description": "Costco Annual Membership",
    "merchant_name": "Costco",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-01-23",
    "last_date": "2023-01-22",
    "frequency": "ANNUALLY",
    "transaction_ids": [
      "yqEBJ72cS4jFwcpxJcDuQr94oAQ1R1lMC33D4",
      "Kz5Hm3cZCgpn4tMEKUGAGD6kAcxMBsEZDSwJJ"
    ],
    "average_amount": {
      "amount": 120,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": 120,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": true,
    "last_user_modified_datetime": "2023-01-19T10:34:50Z"
  }
],
"request_id": "tbFyCEqkU775ZGG"
124}

Was this helpful?

Refresh transaction data

/processor/transactions/refresh is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling /processor/transactions/refresh, Plaid will fire a webhook: for /transactions/sync users, SYNC_UPDATES_AVAILABLE will be fired if there are any transactions updated, added, or removed. For users of both /processor/transactions/sync and /processor/transactions/get, TRANSACTIONS_REMOVED will be fired if any removed transactions are detected, and DEFAULT_UPDATE will be fired if any new transactions are detected. New transactions can be fetched by calling /processor/transactions/get or /processor/transactions/sync. Note that the /processor/transactions/refresh endpoint is not supported for Capital One (ins_128026) and will result in a PRODUCTS_NOT_SUPPORTED error if called on a processor token from that institution.
As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
/processor/transactions/refresh is offered as an add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.

processor/transactions/refresh

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

/processor/transactions/refresh
Select Language
1const request: ProcessorTransactionsRefreshRequest = {
2  processor_token: processorToken,
3};
4try {
5  await plaidClient.processorTransactionsRefresh(request);
6} catch (error) {
7  // handle error
8}

processor/transactions/refresh

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "1vwmF5TBQwiqfwP"
3}

Was this helpful?

This webhook is only sent to Plaid processor partners.
Fired when a processor updates the webhook URL for a processor token via /processor/token/webhook/update.

webhook_type

string

PROCESSOR_TOKEN

webhook_code

string

WEBHOOK_UPDATE_ACKNOWLEDGED

error

object

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

error_type

string

A broad categorization of the error. Safe for programmatic use.

Possible values: INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR

error_code

string

The particular error code. Safe for programmatic use.

error_message

string

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

display_message

string

A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

causes

array

In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.
causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.

status

integer

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

documentation_url

string

The URL of a Plaid documentation page with more information about the error

suggested_action

string

Suggested steps for resolving the error