| AccountAccess |
Allow or disallow product access by account.
|
| AccountAssets |
AccountAssets
|
| AccountAssets.VerificationStatusEnum.Adapter |
|
| AccountAssetsAllOf |
AccountAssetsAllOf
|
| AccountBalance |
A set of fields describing the balance for an account.
|
| AccountBase |
A single account at a financial institution.
|
| AccountBase.VerificationStatusEnum.Adapter |
|
| AccountFilter |
Enumerates the account subtypes that the application wishes for the user to be able to select from.
|
| AccountFiltersResponse |
The `account_filters` specified in the original call to `/link/token/create`.
|
| AccountIdentity |
AccountIdentity
|
| AccountIdentity.VerificationStatusEnum.Adapter |
|
| AccountIdentityAllOf |
AccountIdentityAllOf
|
| AccountsBalanceGetRequest |
AccountsBalanceGetRequest defines the request schema for `/accounts/balance/get`
|
| AccountsBalanceGetRequestOptions |
An optional object to filter `/accounts/balance/get` results.
|
| AccountSelectionCardinality.Adapter |
|
| AccountsGetRequest |
AccountsGetRequest defines the request schema for `/accounts/get`
|
| AccountsGetRequestOptions |
An optional object to filter `/accounts/get` results.
|
| AccountsGetResponse |
AccountsGetResponse defines the response schema for `/accounts/get` and `/accounts/balance/get`.
|
| AccountSubtype.Adapter |
|
| AccountType.Adapter |
|
| ACHClass.Adapter |
|
| Address |
A physical mailing address.
|
| AddressData |
Data about the components comprising an address.
|
| AddressDataNullable |
AddressDataNullable
|
| AddressNullable |
AddressNullable
|
| Application |
Metadata about the application
|
| ApplicationGetRequest |
ApplicationGetResponse defines the schema for `/application/get`
|
| ApplicationGetResponse |
The request ID associated with this call.
|
| APR |
Information about the APR on the account.
|
| APR.AprTypeEnum.Adapter |
|
| AssetReport |
An object representing an Asset Report
|
| AssetReportAuditCopyCreateRequest |
AssetReportAuditCopyCreateRequest defines the request schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyCreateResponse |
AssetReportAuditCopyCreateResponse defines the response schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyGetRequest |
AssetReportAuditCopyGetRequest defines the request schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyRemoveRequest |
AssetReportAuditCopyRemoveRequest defines the request schema for `/asset_report/audit_copy/remove`
|
| AssetReportAuditCopyRemoveResponse |
AssetReportAuditCopyRemoveResponse defines the response schema for `/asset_report/audit_copy/remove`
|
| AssetReportCreateRequest |
AssetReportCreateRequest defines the request schema for `/asset_report/create`
|
| AssetReportCreateRequestOptions |
An optional object to filter `/asset_report/create` results.
|
| AssetReportCreateResponse |
AssetReportCreateResponse defines the response schema for `/asset_report/create`
|
| AssetReportFilterRequest |
AssetReportFilterRequest defines the request schema for `/asset_report/filter`
|
| AssetReportFilterResponse |
AssetReportFilterResponse defines the response schema for `/asset_report/filter`
|
| AssetReportGetRequest |
AssetReportGetRequest defines the request schema for `/asset_report/get`
|
| AssetReportGetResponse |
AssetReportGetResponse defines the response schema for `/asset_report/get`
|
| AssetReportItem |
A representation of an Item within an Asset Report.
|
| AssetReportPDFGetRequest |
AssetReportPDFGetRequest defines the request schema for `/asset_report/pdf/get`
|
| AssetReportRefreshRequest |
AssetReportRefreshRequest defines the request schema for `/asset_report/refresh`
|
| AssetReportRefreshRequestOptions |
An optional object to filter `/asset_report/refresh` results.
|
| AssetReportRefreshResponse |
AssetReportRefreshResponse defines the response schema for `/asset_report/refresh`
|
| AssetReportRemoveRequest |
AssetReportRemoveRequest defines the request schema for `/asset_report/remove`
|
| AssetReportRemoveResponse |
AssetReportRemoveResponse defines the response schema for `/asset_report/remove`
|
| AssetReportTransaction |
AssetReportTransaction
|
| AssetReportTransaction.TransactionTypeEnum.Adapter |
|
| AssetReportTransactionAllOf |
AssetReportTransactionAllOf
|
| AssetReportUser |
The user object allows you to provide additional information about the user to be appended to the Asset Report.
|
| AssetsErrorWebhook |
Fired when Asset Report generation has failed.
|
| AssetsProductReadyWebhook |
Fired when the Asset Report has been generated and `/asset_report/get` is ready to be called.
|
| AuthGetNumbers |
An object containing identifying numbers used for making electronic transfers to and from the `accounts`.
|
| AuthGetRequest |
AuthGetRequest defines the request schema for `/auth/get`
|
| AuthGetRequestOptions |
An optional object to filter `/auth/get` results.
|
| AuthGetResponse |
AuthGetResponse defines the response schema for `/auth/get`
|
| AuthMetadata |
Metadata that captures information about the Auth features of an institution.
|
| AuthSupportedMethods |
Metadata specifically related to which auth methods an institution supports.
|
| AutomaticallyVerifiedWebhook |
Fired when an Item is verified via automated micro-deposits.
|
| BankInitiatedReturnRisk |
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.
|
| BankTransfer |
Represents a bank transfer within the Bank Transfers API.
|
| BankTransferBalance |
BankTransferBalance
|
| BankTransferBalanceGetRequest |
Defines the request schema for `/bank_transfer/balance/get`
|
| BankTransferBalanceGetResponse |
Defines the response schema for `/bank_transfer/balance/get`
|
| BankTransferCancelRequest |
Defines the request schema for `/bank_transfer/cancel`
|
| BankTransferCancelResponse |
Defines the response schema for `/bank_transfer/cancel`
|
| BankTransferCreateRequest |
Defines the request schema for `/bank_transfer/create`
|
| BankTransferCreateResponse |
Defines the response schema for `/bank_transfer/create`
|
| BankTransferDirection.Adapter |
|
| BankTransferEvent |
Represents an event in the Bank Transfers API.
|
| BankTransferEventListRequest |
Defines the request schema for `/bank_transfer/event/list`
|
| BankTransferEventListRequest.BankTransferTypeEnum.Adapter |
|
| BankTransferEventListRequest.DirectionEnum.Adapter |
|
| BankTransferEventListResponse |
Defines the response schema for `/bank_transfer/event/list`
|
| BankTransferEventSyncRequest |
Defines the request schema for `/bank_transfer/event/sync`
|
| BankTransferEventSyncResponse |
Defines the response schema for `/bank_transfer/event/sync`
|
| BankTransferEventType.Adapter |
|
| BankTransferFailure |
The failure reason if the type of this transfer is `\"failed\"` or `\"reversed\"`.
|
| BankTransferGetRequest |
Defines the request schema for `/bank_transfer/get`
|
| BankTransferGetResponse |
Defines the response schema for `/bank_transfer/get`
|
| BankTransferListRequest |
Defines the request schema for `/bank_transfer/list`
|
| BankTransferListResponse |
Defines the response schema for `/bank_transfer/list`
|
| BankTransferMigrateAccountRequest |
Defines the request schema for `/bank_transfer/migrate_account`
|
| BankTransferMigrateAccountResponse |
Defines the response schema for `/bank_transfer/migrate_account`
|
| BankTransferNetwork.Adapter |
|
| BankTransferReceiverDetails |
The receiver details if the type of this event is `reciever_pending` or `reciever_posted`.
|
| BankTransferReceiverDetails.AvailableBalanceEnum.Adapter |
|
| BankTransfersEventsUpdateWebhook |
Fired when new bank transfer events are available.
|
| BankTransferStatus.Adapter |
|
| BankTransferSweep |
BankTransferSweep describes a sweep transfer.
|
| BankTransferSweepAccount |
The account where the funds are swept to.
|
| BankTransferSweepGetRequest |
BankTransferSweepGetRequest defines the request schema for `/bank_transfer/sweep/get`
|
| BankTransferSweepGetResponse |
BankTransferSweepGetResponse defines the response schema for `/bank_transfer/sweep/get`
|
| BankTransferSweepListRequest |
BankTransferSweepListRequest defines the request schema for `/bank_transfer/sweep/list`
|
| BankTransferSweepListResponse |
BankTransferSweepListResponse defines the response schema for `/bank_transfer/sweep/list`
|
| BankTransferType.Adapter |
|
| BankTransferUser |
The legal name and other information for the account holder.
|
| CategoriesGetResponse |
CategoriesGetResponse defines the response schema for `/categories/get`
|
| Category |
Information describing a transaction category
|
| Cause |
An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
|
| ConnectedApplication |
Describes the connected application for a particular end user.
|
| ConnectedApplication.ProductDataTypesEnum.Adapter |
|
| CountryCode.Adapter |
|
| CreditCardLiability |
An object representing a credit card account.
|
| CreditFilter |
A filter to apply to `credit`-type accounts
|
| CustomerInitiatedReturnRisk |
The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit.
|
| Deductions |
An object with the deduction information found on a paystub.
|
| DeductionsBreakdown |
An object representing the deduction line items for the pay period
|
| DeductionsTotal |
An object representing the total deductions for the pay period
|
| DefaultUpdateWebhook |
Fired when new transaction data is available for an Item.
|
| DepositoryFilter |
A filter to apply to `depository`-type accounts
|
| DepositSwitchAddressData |
The user's address.
|
| DepositSwitchAltCreateRequest |
DepositSwitchAltCreateRequest defines the request schema for `/deposit_switch/alt/create`
|
| DepositSwitchAltCreateRequest.CountryCodeEnum.Adapter |
|
| DepositSwitchAltCreateResponse |
DepositSwitchAltCreateResponse defines the response schema for `/deposit_switch/alt/create`
|
| DepositSwitchCreateRequest |
DepositSwitchCreateRequest defines the request schema for `/deposit_switch/create`
|
| DepositSwitchCreateRequest.CountryCodeEnum.Adapter |
|
| DepositSwitchCreateRequestOptions |
Options to configure the `/deposit_switch/create` request.
|
| DepositSwitchCreateResponse |
DepositSwitchCreateResponse defines the response schema for `/deposit_switch/create`
|
| DepositSwitchGetRequest |
DepositSwitchGetRequest defines the request schema for `/deposit_switch/get`
|
| DepositSwitchGetResponse |
DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`
|
| DepositSwitchGetResponse.StateEnum.Adapter |
|
| DepositSwitchGetResponse.SwitchMethodEnum.Adapter |
|
| DepositSwitchStateUpdateWebhook |
Fired when the status of a deposit switch request has changed.
|
| DepositSwitchTargetAccount |
DepositSwitchTargetAccount
|
| DepositSwitchTargetAccount.AccountSubtypeEnum.Adapter |
|
| DepositSwitchTargetUser |
DepositSwitchTargetUser
|
| DepositSwitchTokenCreateRequest |
DepositSwitchTokenCreateRequest defines the request schema for `/deposit_switch/token/create`
|
| DepositSwitchTokenCreateResponse |
DepositSwitchTokenCreateResponse defines the response schema for `/deposit_switch/token/create`
|
| DistributionBreakdown |
Information about the accounts that the payment was distributed to.
|
| DocumentMetadata |
An object representing metadata from the end user's uploaded document.
|
| DocumentMetadata.DocTypeEnum.Adapter |
|
| Earnings |
An object representing both a breakdown of earnings on a paystub and the total earnings.
|
| EarningsBreakdown |
An object representing the earnings line items for the pay period.
|
| EarningsBreakdown.CanonicalDescriptionEnum.Adapter |
|
| EarningsTotal |
An object representing both the current pay period and year to date amount for an earning category.
|
| EarningsTotal.CanonicalDescriptionEnum.Adapter |
|
| Email |
An object representing an email address
|
| Email.TypeEnum.Adapter |
|
| Employee |
Data about the employee.
|
| EmployeeIncomeSummaryFieldString |
EmployeeIncomeSummaryFieldString
|
| Employer |
Data about the employer.
|
| EmployerIncomeSummaryFieldString |
EmployerIncomeSummaryFieldString
|
| EmployersSearchRequest |
EmployersSearchRequest defines the request schema for `/employers/search`.
|
| EmployersSearchResponse |
EmployersSearchResponse defines the response schema for `/employers/search`.
|
| EmployerVerification |
An object containing employer data.
|
| EmploymentDetails |
An object representing employment details found on a paystub.
|
| EmploymentVerification |
An object containing proof of employment data for an individual
|
| EmploymentVerification.StatusEnum.Adapter |
|
| EmploymentVerificationGetRequest |
EmploymentVerificationGetRequest defines the request schema for `/employment/verification/get`.
|
| EmploymentVerificationGetResponse |
EmploymentVerificationGetResponse defines the response schema for `/employment/verification/get`.
|
| Error |
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`.
|
| Error.ErrorTypeEnum.Adapter |
|
| ExternalPaymentOptions |
Additional payment options
|
| ExternalPaymentRefundDetails |
ExternalPaymentRefundDetails
|
| ExternalPaymentScheduleBase |
The schedule that the payment will be executed on.
|
| ExternalPaymentScheduleGet |
The schedule that the payment will be executed on.
|
| ExternalPaymentScheduleRequest |
The schedule that the payment will be executed on.
|
| HealthIncident |
HealthIncident
|
| HistoricalBalance |
An object representing a balance held by an account in the past
|
| HistoricalUpdateWebhook |
Fired when an Item's historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item.
|
| Holding |
A securities holding at an institution.
|
| HoldingsDefaultUpdateWebhook |
Fired when new or updated holdings have been detected on an investment account.
|
| HoldingsOverride |
Specify the holdings on the account.
|
| IdentityGetRequest |
IdentityGetRequest defines the request schema for `/identity/get`
|
| IdentityGetRequestOptions |
An optional object to filter `/identity/get` results.
|
| IdentityGetResponse |
IdentityGetResponse defines the response schema for `/identity/get`
|
| IncidentUpdate |
IncidentUpdate
|
| IncidentUpdate.StatusEnum.Adapter |
|
| IncomeBreakdown |
An object representing a breakdown of the different income types on the paystub.
|
| IncomeBreakdown.TypeEnum.Adapter |
|
| IncomeOverride |
Specify payroll data on the account.
|
| IncomeSummary |
The verified fields from a paystub verification.
|
| IncomeSummaryFieldNumber |
IncomeSummaryFieldNumber
|
| IncomeSummaryFieldString |
IncomeSummaryFieldString
|
| IncomeVerificationCreateRequest |
IncomeVerificationCreateRequest defines the request schema for `/income/verification/create`
|
| IncomeVerificationCreateRequestOptions |
IncomeVerificationCreateRequestOptions defines the optional arguments schema for `/income/verification/create`
|
| IncomeVerificationCreateResponse |
IncomeVerificationCreateResponse defines the response schema for `/income/verification/create`.
|
| IncomeVerificationDocumentsDownloadRequest |
IncomeVerificationDocumentsDownloadRequest defines the request schema for `/income/verification/documents/download`.
|
| IncomeVerificationPaystubGetRequest |
IncomeVerificationPaystubGetRequest defines the request schema for `/income/verification/paystub/get`.
|
| IncomeVerificationPaystubGetResponse |
IncomeVerificationPaystubGetResponse defines the response schema for `/income/verification/paystub/get`.
|
| IncomeVerificationPaystubsGetRequest |
IncomeVerificationPaystubsGetRequest defines the request schema for `/income/verification/paystubs/get`.
|
| IncomeVerificationPaystubsGetResponse |
IncomeVerificationPaystubsGetResponse defines the response schema for `/income/verification/paystubs/get`.
|
| IncomeVerificationPrecheckEmployer |
IncomeVerificationPrecheckEmployer
|
| IncomeVerificationPrecheckEmployerAddress |
The address of the employer
|
| IncomeVerificationPrecheckMilitaryInfo |
IncomeVerificationPrecheckMilitaryInfo
|
| IncomeVerificationPrecheckMilitaryInfo.BranchEnum.Adapter |
|
| IncomeVerificationPrecheckRequest |
IncomeVerificationPrecheckRequest defines the request schema for `/income/verification/precheck`
|
| IncomeVerificationPrecheckResponse |
IncomeVerificationPrecheckResponse defines the response schema for `/income/verification/precheck`.
|
| IncomeVerificationPrecheckResponse.ConfidenceEnum.Adapter |
|
| IncomeVerificationPrecheckUser |
IncomeVerificationPrecheckUser
|
| IncomeVerificationRefreshRequest |
IncomeVerificationRefreshRequest defines the request schema for `/income/verification/refresh`
|
| IncomeVerificationRefreshResponse |
IncomeVerificationRequestResponse defines the response schema for `/income/verification/refresh`
|
| IncomeVerificationStatusWebhook |
Fired when the status of an income verification instance has changed.
|
| IncomeVerificationSummaryGetRequest |
IncomeVerificationSummaryGetRequest defines the request schema for `/income/verification/summary/get`.
|
| IncomeVerificationSummaryGetResponse |
IncomeVerificationSummaryGetResponse defines the response schema for `/income/verification/summary/get`.
|
| IncomeVerificationTaxformsGetRequest |
IncomeVerificationTaxformsGetRequest defines the request schema for `/income/verification/taxforms/get`
|
| IncomeVerificationTaxformsGetResponse |
IncomeVerificationTaxformsGetResponse defines the response schema for `/income/verification/taxforms/get`
|
| IncomeVerificationWebhookStatus |
IncomeVerificationWebhookStatus
|
| InflowModel |
The `inflow_model` allows you to model a test account that receives regular income or make regular payments on a loan.
|
| InitialUpdateWebhook |
Fired when an Item's initial transaction pull is completed.
|
| Institution |
Details relating to a specific financial institution
|
| InstitutionsGetByIdRequest |
InstitutionsGetByIdRequest defines the request schema for `/institutions/get_by_id`
|
| InstitutionsGetByIdRequestOptions |
Specifies optional parameters for `/institutions/get_by_id`.
|
| InstitutionsGetByIdResponse |
InstitutionsGetByIdResponse defines the response schema for `/institutions/get_by_id`
|
| InstitutionsGetRequest |
InstitutionsGetRequest defines the request schema for `/institutions/get`
|
| InstitutionsGetRequestOptions |
An optional object to filter `/institutions/get` results.
|
| InstitutionsGetResponse |
InstitutionsGetResponse defines the response schema for `/institutions/get`
|
| InstitutionsSearchAccountFilter |
InstitutionsSearchAccountFilter
|
| InstitutionsSearchPaymentInitiationOptions |
Additional options that will be used to filter institutions by various Payment Initiation configurations.
|
| InstitutionsSearchRequest |
InstitutionsSearchRequest defines the request schema for `/institutions/search`
|
| InstitutionsSearchRequestOptions |
An optional object to filter `/institutions/search` results.
|
| InstitutionsSearchResponse |
InstitutionsSearchResponse defines the response schema for `/institutions/search`
|
| InstitutionStatus |
The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests.
|
| InvestmentFilter |
A filter to apply to `investment`-type accounts
|
| InvestmentHoldingsGetRequestOptions |
An optional object to filter `/investments/holdings/get` results.
|
| InvestmentsDefaultUpdateWebhook |
Fired when new or canceled transactions have been detected on an investment account.
|
| InvestmentsHoldingsGetRequest |
InvestmentsHoldingsGetRequest defines the request schema for `/investments/holdings/get`
|
| InvestmentsHoldingsGetResponse |
InvestmentsHoldingsGetResponse defines the response schema for `/investments/holdings/get`
|
| InvestmentsTransactionsGetRequest |
InvestmentsTransactionsGetRequest defines the request schema for `/investments/transactions/get`
|
| InvestmentsTransactionsGetRequestOptions |
An optional object to filter `/investments/transactions/get` results.
|
| InvestmentsTransactionsGetResponse |
InvestmentsTransactionsGetResponse defines the response schema for `/investments/transactions/get`
|
| InvestmentsTransactionsOverride |
Specify the list of investments transactions on the account.
|
| InvestmentTransaction |
A transaction within an investment account.
|
| InvestmentTransaction.SubtypeEnum.Adapter |
|
| InvestmentTransaction.TypeEnum.Adapter |
|
| Item |
Metadata about the Item.
|
| Item.UpdateTypeEnum.Adapter |
|
| ItemAccessTokenInvalidateRequest |
ItemAccessTokenInvalidateRequest defines the request schema for `/item/access_token/invalidate`
|
| ItemAccessTokenInvalidateResponse |
ItemAccessTokenInvalidateResponse defines the response schema for `/item/access_token/invalidate`
|
| ItemApplicationListRequest |
Request to list connected applications for a user.
|
| ItemApplicationListResponse |
Describes the connected application for a particular end user.
|
| ItemApplicationListUserAuth |
User authentication parameters, for clients making a request without an `access_token`.
|
| ItemApplicationScopesUpdateRequest |
ItemApplicationScopesUpdateRequest defines the request schema for `/item/application/scopes/update`
|
| ItemApplicationScopesUpdateResponse |
ItemApplicationScopesUpdateResponse defines the response schema for `/item/application/scopes/update`
|
| ItemErrorWebhook |
Fired when an error is encountered with an Item.
|
| ItemGetRequest |
ItemGetRequest defines the request schema for `/item/get`
|
| ItemGetResponse |
ItemGetResponse defines the response schema for `/item/get` and `/item/webhook/update`
|
| ItemImportRequest |
ItemImportRequest defines the request schema for `/item/import`
|
| ItemImportRequestOptions |
An optional object to configure `/item/import` request.
|
| ItemImportRequestUserAuth |
Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
|
| ItemImportResponse |
ItemImportResponse defines the response schema for `/item/import`
|
| ItemProductReadyWebhook |
Fired once Plaid calculates income from an Item.
|
| ItemPublicTokenCreateRequest |
ItemPublicTokenCreateRequest defines the request schema for `/item/public_token/create`
|
| ItemPublicTokenCreateResponse |
ItemPublicTokenCreateResponse defines the response schema for `/item/public_token/create`
|
| ItemPublicTokenExchangeRequest |
ItemPublicTokenExchangeRequest defines the request schema for `/item/public_token/exchange`
|
| ItemPublicTokenExchangeResponse |
ItemPublicTokenExchangeResponse defines the response schema for `/item/public_token/exchange`
|
| ItemRemoveRequest |
ItemRemoveRequest defines the request schema for `/item/remove`
|
| ItemRemoveResponse |
ItemRemoveResponse defines the response schema for `/item/remove`
|
| ItemStatus |
An object with information about the status of the Item.
|
| ItemStatusInvestments |
Information about the last successful and failed investments update for the Item.
|
| ItemStatusLastWebhook |
Information about the last webhook fired for the Item.
|
| ItemStatusNullable |
ItemStatusNullable
|
| ItemStatusTransactions |
Information about the last successful and failed transactions update for the Item.
|
| ItemWebhookUpdateRequest |
ItemWebhookUpdateRequest defines the request schema for `/item/webhook/update`
|
| ItemWebhookUpdateResponse |
ItemWebhookUpdateResponse defines the response schema for `/item/webhook/update`
|
| JWKPublicKey |
A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](https://jwt.io/#libraries-io) to verify Plaid webhooks
|
| JWTHeader |
A JWT Header, used for webhook validation
|
| LiabilitiesDefaultUpdateWebhook |
The webhook of type `LIABILITIES` and code `DEFAULT_UPDATE` will be fired when new or updated liabilities have been detected on a liabilities item.
|
| LiabilitiesGetRequest |
LiabilitiesGetRequest defines the request schema for `/liabilities/get`
|
| LiabilitiesGetRequestOptions |
An optional object to filter `/liabilities/get` results.
|
| LiabilitiesGetResponse |
LiabilitiesGetResponse defines the response schema for `/liabilities/get`
|
| LiabilitiesObject |
An object containing liability accounts
|
| LiabilityOverride |
Used to configure Sandbox test data for the Liabilities product
|
| LinkTokenAccountFilters |
By default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the `products` parameter of `/link/token/create`, and, if `auth` is specified in the `products` array, will also filter out accounts other than `checking` and `savings` accounts on the Account Select pane.
|
| LinkTokenCreateRequest |
LinkTokenCreateRequest defines the request schema for `/link/token/create`
|
| LinkTokenCreateRequestAccountSubtypes |
By default, Link will only display account types that are compatible with all products supplied in the `products` parameter of `/link/token/create`.
|
| LinkTokenCreateRequestAccountSubtypesCredit |
A filter to apply to `credit`-type accounts
|
| LinkTokenCreateRequestAccountSubtypesDepository |
A filter to apply to `depository`-type accounts
|
| LinkTokenCreateRequestAccountSubtypesInvestment |
A filter to apply to `investment`-type accounts
|
| LinkTokenCreateRequestAccountSubtypesLoan |
A filter to apply to `loan`-type accounts
|
| LinkTokenCreateRequestAuth |
Specifies options for initializing Link for use with the Auth product.
|
| LinkTokenCreateRequestAuth.FlowTypeEnum.Adapter |
|
| LinkTokenCreateRequestDepositSwitch |
Specifies options for initializing Link for use with the Deposit Switch (beta) product.
|
| LinkTokenCreateRequestIncomeVerification |
Specifies options for initializing Link for use with the Income (beta) product.
|
| LinkTokenCreateRequestPaymentInitiation |
Specifies options for initializing Link for use with the Payment Initiation (Europe) product.
|
| LinkTokenCreateRequestUpdate |
Specifies options for initializing Link for [update mode](https://plaid.com/docs/link/update-mode).
|
| LinkTokenCreateRequestUser |
An object specifying information about the end user who will be linking their account.
|
| LinkTokenCreateResponse |
LinkTokenCreateResponse defines the response schema for `/link/token/create`
|
| LinkTokenEUConfig |
Configuration parameters for EU flows
|
| LinkTokenGetMetadataResponse |
An object specifying the arguments originally provided to the `/link/token/create` call.
|
| LinkTokenGetRequest |
LinkTokenGetRequest defines the request schema for `/link/token/get`
|
| LinkTokenGetResponse |
LinkTokenGetResponse defines the response schema for `/link/token/get`
|
| LoanFilter |
A filter to apply to `loan`-type accounts
|
| Location |
A representation of where a transaction took place
|
| Meta |
Allows specifying the metadata of the test account
|
| MFA |
Specifies the multi-factor authentication settings to use with this test account
|
| MortgageInterestRate |
Object containing metadata about the interest rate for the mortgage.
|
| MortgageLiability |
Contains details about a mortgage account.
|
| MortgagePropertyAddress |
Object containing fields describing property address.
|
| NetPay |
An object representing information about the net pay amount on the paystub.
|
| NewAccountsAvailableWebhook |
Fired when Plaid detects a new account for Items created or updated with [Account Select v2](https://plaid.com/docs/link/customization/#account-select).
|
| Numbers |
Account and bank identifier number data used to configure the test account.
|
| NumbersACH |
Identifying information for transferring money to or from a US account via ACH or wire transfer.
|
| NumbersACHNullable |
NumbersACHNullable
|
| NumbersBACS |
Identifying information for transferring money to or from a UK bank account via BACS.
|
| NumbersBACSNullable |
NumbersBACSNullable
|
| NumbersEFT |
Identifying information for transferring money to or from a Canadian bank account via EFT.
|
| NumbersEFTNullable |
NumbersEFTNullable
|
| NumbersInternational |
Identifying information for transferring money to or from an international bank account via wire transfer.
|
| NumbersInternationalNullable |
NumbersInternationalNullable
|
| OverrideAccounts |
Data to use to set values of test accounts.
|
| OverrideAccountType.Adapter |
|
| Owner |
Data returned from the financial institution about the owner or owners of an account.
|
| OwnerOverride |
Data about the owner or owners of an account.
|
| Pay |
An object representing a monetary amount.
|
| PayFrequency |
PayFrequency
|
| PayFrequency.ValueEnum.Adapter |
|
| PaymentAmount |
The amount and currency of a payment
|
| PaymentAmount.CurrencyEnum.Adapter |
|
| PaymentInitiationAddress |
The optional address of the payment recipient.
|
| PaymentInitiationMetadata |
Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
|
| PaymentInitiationOptionalRestrictionBacs |
PaymentInitiationOptionalRestrictionBacs
|
| PaymentInitiationPayment |
PaymentInitiationPayment defines a payment initiation payment
|
| PaymentInitiationPayment.StatusEnum.Adapter |
|
| PaymentInitiationPaymentCreateRequest |
PaymentInitiationPaymentCreateRequest defines the request schema for `/payment_initiation/payment/create`
|
| PaymentInitiationPaymentCreateResponse |
PaymentInitiationPaymentCreateResponse defines the response schema for `/payment_initiation/payment/create`
|
| PaymentInitiationPaymentCreateResponse.StatusEnum.Adapter |
|
| PaymentInitiationPaymentGetRequest |
PaymentInitiationPaymentGetRequest defines the request schema for `/payment_initiation/payment/get`
|
| PaymentInitiationPaymentGetResponse |
PaymentInitiationPaymentGetResponse defines the response schema for `/payment_initation/payment/get`
|
| PaymentInitiationPaymentGetResponse.StatusEnum.Adapter |
|
| PaymentInitiationPaymentListRequest |
PaymentInitiationPaymentListRequest defines the request schema for `/payment_initiation/payment/list`
|
| PaymentInitiationPaymentListResponse |
PaymentInitiationPaymentListResponse defines the response schema for `/payment_initiation/payment/list`
|
| PaymentInitiationPaymentReverseRequest |
PaymentInitiationPaymentReverseRequest defines the request schema for `/payment_initiation/payment/reverse`
|
| PaymentInitiationPaymentReverseResponse |
PaymentInitiationPaymentReverseResponse defines the response schema for `/payment_initation/payment/reverse`
|
| PaymentInitiationPaymentReverseResponse.StatusEnum.Adapter |
|
| PaymentInitiationPaymentTokenCreateRequest |
PaymentInitiationPaymentTokenCreateRequest defines the request schema for `/payment_initiation/payment/token/create`
|
| PaymentInitiationPaymentTokenCreateResponse |
PaymentInitiationPaymentTokenCreateResponse defines the response schema for `/payment_initiation/payment/token/create`
|
| PaymentInitiationRecipient |
PaymentInitiationRecipient defines a payment initiation recipient
|
| PaymentInitiationRecipientCreateRequest |
PaymentInitiationRecipientCreateRequest defines the request schema for `/payment_initiation/recipient/create`
|
| PaymentInitiationRecipientCreateResponse |
PaymentInitiationRecipientCreateResponse defines the response schema for `/payment_initation/recipient/create`
|
| PaymentInitiationRecipientGetRequest |
PaymentInitiationRecipientGetRequest defines the request schema for `/payment_initiation/recipient/get`
|
| PaymentInitiationRecipientGetResponse |
PaymentInitiationRecipientGetResponse defines the response schema for `/payment_initiation/recipient/get`
|
| PaymentInitiationRecipientGetResponseAllOf |
PaymentInitiationRecipientGetResponseAllOf
|
| PaymentInitiationRecipientListRequest |
PaymentInitiationRecipientListRequest defines the request schema for `/payment_initiation/recipient/list`
|
| PaymentInitiationRecipientListResponse |
PaymentInitiationRecipientListResponse defines the response schema for `/payment_initiation/recipient/list`
|
| PaymentInitiationRefund |
PaymentInitiationRefund defines a payment initiation refund
|
| PaymentInitiationRefund.StatusEnum.Adapter |
|
| PaymentInitiationStandingOrderMetadata |
Metadata specifically related to valid Payment Initiation standing order configurations for the institution.
|
| PaymentMeta |
Transaction information specific to inter-bank transfers.
|
| PaymentScheduleInterval.Adapter |
|
| PaymentStatusUpdateWebhook |
Fired when the status of a payment has changed.
|
| PaymentStatusUpdateWebhook.NewPaymentStatusEnum.Adapter |
|
| PaymentStatusUpdateWebhook.OldPaymentStatusEnum.Adapter |
|
| PayPeriodDetails |
Details about the pay period.
|
| PayPeriodDetails.PayFrequencyEnum.Adapter |
|
| Paystub |
An object representing data extracted from the end user's paystub.
|
| PaystubAddress |
PaystubAddress
|
| PaystubDeduction |
PaystubDeduction
|
| PaystubDetails |
An object representing details that can be found on the paystub.
|
| PaystubDetails.PayFrequencyEnum.Adapter |
|
| PaystubEmployer |
PaystubEmployer
|
| PaystubOverride |
An object representing data from a paystub.
|
| PaystubOverrideEmployee |
The employee on the paystub.
|
| PaystubOverrideEmployeeAddress |
The address of the employee.
|
| PaystubOverrideEmployer |
The employer on the paystub.
|
| PaystubYTDDetails |
The amount of income earned year to date, as based on paystub data.
|
| PendingExpirationWebhook |
Fired when an Item’s access consent is expiring in 7 days.
|
| PersonalFinanceCategory |
Information describing the intent of the transaction.
|
| PhoneNumber |
A phone number
|
| PhoneNumber.TypeEnum.Adapter |
|
| PlatformIds |
An object containing a set of ids related to an employee
|
| ProcessorApexProcessorTokenCreateRequest |
ProcessorApexProcessorTokenCreateRequest defines the request schema for `/processor/apex/processor_token/create`
|
| ProcessorAuthGetRequest |
ProcessorAuthGetRequest defines the request schema for `/processor/auth/get`
|
| ProcessorAuthGetResponse |
ProcessorAuthGetResponse defines the response schema for `/processor/auth/get`
|
| ProcessorBalanceGetRequest |
ProcessorBalanceGetRequest defines the request schema for `/processor/balance/get`
|
| ProcessorBalanceGetRequestOptions |
An optional object to filter `/processor/balance/get` results.
|
| ProcessorBalanceGetResponse |
ProcessorBalanceGetResponse defines the response schema for `/processor/balance/get`
|
| ProcessorBankTransferCreateRequest |
Defines the request schema for `/processor/bank_transfer/create`
|
| ProcessorBankTransferCreateResponse |
Defines the response schema for `/processor/bank_transfer/create`
|
| ProcessorIdentityGetRequest |
ProcessorIdentityGetRequest defines the request schema for `/processor/identity/get`
|
| ProcessorIdentityGetResponse |
ProcessorIdentityGetResponse defines the response schema for `/processor/identity/get`
|
| ProcessorNumber |
An object containing identifying numbers used for making electronic transfers to and from the `account`.
|
| ProcessorStripeBankAccountTokenCreateRequest |
ProcessorStripeBankAccountTokenCreateRequest defines the request schema for `/processor/stripe/bank_account/create`
|
| ProcessorStripeBankAccountTokenCreateResponse |
ProcessorStripeBankAccountTokenCreateResponse defines the response schema for `/processor/stripe/bank_account/create`
|
| ProcessorTokenCreateRequest |
ProcessorTokenCreateRequest defines the request schema for `/processor/token/create`
|
| ProcessorTokenCreateRequest.ProcessorEnum.Adapter |
|
| ProcessorTokenCreateResponse |
ProcessorTokenCreateResponse defines the response schema for `/processor/token/create` and `/processor/apex/processor_token/create`
|
| ProductAccess |
The product access being requested.
|
| Products.Adapter |
|
| ProductStatus |
A representation of the status health of a request type.
|
| ProductStatus.StatusEnum.Adapter |
|
| ProductStatusBreakdown |
A detailed breakdown of the institution's performance for a request type.
|
| ProductStatusBreakdown.RefreshIntervalEnum.Adapter |
|
| ProjectedIncomeSummaryFieldNumber |
ProjectedIncomeSummaryFieldNumber
|
| PSLFStatus |
Information about the student's eligibility in the Public Service Loan Forgiveness program.
|
| RecaptchaRequiredError |
The request was flagged by Plaid's fraud system, and requires additional verification to ensure they are not a bot.
|
| RecipientBACS |
An object containing a BACS account number and sort code.
|
| RecipientBACSNullable |
RecipientBACSNullable
|
| RecurringTransactionFrequency.Adapter |
|
| RequestedScopes |
Scope of required and optional account features or content from a ConnectedApplication.
|
| SandboxBankTransferFireWebhookRequest |
Defines the request schema for `/sandbox/bank_transfer/fire_webhook`
|
| SandboxBankTransferFireWebhookResponse |
Defines the response schema for `/sandbox/bank_transfer/fire_webhook`
|
| SandboxBankTransferSimulateRequest |
Defines the request schema for `/sandbox/bank_transfer/simulate`
|
| SandboxBankTransferSimulateResponse |
Defines the response schema for `/sandbox/bank_transfer/simulate`
|
| SandboxIncomeFireWebhookRequest |
SandboxIncomeFireWebhookRequest defines the request schema for `/sandbox/income/fire_webhook`
|
| SandboxIncomeFireWebhookRequest.VerificationStatusEnum.Adapter |
|
| SandboxIncomeFireWebhookResponse |
SandboxIncomeFireWebhookResponse defines the response schema for `/sandbox/income/fire_webhook`
|
| SandboxItemFireWebhookRequest |
SandboxItemFireWebhookRequest defines the request schema for `/sandbox/item/fire_webhook`
|
| SandboxItemFireWebhookRequest.WebhookCodeEnum.Adapter |
|
| SandboxItemFireWebhookResponse |
SandboxItemFireWebhookResponse defines the response schema for `/sandbox/item/fire_webhook`
|
| SandboxItemResetLoginRequest |
SandboxItemResetLoginRequest defines the request schema for `/sandbox/item/reset_login`
|
| SandboxItemResetLoginResponse |
SandboxItemResetLoginResponse defines the response schema for `/sandbox/item/reset_login`
|
| SandboxItemSetVerificationStatusRequest |
SandboxItemSetVerificationStatusRequest defines the request schema for `/sandbox/item/set_verification_status`
|
| SandboxItemSetVerificationStatusRequest.VerificationStatusEnum.Adapter |
|
| SandboxItemSetVerificationStatusResponse |
SandboxItemSetVerificationStatusResponse defines the response schema for `/sandbox/item/set_verification_status`
|
| SandboxOauthSelectAccountsRequest |
Defines the request schema for `sandbox/oauth/select_accounts`
|
| SandboxProcessorTokenCreateRequest |
SandboxProcessorTokenCreateRequest
|
| SandboxProcessorTokenCreateRequestOptions |
An optional set of options to be used when configuring the Item.
|
| SandboxProcessorTokenCreateResponse |
SandboxProcessorTokenCreateResponse
|
| SandboxPublicTokenCreateRequest |
SandboxPublicTokenCreateRequest defines the request schema for `/sandbox/public_token/create`
|
| SandboxPublicTokenCreateRequestOptions |
An optional set of options to be used when configuring the Item.
|
| SandboxPublicTokenCreateRequestOptionsTransactions |
SandboxPublicTokenCreateRequestOptionsTransactions is an optional set of parameters corresponding to transactions options.
|
| SandboxPublicTokenCreateResponse |
SandboxPublicTokenCreateResponse defines the response schema for `/sandbox/public_token/create`
|
| SandboxTransferSimulateRequest |
Defines the request schema for `/sandbox/transfer/simulate`
|
| SandboxTransferSimulateResponse |
Defines the response schema for `/sandbox/transfer/simulate`
|
| Scopes |
The scopes object
|
| ScopesContext.Adapter |
|
| ScopesNullable |
ScopesNullable
|
| Security |
Contains details about a security
|
| SecurityOverride |
Specify the security associated with the holding or investment transaction.
|
| SenderBACSNullable |
SenderBACSNullable
|
| ServicerAddressData |
The address of the student loan servicer.
|
| SignalAddressData |
Data about the components comprising an address.
|
| SignalDecisionReportRequest |
SignalDecisionReportRequest defines the request schema for `/signal/decision/report`
|
| SignalDecisionReportResponse |
SignalDecisionReportResponse defines the response schema for `/signal/decision/report`
|
| SignalDevice |
Details about the end user's device
|
| SignalEvaluateCoreAttributes |
The core attributes object contains additional data that can be used to assess the ACH return risk.
|
| SignalEvaluateRequest |
SignalEvaluateRequest defines the request schema for `/signal/evaluate`
|
| SignalEvaluateResponse |
SignalEvaluateResponse defines the response schema for `/signal/income/evaluate`
|
| SignalPersonName |
The user's legal name
|
| SignalReturnReportRequest |
SignalReturnReportRequest defines the request schema for `/signal/return/report`
|
| SignalReturnReportResponse |
SignalReturnReportResponse defines the response schema for `/signal/return/report`
|
| SignalScores |
Risk scoring details broken down by risk category.
|
| SignalUser |
Details about the end user initiating the transaction (i.e., the account holder).
|
| StandaloneAccountType |
The schema below describes the various `types` and corresponding `subtypes` that Plaid recognizes and reports for financial institution accounts.
|
| StandaloneCurrencyCodeList |
The following currency codes are supported by Plaid.
|
| StandaloneInvestmentTransactionType |
Valid values for investment transaction types and subtypes.
|
| StudentLoan |
Contains details about a student loan account
|
| StudentLoanRepaymentModel |
Student loan repayment information used to configure Sandbox test data for the Liabilities product
|
| StudentLoanStatus |
An object representing the status of the student loan
|
| StudentLoanStatus.TypeEnum.Adapter |
|
| StudentRepaymentPlan |
An object representing the repayment plan for the student loan
|
| StudentRepaymentPlan.TypeEnum.Adapter |
|
| Taxform |
Taxform
|
| TaxpayerID |
Taxpayer ID of the individual receiving the paystub.
|
| Total |
An object representing both the current pay period and year to date amount for a category.
|
| Total.CanonicalDescriptionEnum.Adapter |
|
| Transaction |
A representation of a transaction
|
| Transaction.PaymentChannelEnum.Adapter |
|
| Transaction.TransactionTypeEnum.Adapter |
|
| TransactionAllOf |
TransactionAllOf
|
| TransactionAllOf.PaymentChannelEnum.Adapter |
|
| TransactionBase |
A representation of a transaction
|
| TransactionBase.TransactionTypeEnum.Adapter |
|
| TransactionCode.Adapter |
|
| TransactionData |
Information about the matched direct deposit transaction used to verify a user's payroll information.
|
| TransactionOverride |
Data to populate as test transaction data.
|
| TransactionsGetRequest |
TransactionsGetRequest defines the request schema for `/transactions/get`
|
| TransactionsGetRequestOptions |
An optional object to be used with the request.
|
| TransactionsGetResponse |
TransactionsGetResponse defines the response schema for `/transactions/get`
|
| TransactionsRecurringGetRequest |
TransactionsRecurringGetRequest defines the request schema for `/transactions/recurring/get`
|
| TransactionsRecurringGetResponse |
TransactionsRecurringGetResponse defines the response schema for `/transactions/recurring/get`
|
| TransactionsRefreshRequest |
TransactionsRefreshRequest defines the request schema for `/transactions/refresh`
|
| TransactionsRefreshResponse |
TransactionsRefreshResponse defines the response schema for `/transactions/refresh`
|
| TransactionsRemovedWebhook |
Fired when transaction(s) for an Item are deleted.
|
| TransactionStream |
A grouping of related transactions
|
| TransactionStreamAmount |
Object with data pertaining to an amount on the transaction stream.
|
| Transfer |
Represents a transfer within the Transfers API.
|
| TransferAuthorization |
TransferAuthorization contains the authorization decision for a proposed transfer
|
| TransferAuthorization.DecisionEnum.Adapter |
|
| TransferAuthorizationCreateRequest |
Defines the request schema for `/transfer/authorization/create`
|
| TransferAuthorizationCreateResponse |
Defines the response schema for `/transfer/authorization/create`
|
| TransferAuthorizationDecisionRationale |
The rationale for Plaid's decision regarding a proposed transfer.
|
| TransferAuthorizationDecisionRationale.CodeEnum.Adapter |
|
| TransferAuthorizationDevice |
Information about the device being used to initiate the authorization.
|
| TransferAuthorizationProposedTransfer |
Details regarding the proposed transfer.
|
| TransferCancelRequest |
Defines the request schema for `/transfer/cancel`
|
| TransferCancelResponse |
Defines the response schema for `/transfer/cancel`
|
| TransferCreateRequest |
Defines the request schema for `/transfer/create`
|
| TransferCreateResponse |
Defines the response schema for `/transfer/create`
|
| TransferEvent |
Represents an event in the Transfers API.
|
| TransferEventListRequest |
Defines the request schema for `/transfer/event/list`
|
| TransferEventListRequest.TransferTypeEnum.Adapter |
|
| TransferEventListResponse |
Defines the response schema for `/transfer/event/list`
|
| TransferEventSyncRequest |
Defines the request schema for `/transfer/event/sync`
|
| TransferEventSyncResponse |
Defines the response schema for `/transfer/event/sync`
|
| TransferEventType.Adapter |
|
| TransferFailure |
The failure reason if the type of this transfer is `\"failed\"` or `\"reversed\"`.
|
| TransferGetRequest |
Defines the request schema for `/transfer/get`
|
| TransferGetResponse |
Defines the response schema for `/transfer/get`
|
| TransferListRequest |
Defines the request schema for `/transfer/list`
|
| TransferListResponse |
Defines the response schema for `/transfer/list`
|
| TransferNetwork.Adapter |
|
| TransferStatus.Adapter |
|
| TransferType.Adapter |
|
| TransferUserAddressInRequest |
The address associated with the account holder.
|
| TransferUserAddressInResponse |
The address associated with the account holder.
|
| TransferUserInRequest |
The legal name and other information for the account holder.
|
| TransferUserInResponse |
The legal name and other information for the account holder.
|
| UserCustomPassword |
Custom test accounts are configured with a JSON configuration object formulated according to the schema below.
|
| UserPermissionRevokedWebhook |
The `USER_PERMISSION_REVOKED` webhook is fired to when an end user has used the [my.plaid.com portal](https://my.plaid.com) to revoke the permission that they previously granted to access an Item.
|
| VerificationExpiredWebhook |
Fired when an Item was not verified via automated micro-deposits after ten days since the automated micro-deposit was made.
|
| VerificationRefreshStatus.Adapter |
|
| VerificationStatus.Adapter |
|
| W2 |
W2 is an object that represents income data taken from a W2 tax document.
|
| W2Box12 |
W2Box12
|
| W2StateAndLocalWages |
W2StateAndLocalWages
|
| Warning |
It is possible for an Asset Report to be returned with missing account owner information.
|
| Warning.WarningCodeEnum.Adapter |
|
| WebhookUpdateAcknowledgedWebhook |
Fired when an Item's webhook is updated.
|
| WebhookVerificationKeyGetRequest |
WebhookVerificationKeyGetRequest defines the request schema for `/webhook_verification_key/get`
|
| WebhookVerificationKeyGetResponse |
WebhookVerificationKeyGetResponse defines the response schema for `/webhook_verification_key/get`
|
| YTDGrossIncomeSummaryFieldNumber |
YTDGrossIncomeSummaryFieldNumber
|
| YTDNetIncomeSummaryFieldNumber |
YTDNetIncomeSummaryFieldNumber
|