plaid2.model package

Submodules

Module contents

class plaid2.model.AccountAccess(*, unique_id: str, authorized: Optional[bool] = None, account_product_access: Optional[AccountProductAccess] = None)[source]

Bases: BaseModel

account_product_access: Optional[AccountProductAccess]

Allow the application to access specific products on this account

authorized: Optional[bool]

Allow the application to see this account (and associated details, including balance) in the list of accounts If unset, defaults to true.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AccountAccess[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountAccess[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unique_id: str

The unique account identifier for this account. This value must match that returned by the data access API for this account.

class plaid2.model.AccountBalance(*, available: Optional[float] = None, iso_currency_code: Optional[str] = None, limit: Optional[float] = None, current: Optional[float] = None, unofficial_currency_code: Optional[str] = None, last_updated_datetime: Optional[str] = None)[source]

Bases: BaseModel

available: Optional[float]

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.

current: Optional[float]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_updated_datetime: Optional[str]

mm:ssZ`) indicating the last time that the balance for the given account has been updated

This is currently only provided when the min_last_updated_datetime is passed when calling /accounts/balance/get for ins_128026 (Capital One).

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH

limit: Optional[float]

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.

classmethod parse_obj(data: Any) → AccountBalance[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountBalance[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.

class plaid2.model.AccountBase(*, subtype: Optional[str] = None, name: str, balances: AccountBalance, official_name: Optional[str] = None, mask: Optional[str] = None, verification_status: Optional[str] = None, account_id: str, type: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
account_id: str

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.

balances: AccountBalance

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mask: Optional[str]

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_: str

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

official_name: Optional[str]

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

classmethod parse_obj(data: Any) → AccountBase[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountBase[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

subtype: Optional[str]

//plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.

Type

See the [Account type schema](https

type: str

` 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](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.

Type

`investment

verification_status: Optional[str]

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 two amounts.

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.

class plaid2.model.AccountFilter(*, depository: Optional[List[str]] = None, credit: Optional[List[str]] = None, loan: Optional[List[str]] = None, investment: Optional[List[str]] = None)[source]

Bases: BaseModel

credit: Optional[List[str]]

A list of account subtypes to be filtered.

depository: Optional[List[str]]

A list of account subtypes to be filtered.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: Optional[List[str]]

A list of account subtypes to be filtered.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: Optional[List[str]]

A list of account subtypes to be filtered.

classmethod parse_obj(data: Any) → AccountFilter[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountFilter[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountFiltersResponse(*, loan: Optional[List[str]] = None, depository: Optional[List[str]] = None, investment: Optional[List[str]] = None, credit: Optional[List[str]] = None)[source]

Bases: BaseModel

credit: Optional[List[str]]

A filter to apply to credit-type accounts

depository: Optional[List[str]]

A filter to apply to depository-type accounts

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: Optional[List[str]]

A filter to apply to investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: Optional[List[str]]

A filter to apply to loan-type accounts

classmethod parse_obj(data: Any) → AccountFiltersResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountFiltersResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountIdsWithUpdatedIdentity[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AccountIdsWithUpdatedIdentity[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountIdsWithUpdatedIdentity[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountProductAccess(*, account_data: Optional[bool] = None, statements: Optional[bool] = None, tax_documents: Optional[bool] = None)[source]

Bases: BaseModel

account_data: Optional[bool]

Allow the application to access account data. Only used by certain partners. If relevant to the partner and unset, defaults to true.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AccountProductAccess[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountProductAccess[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

statements: Optional[bool]

Allow the application to access bank statements. Only used by certain partners. If relevant to the partner and unset, defaults to true.

tax_documents: Optional[bool]

Allow the application to access tax documents. Only used by certain partners. If relevant to the partner and unset, defaults to true.

class plaid2.model.AccountSelectionCardinality(value)[source]

Bases: str, Enum

An enumeration.

all = 'ALL'
multi_select = 'MULTI_SELECT'
single_select = 'SINGLE_SELECT'
class plaid2.model.AccountSubtype(value)[source]

Bases: str, Enum

An enumeration.

auto = 'auto'
brokerage = 'brokerage'
business = 'business'
cash_isa = 'cash isa'
cash_management = 'cash management'
cd = 'cd'
checking = 'checking'
commercial = 'commercial'
construction = 'construction'
consumer = 'consumer'
credit_card = 'credit card'
crypto_exchange = 'crypto exchange'
ebt = 'ebt'
education_savings_account = 'education savings account'
fixed_annuity = 'fixed annuity'
gic = 'gic'
health_reimbursement_arrangement = 'health reimbursement arrangement'
home_equity = 'home equity'
hsa = 'hsa'
ira = 'ira'
isa = 'isa'
keogh = 'keogh'
lif = 'lif'
life_insurance = 'life insurance'
line_of_credit = 'line of credit'
lira = 'lira'
loan = 'loan'
lrif = 'lrif'
lrsp = 'lrsp'
money_market = 'money market'
mortgage = 'mortgage'
mutual_fund = 'mutual fund'
non_taxable_brokerage_account = 'non-taxable brokerage account'
other = 'other'
other_annuity = 'other annuity'
other_insurance = 'other insurance'
overdraft = 'overdraft'
paypal = 'paypal'
payroll = 'payroll'
pension = 'pension'
prepaid = 'prepaid'
prif = 'prif'
profit_sharing_plan = 'profit sharing plan'
rdsp = 'rdsp'
recurring = 'recurring'
resp = 'resp'
retirement = 'retirement'
rewards = 'rewards'
rlif = 'rlif'
roth = 'roth'
roth_401_k = 'roth 401k'
rrif = 'rrif'
rrsp = 'rrsp'
safe_deposit = 'safe deposit'
sarsep = 'sarsep'
savings = 'savings'
sep_ira = 'sep ira'
simple_ira = 'simple ira'
sipp = 'sipp'
stock_plan = 'stock plan'
student = 'student'
tfsa = 'tfsa'
thrift_savings_plan = 'thrift savings plan'
trust = 'trust'
ugma = 'ugma'
utma = 'utma'
variable_annuity = 'variable annuity'
class plaid2.model.AccountType(value)[source]

Bases: str, Enum

An enumeration.

brokerage = 'brokerage'
credit = 'credit'
depository = 'depository'
investment = 'investment'
loan = 'loan'
other = 'other'
class plaid2.model.AccountsBalanceGetRequest(*, access_token: str, options: Optional[AccountsBalanceGetRequestOptions] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[AccountsBalanceGetRequestOptions]

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

classmethod parse_obj(data: Any) → AccountsBalanceGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountsBalanceGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountsBalanceGetRequestOptions(*, account_ids: Optional[List[str]] = None, min_last_updated_datetime: Optional[str] = None)[source]

Bases: BaseModel

account_ids: Optional[List[str]]

A list of account_ids to retrieve for the Item. The default value is null.

Note: An error will be returned if a provided account_id is not associated with the Item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

min_last_updated_datetime: Optional[str]

mm:ssZ`) indicating the oldest acceptable balance when making a request to /accounts/balance/get.

If the balance that is pulled for ins_128026 (Capital One) is older than the given timestamp, 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.

This field is only used when the institution is ins_128026 (Capital One), 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, this field is ignored.

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH

classmethod parse_obj(data: Any) → AccountsBalanceGetRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountsBalanceGetRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountsGetRequest(*, access_token: str, options: Optional[List[str]] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /accounts/get results.

classmethod parse_obj(data: Any) → AccountsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AccountsGetResponse(*, item: Item, request_id: str, accounts: List[AccountBase])[source]

Bases: BaseModel

accounts: List[AccountBase]

An array of financial institution accounts associated with the Item. If /accounts/balance/get was called, each account will include real-time balance information.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AccountsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AccountsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AchClass(value)[source]

Bases: str, Enum

An enumeration.

ccd = 'ccd'
ppd = 'ppd'
tel = 'tel'
web = 'web'
class plaid2.model.Address(*, data: AddressData, primary: Optional[bool] = None)[source]

Bases: BaseModel

data: AddressData

Data about the components comprising an address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Address[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Address[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

primary: Optional[bool]

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

class plaid2.model.AddressData(*, city: str, region: Optional[str] = None, street: str, postal_code: Optional[str] = None, country: Optional[str] = None)[source]

Bases: BaseModel

city: str

The full city name

country: Optional[str]

The ISO 3166-1 alpha-2 country code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AddressData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AddressData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

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

region: Optional[str]

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

street: str

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

class plaid2.model.AddressPurposeLabel(value)[source]

Bases: str, Enum

An enumeration.

commercial = 'commercial'
no_data = 'no_data'
residential = 'residential'
class plaid2.model.Application(*, country_code: Optional[str] = None, join_date: str, name: str, application_id: str, logo_url: Optional[str] = None, company_legal_name: Optional[str] = None, city: Optional[str] = None, region: Optional[str] = None, reason_for_access: Optional[str] = None, postal_code: Optional[str] = None, display_name: Optional[str] = None, application_url: Optional[str] = None, use_case: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
application_id: str

This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.

application_url: Optional[str]

The URL for the application’s website

city: Optional[str]

A string representing the city of the client’s headquarters.

A string representing the name of client’s legal entity.

country_code: Optional[str]

A string representing the country code of the client’s headquarters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

display_name: Optional[str]

A human-readable name of the application for display purposes

join_date: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.

Type

The date this application was granted production access at Plaid in [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

logo_url: Optional[str]

A URL that links to the application logo image.

name_: str

The name of the application

classmethod parse_obj(data: Any) → Application[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Application[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

A string representing the postal code of the client’s headquarters.

reason_for_access: Optional[str]

A string provided by the connected app stating why they use their respective enabled products.

region: Optional[str]

A string representing the region of the client’s headquarters.

use_case: Optional[str]

A string representing client’s broad use case as assessed by Plaid.

class plaid2.model.ApplicationGetResponse(*, request_id: str, application: Application)[source]

Bases: BaseModel

application: Application

Metadata about the application

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ApplicationGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ApplicationGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.Apr(*, apr_percentage: float, interest_charge_amount: Optional[float] = None, balance_subject_to_apr: Optional[float] = None, apr_type: str)[source]

Bases: BaseModel

apr_percentage: float

Annual Percentage Rate applied.

apr_type: str

The type of balance to which the APR applies.

balance_subject_to_apr: Optional[float]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

interest_charge_amount: Optional[float]

Amount of money charged due to interest from last statement.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Apr[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Apr[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReport(*, items: List[AssetReportItem], date_generated: str, asset_report_id: str, days_requested: float, user: AssetReportUser, client_report_id: Optional[str] = None)[source]

Bases: BaseModel

asset_report_id: str

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

client_report_id: Optional[str]

An identifier you determine and submit for the Asset Report.

date_generated: str

32:11Z”).

Type

The date and time when the Asset Report was created, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (e.g. “2018-04-12T03

days_requested: float

The duration of transaction history you requested

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

items: List[AssetReportItem]

Data returned by Plaid about each of the Items included in the Asset Report.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReport[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReport[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user: AssetReportUser

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

class plaid2.model.AssetReportAuditCopyCreateRequest(*, asset_report_token: str, auditor_id: str)[source]

Bases: BaseModel

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

auditor_id: str

The auditor_id of the third party with whom you would like to share the Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportAuditCopyCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportAuditCopyCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportAuditCopyCreateResponse(*, audit_copy_token: str, request_id: str)[source]

Bases: BaseModel

audit_copy_token: str

A token that can be shared with a third party auditor to allow them to obtain access to the Asset Report. This token should be stored securely.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportAuditCopyCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportAuditCopyCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportAuditCopyRemoveResponse(*, request_id: str, removed: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportAuditCopyRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportAuditCopyRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: bool

true if the Audit Copy was successfully removed.

request_id: str

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

class plaid2.model.AssetReportCreateRequest(*, options: Optional[AssetReportCreateRequestOptions] = None, days_requested: int, access_tokens: List[str])[source]

Bases: BaseModel

access_tokens: List[str]

An array of access tokens corresponding to the Items that will be included in the report. The assets product must have been initialized for the Items during link; the Assets product cannot be added after initialization.

days_requested: int

The maximum integer number of days of history to include in the Asset Report. If using Fannie Mae Day 1 Certainty, days_requested must be at least 61 for new originations or at least 31 for refinancings.

An Asset Report requested with “Additional History” (that is, with more than 61 days of transaction history) will incur an Additional History fee.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[AssetReportCreateRequestOptions]

An optional object to filter /asset_report/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for Fannie Mae’s Day 1 Certainty program.

classmethod parse_obj(data: Any) → AssetReportCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportCreateRequestOptions(*, webhook: Optional[str] = None, products: Optional[List[str]] = None, user: Optional[AssetReportUser] = None, client_report_id: Optional[str] = None, include_fast_report: Optional[bool] = None)[source]

Bases: BaseModel

client_report_id: Optional[str]

Client-generated identifier, which can be used by lenders to track loan applications.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_fast_report: Optional[bool]

true to return balance and identity earlier as a fast report. Defaults to false if omitted.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportCreateRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportCreateRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: Optional[List[str]]

“investments”

Type

Additional information that can be included in the asset report. Possible values

user: Optional[AssetReportUser]

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

webhook: Optional[str]

URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.

class plaid2.model.AssetReportCreateResponse(*, request_id: str, asset_report_token: str, asset_report_id: str)[source]

Bases: BaseModel

asset_report_id: str

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportFilterRequest(*, asset_report_token: str, account_ids_to_exclude: List[str])[source]

Bases: BaseModel

account_ids_to_exclude: List[str]

The accounts to exclude from the Asset Report, identified by account_id.

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportFilterRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportFilterRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportFilterResponse(*, request_id: str, asset_report_token: str, asset_report_id: str)[source]

Bases: BaseModel

asset_report_id: str

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportFilterResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportFilterResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportGetRequest(*, include_insights: Optional[bool] = None, fast_report: Optional[bool] = None, asset_report_token: str)[source]

Bases: BaseModel

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

fast_report: Optional[bool]

true to fetch “fast” version of asset report. Defaults to false if omitted.

include_insights: Optional[bool]

true if you would like to retrieve the Asset Report with Insights, false otherwise. This field defaults to false if omitted.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportGetResponse(*, report: AssetReport, request_id: str, warnings: List[Warning])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

report: AssetReport

An object representing an Asset Report

request_id: str

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

warnings: List[Warning]

If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing

class plaid2.model.AssetReportItem(*, accounts: List[AccountAssets], item_id: str, date_last_updated: str, institution_id: str, institution_name: str)[source]

Bases: BaseModel

accounts: List[AccountAssets]

Data about each of the accounts open on the Item.

date_last_updated: str

//wikipedia.org/wiki/ISO_8601) format.

Type

The date and time when this Item’s data was last retrieved from the financial institution, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: str

The id of the financial institution associated with the Item.

institution_name: str

The full financial institution name associated with the Item.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportPdfGetResponse(*, __root__: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportPdfGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportPdfGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportRefreshRequest(*, options: Optional[AssetReportRefreshRequestOptions] = None, days_requested: Optional[int] = None, asset_report_token: str)[source]

Bases: BaseModel

asset_report_token: str

The asset_report_token returned by the original call to /asset_report/create

days_requested: Optional[int]

The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to /asset_report/create will be used.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[AssetReportRefreshRequestOptions]

An optional object to filter /asset_report/refresh results. If provided, cannot be null. If not specified, the options from the original call to /asset_report/create will be used.

classmethod parse_obj(data: Any) → AssetReportRefreshRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRefreshRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AssetReportRefreshRequestOptions(*, client_report_id: Optional[str] = None, webhook: Optional[str] = None, user: Optional[AssetReportUser] = None)[source]

Bases: BaseModel

client_report_id: Optional[str]

Client-generated identifier, which can be used by lenders to track loan applications.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRefreshRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRefreshRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user: Optional[AssetReportUser]

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

webhook: Optional[str]

URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.

class plaid2.model.AssetReportRefreshResponse(*, asset_report_id: str, request_id: str, asset_report_token: str)[source]

Bases: BaseModel

asset_report_id: str

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportRelayCreateRequest(*, asset_report_token: str, secondary_client_id: str, webhook: Optional[str] = None)[source]

Bases: BaseModel

asset_report_token: str

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRelayCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRelayCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

secondary_client_id: str

The secondary_client_id is the client id of the third party with whom you would like to share the Asset Report.

webhook: Optional[str]

URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling asset_report/relay/get.

class plaid2.model.AssetReportRelayCreateResponse(*, asset_relay_token: str, request_id: str)[source]

Bases: BaseModel

asset_relay_token: str

A token that can be shared with a third party to allow them to access the Asset Report. This token should be stored securely.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRelayCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRelayCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportRelayRefreshRequest(*, asset_relay_token: str, webhook: Optional[str] = None)[source]

Bases: BaseModel

asset_relay_token: str
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRelayRefreshRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRelayRefreshRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook: Optional[str]

The URL registered to receive webhooks when the Asset Report of a Relay Token has been refreshed.

class plaid2.model.AssetReportRelayRefreshResponse(*, asset_report_id: str, request_id: str, asset_relay_token: str)[source]

Bases: BaseModel

asset_relay_token: str
asset_report_id: str

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRelayRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRelayRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AssetReportRelayRemoveResponse(*, removed: bool, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRelayRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRelayRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: bool

true if the Asset Relay token was successfully removed.

request_id: str

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

class plaid2.model.AssetReportRemoveResponse(*, request_id: str, removed: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetReportRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: bool

true if the Asset Report was successfully removed.

request_id: str

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

class plaid2.model.AssetReportUser(*, last_name: Optional[str] = None, first_name: Optional[str] = None, phone_number: Optional[str] = None, email: Optional[str] = None, middle_name: Optional[str] = None, ssn: Optional[str] = None, client_user_id: Optional[str] = None)[source]

Bases: BaseModel

client_user_id: Optional[str]

An identifier you determine and submit for the user.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email: Optional[str]

The user’s email address.

first_name: Optional[str]

The user’s first name. Required for the Fannie Mae Day 1 Certainty™ program.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_name: Optional[str]

The user’s last name. Required for the Fannie Mae Day 1 Certainty™ program.

middle_name: Optional[str]

The user’s middle name

classmethod parse_obj(data: Any) → AssetReportUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetReportUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

“+14151234567”. Phone numbers provided in other formats will be parsed on a best-effort basis.

Type

The user’s phone number, in E.164 format

Type

+{countrycode}{number}. For example

ssn: Optional[str]

The user’s Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.

Format: “ddd-dd-dddd”

class plaid2.model.AssetsErrorWebhook(*, asset_report_id: str, error: Optional[Error] = None, webhook_code: str, webhook_type: str)[source]

Bases: BaseModel

asset_report_id: str

The ID associated with the Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetsErrorWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetsErrorWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

ERROR

webhook_type: str

ASSETS

class plaid2.model.AssetsProductReadyWebhook(*, webhook_type: str, asset_report_id: str, webhook_code: str)[source]

Bases: BaseModel

asset_report_id: str

The asset_report_id that can be provided to /asset_report/get to retrieve the Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetsProductReadyWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetsProductReadyWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

PRODUCT_READY

webhook_type: str

ASSETS

class plaid2.model.AssetsRelayWebhook(*, asset_relay_token: str, relay_event: str, secondary_client_id: str, webhook_type: str, webhook_code: str, asset_report_id: str)[source]

Bases: BaseModel

asset_relay_token: str

The asset_relay_token that was created by calling `/asset_report/relay/create.

asset_report_id: str

The asset_report_id that can be provided to /asset_report/relay/get to retrieve the Asset Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AssetsRelayWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AssetsRelayWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_event: str

The webhook code indicating which endpoint was called. It can be one of GET_CALLED, REFRESH_CALLED or AUDIT_COPY_CREATE_CALLED.

secondary_client_id: str

The id of the client with whom the Asset Report is being shared.

webhook_code: str

RELAY_EVENT

webhook_type: str

ASSETS

class plaid2.model.AuthGetNumbers(*, eft: List[NumbersEft], bacs: List[NumbersBacs], ach: List[NumbersAch], international: List[NumbersInternational])[source]

Bases: BaseModel

ach: List[NumbersAch]

An array of ACH numbers identifying accounts.

bacs: List[NumbersBacs]

An array of BACS numbers identifying accounts.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

eft: List[NumbersEft]

An array of EFT numbers identifying accounts.

international: List[NumbersInternational]

An array of IBAN numbers identifying accounts.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AuthGetNumbers[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AuthGetNumbers[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AuthGetRequest(*, access_token: str, options: Optional[List[str]] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /auth/get results.

classmethod parse_obj(data: Any) → AuthGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AuthGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AuthGetResponse(*, accounts: List[AccountBase], numbers: AuthGetNumbers, request_id: str, item: Item)[source]

Bases: BaseModel

accounts: List[AccountBase]

The accounts for which numbers are being retrieved.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

numbers: AuthGetNumbers

An object containing identifying numbers used for making electronic transfers to and from the accounts. 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 any accounts for which data has been requested, the array for that type will be empty.

classmethod parse_obj(data: Any) → AuthGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AuthGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.AuthSupportedMethods(*, instant_auth: bool, instant_match: bool, automated_micro_deposits: bool)[source]

Bases: BaseModel

automated_micro_deposits: bool

Indicates if automated microdeposits are supported.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

instant_auth: bool

Indicates if instant auth is supported.

instant_match: bool

Indicates if instant match is supported.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AuthSupportedMethods[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AuthSupportedMethods[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.AutomaticallyVerifiedWebhook(*, webhook_code: str, account_id: str, item_id: str, webhook_type: str)[source]

Bases: BaseModel

account_id: str

The account_id of the account associated with the webhook

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → AutomaticallyVerifiedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → AutomaticallyVerifiedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

AUTOMATICALLY_VERIFIED

webhook_type: str

AUTH

class plaid2.model.BankInitiatedReturnRisk(*, risk_tier: int, score: int)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankInitiatedReturnRisk[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankInitiatedReturnRisk[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

risk_tier: int

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%

score: int

a higher risk score suggests a higher return likelihood.

Type

A score from 0-99 that indicates the transaction return risk

class plaid2.model.BankTransfer(*, metadata: Optional[BankTransferMetadata] = None, origination_account_id: str, amount: str, ach_class: str, direction: Optional[str] = None, created: str, cancellable: bool, network: str, iso_currency_code: str, status: str, type: str, account_id: str, description: str, failure_reason: Optional[BankTransferFailure] = None, custom_tag: Optional[str] = None, id: str, user: BankTransferUser)[source]

Bases: BaseModel

account_id: str

The account ID that should be credited/debited for this bank transfer.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).

cancellable: bool

When true, you can still cancel this bank transfer.

created: str

05Z`

Type

The datetime when this bank transfer was created. This will be of the form `2006-01-02T15

Type

04

custom_tag: Optional[str]

A string containing the custom tag provided by the client in the create request. Will be null if not provided.

description: str

The description of the transfer.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

direction: Optional[str]

outbound for API-initiated transfers, or inbound for payments received by the FBO account.

Type

Indicates the direction of the transfer

failure_reason: Optional[BankTransferFailure]

The failure reason if the type of this transfer is “failed” or “reversed”. Null value otherwise.

id: str

Plaid’s unique identifier for a bank transfer.

iso_currency_code: str

The currency of the transfer amount, e.g. “USD”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[BankTransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str

The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

origination_account_id: str

Plaid’s unique identifier for the origination account that was used for this transfer.

classmethod parse_obj(data: Any) → BankTransfer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransfer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

The status of the transfer.

type: str

The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: BankTransferUser

The legal name and other information for the account holder.

class plaid2.model.BankTransferBalance(*, available: str, transactable: str)[source]

Bases: BaseModel

available: str

The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferBalance[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferBalance[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactable: str

The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.

class plaid2.model.BankTransferBalanceGetResponse(*, request_id: str, balance: BankTransferBalance, origination_account_id: Optional[str] = None)[source]

Bases: BaseModel

balance: BankTransferBalance

Information about the balance of a bank transfer

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

origination_account_id: Optional[str]

The ID of the origination account that this balance belongs to.

classmethod parse_obj(data: Any) → BankTransferBalanceGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferBalanceGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferCancelResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferCancelResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferCancelResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferCreateRequest(*, type: str, amount: str, custom_tag: Optional[str] = None, description: str, metadata: Optional[BankTransferMetadata] = None, iso_currency_code: str, ach_class: Optional[str] = None, account_id: str, network: str, idempotency_key: str, origination_account_id: Optional[str] = None, user: BankTransferUser, access_token: str)[source]

Bases: BaseModel

access_token: str

The Plaid access_token for the account that will be debited or credited.

account_id: str

The Plaid account_id for the account that will be debited or credited.

ach_class: Optional[str]

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).

custom_tag: Optional[str]

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

description: str

The transfer description. Maximum of 10 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique bank transfer. Maximum of 50 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

iso_currency_code: str

The currency of the transfer amount – should be set to “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[BankTransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str

The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

origination_account_id: Optional[str]

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.

classmethod parse_obj(data: Any) → BankTransferCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: str

The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: BankTransferUser

The legal name and other information for the account holder.

class plaid2.model.BankTransferCreateResponse(*, request_id: str, bank_transfer: BankTransfer)[source]

Bases: BaseModel

bank_transfer: BankTransfer

Represents a bank transfer within the Bank Transfers API.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferDirection(value)[source]

Bases: str, Enum

An enumeration.

inbound = 'inbound'
outbound = 'outbound'
class plaid2.model.BankTransferEvent(*, origination_account_id: Optional[str] = None, timestamp: str, account_id: str, event_type: str, bank_transfer_id: str, bank_transfer_type: str, failure_reason: Optional[BankTransferFailure] = None, bank_transfer_amount: str, event_id: int, bank_transfer_iso_currency_code: str, direction: Optional[str] = None)[source]

Bases: BaseModel

account_id: str

The account ID associated with the bank transfer.

bank_transfer_amount: str

The bank transfer amount.

bank_transfer_id: str

Plaid’s unique identifier for a bank transfer.

bank_transfer_iso_currency_code: str

The currency of the bank transfer amount.

bank_transfer_type: str

The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

direction: Optional[str]

outbound for API-initiated transfers, or inbound for payments received by the FBO account.

Type

Indicates the direction of the transfer

event_id: int

Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.

event_type: str

The type of event that this bank transfer represents.

pending: A new transfer was created; it is in the pending state.

cancelled: The transfer was cancelled by the client.

failed: The transfer failed, no funds were moved.

posted: The transfer has been successfully submitted to the payment network.

reversed: A posted transfer was reversed.

failure_reason: Optional[BankTransferFailure]

The failure reason if the type of this transfer is “failed” or “reversed”. Null value otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

origination_account_id: Optional[str]

The ID of the origination account that this balance belongs to.

classmethod parse_obj(data: Any) → BankTransferEvent[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferEvent[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

timestamp: str

05Z`.

Type

The datetime when this event occurred. This will be of the form `2006-01-02T15

Type

04

class plaid2.model.BankTransferEventListBankTransferType(value)[source]

Bases: str, Enum

An enumeration.

credit = 'credit'
debit = 'debit'
class plaid2.model.BankTransferEventListDirection(value)[source]

Bases: str, Enum

An enumeration.

inbound = 'inbound'
outbound = 'outbound'
class plaid2.model.BankTransferEventListRequest(*, end_date: Optional[str] = None, bank_transfer_id: Optional[str] = None, offset: Optional[int] = None, direction: Optional[str] = None, account_id: Optional[str] = None, bank_transfer_type: Optional[str] = None, origination_account_id: Optional[str] = None, event_types: Optional[List[str]] = None, count: Optional[int] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

The account ID to get events for all transactions to/from an account.

bank_transfer_id: Optional[str]

Plaid’s unique identifier for a bank transfer.

bank_transfer_type: Optional[str]

The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.

count: Optional[int]

The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

direction: Optional[str]

for API-initiated transfers inbound: for payments received by the FBO account.

Type

Indicates the direction of the transfer

Type

outbound

end_date: Optional[str]

49Z`)

Type

The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

event_types: Optional[List[str]]

Filter events by event type.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The offset into the list of bank transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned.

origination_account_id: Optional[str]

The origination account ID to get events for transfers from a specific origination account.

classmethod parse_obj(data: Any) → BankTransferEventListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferEventListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

49Z`)

Type

The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

class plaid2.model.BankTransferEventListResponse(*, bank_transfer_events: List[BankTransferEvent], request_id: str)[source]

Bases: BaseModel

bank_transfer_events: List[BankTransferEvent]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferEventListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferEventListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferEventSyncRequest(*, count: Optional[int] = None, after_id: int)[source]

Bases: BaseModel

after_id: int

The latest (largest) event_id fetched via the sync endpoint, or 0 initially.

count: Optional[int]

The maximum number of bank transfer events to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferEventSyncRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferEventSyncRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.BankTransferEventSyncResponse(*, request_id: str, bank_transfer_events: List[BankTransferEvent])[source]

Bases: BaseModel

bank_transfer_events: List[BankTransferEvent]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferEventSyncResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferEventSyncResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferEventType(value)[source]

Bases: str, Enum

An enumeration.

cancelled = 'cancelled'
failed = 'failed'
pending = 'pending'
posted = 'posted'
reversed = 'reversed'
class plaid2.model.BankTransferFailure(*, ach_return_code: Optional[str] = None, description: Optional[str] = None)[source]

Bases: BaseModel

ach_return_code: Optional[str]

//plaid.com/docs/errors/bank-transfers/#ach-return-codes).

Type

The ACH return code, e.g. R01. A return code will be provided if and only if the transfer status is reversed. For a full listing of ACH return codes, see [Bank Transfers errors](https

description: Optional[str]

A human-readable description of the reason for the failure or reversal.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferFailure[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferFailure[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.BankTransferGetResponse(*, request_id: str, bank_transfer: BankTransfer)[source]

Bases: BaseModel

bank_transfer: BankTransfer

Represents a bank transfer within the Bank Transfers API.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferListRequest(*, start_date: Optional[str] = None, offset: Optional[int] = None, origination_account_id: Optional[str] = None, count: Optional[int] = None, direction: Optional[str] = None, end_date: Optional[str] = None)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of bank transfers to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

direction: Optional[str]

outbound for API-initiated transfers, or inbound for payments received by the FBO account.

Type

Indicates the direction of the transfer

end_date: Optional[str]

49Z`)

Type

The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of bank transfers to skip before returning results.

origination_account_id: Optional[str]

Filter bank transfers to only those originated through the specified origination account.

classmethod parse_obj(data: Any) → BankTransferListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

49Z`)

Type

The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

class plaid2.model.BankTransferListResponse(*, request_id: str, bank_transfers: List[BankTransfer])[source]

Bases: BaseModel

bank_transfers: List[BankTransfer]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferMetadata[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.BankTransferMigrateAccountRequest(*, wire_routing_number: Optional[str] = None, account_number: str, routing_number: str, account_type: str)[source]

Bases: BaseModel

account_number: str

The user’s account number.

account_type: str

The type of the bank account (checking or savings).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferMigrateAccountRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferMigrateAccountRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

routing_number: str

The user’s routing number.

wire_routing_number: Optional[str]

The user’s wire transfer routing number. This is the ABA number; for some institutions, this may differ from the ACH number used in routing_number.

class plaid2.model.BankTransferMigrateAccountResponse(*, access_token: str, account_id: str, request_id: str)[source]

Bases: BaseModel

access_token: str

The Plaid access_token for the newly created Item.

account_id: str

The Plaid account_id for the newly created Item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferMigrateAccountResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferMigrateAccountResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.BankTransferNetwork(value)[source]

Bases: str, Enum

An enumeration.

ach = 'ach'
same_day_ach = 'same-day-ach'
wire = 'wire'
class plaid2.model.BankTransferStatus(value)[source]

Bases: str, Enum

An enumeration.

cancelled = 'cancelled'
failed = 'failed'
pending = 'pending'
posted = 'posted'
reversed = 'reversed'
class plaid2.model.BankTransferSweep(*, iso_currency_code: str, id: str, created_at: str, amount: str)[source]

Bases: BaseModel

amount: str

The amount of the sweep.

created_at: str

The datetime when the sweep occurred, in RFC 3339 format.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

Identifier of the sweep.

iso_currency_code: str

The currency of the sweep, e.g. “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferSweep[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferSweep[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.BankTransferSweepGetResponse(*, request_id: str, sweep: BankTransferSweep)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferSweepGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferSweepGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

sweep: BankTransferSweep

BankTransferSweep describes a sweep transfer.

class plaid2.model.BankTransferSweepListRequest(*, origination_account_id: Optional[str] = None, count: Optional[int] = None, end_time: Optional[str] = None, start_time: Optional[str] = None)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of sweeps to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_time: Optional[str]

The end datetime of sweeps to return (RFC 3339 format).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

origination_account_id: Optional[str]

If multiple origination accounts are available, origination_account_id must be used to specify the account that the sweeps belong to.

classmethod parse_obj(data: Any) → BankTransferSweepListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferSweepListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_time: Optional[str]

The start datetime of sweeps to return (RFC 3339 format).

class plaid2.model.BankTransferSweepListResponse(*, sweeps: List[BankTransferSweep], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransferSweepListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferSweepListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

sweeps: List[BankTransferSweep]
class plaid2.model.BankTransferType(value)[source]

Bases: str, Enum

An enumeration.

credit = 'credit'
debit = 'debit'
class plaid2.model.BankTransferUser(*, email_address: Optional[str] = None, routing_number: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The account holder’s email.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The account holder’s full legal name. If the transfer ach_class is ccd, this should be the business name of the account holder.

classmethod parse_obj(data: Any) → BankTransferUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransferUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

routing_number: Optional[str]

The account holder’s routing number. This field is only used in response data. Do not provide this field when making requests.

class plaid2.model.BankTransfersEventsUpdateWebhook(*, webhook_type: str, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → BankTransfersEventsUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → BankTransfersEventsUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

BANK_TRANSFERS_EVENTS_UPDATE

webhook_type: str

BANK_TRANSFERS

class plaid2.model.CategoriesGetRequest[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CategoriesGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CategoriesGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CategoriesGetResponse(*, request_id: str, categories: List[Category])[source]

Bases: BaseModel

categories: List[Category]

An array of all of the transaction categories used by Plaid.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CategoriesGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CategoriesGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.Category(*, category_id: str, hierarchy: List[str], group: str)[source]

Bases: BaseModel

category_id: str

An identifying number for the category. category_id is a Plaid-specific identifier and does not necessarily correspond to merchant category codes.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

group: str

place for physical transactions or special for other transactions such as bank charges.

hierarchy: List[str]

A hierarchical array of the categories to which this category_id belongs.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Category[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Category[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.Cause[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Cause[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Cause[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ClientProvidedEnhancedTransaction(*, iso_currency_code: str, enhancements: Enhancements, id: str, description: str, amount: float)[source]

Bases: BaseModel

amount: float

The value of the transaction, denominated in the account’s currency, as stated in iso_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.

description: str

The raw description of the transaction.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

enhancements: Enhancements

A grouping of the Plaid produced transaction enhancement fields.

id: str

Unique transaction identifier to tie transactions back to clients’ systems.

iso_currency_code: str

The ISO-4217 currency code of the transaction.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ClientProvidedEnhancedTransaction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ClientProvidedEnhancedTransaction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ClientProvidedRawTransaction(*, description: str, amount: float, id: str, iso_currency_code: str)[source]

Bases: BaseModel

amount: float

The value of the transaction, denominated in the account’s currency, as stated in iso_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.

description: str

The raw description of the transaction.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

Unique transaction identifier to tie transactions back to clients’ systems.

iso_currency_code: str

The ISO-4217 currency code of the transaction.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ClientProvidedRawTransaction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ClientProvidedRawTransaction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ConnectedApplication(*, application_url: Optional[str] = None, reason_for_access: Optional[str] = None, display_name: Optional[str] = None, created_at: str, scopes: Optional[Scopes] = None, logo_url: Optional[str] = None, application_id: str, name: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
application_id: str

This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.

application_url: Optional[str]

The URL for the application’s website

created_at: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.

Type

The date this application was linked in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

display_name: Optional[str]

A human-readable name of the application for display purposes

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

logo_url: Optional[str]

A URL that links to the application logo image.

name_: str

The name of the application

classmethod parse_obj(data: Any) → ConnectedApplication[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ConnectedApplication[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

reason_for_access: Optional[str]

A string provided by the connected app stating why they use their respective enabled products.

scopes: Optional[Scopes]

The scopes object

class plaid2.model.CountryCode(value)[source]

Bases: str, Enum

An enumeration.

ca = 'CA'
de = 'DE'
es = 'ES'
fr = 'FR'
gb = 'GB'
ie = 'IE'
it = 'IT'
nl = 'NL'
us = 'US'
class plaid2.model.CreateEntityScreeningRequest(*, search_terms: EntityWatchlistSearchTerms, client_user_id: Optional[str] = None)[source]

Bases: BaseModel

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreateEntityScreeningRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreateEntityScreeningRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

search_terms: EntityWatchlistSearchTerms

Search inputs for creating an entity watchlist screening

class plaid2.model.CreateEntityWatchlistScreeningReviewRequest(*, comment: Optional[str] = None, dismissed_hits: List[str], confirmed_hits: List[str], entity_watchlist_screening_id: str)[source]

Bases: BaseModel

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

entity_watchlist_screening_id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreateEntityWatchlistScreeningReviewRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreateEntityWatchlistScreeningReviewRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreateIndividualWatchlistScreeningReviewRequest(*, confirmed_hits: List[str], watchlist_screening_id: str, dismissed_hits: List[str], comment: Optional[str] = None)[source]

Bases: BaseModel

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreateIndividualWatchlistScreeningReviewRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreateIndividualWatchlistScreeningReviewRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_screening_id: str

ID of the associated screening.

class plaid2.model.Credit1099(*, payer_state_number: Optional[str] = None, card_not_present_transaction: Optional[float] = None, crop_insurance_proceeds: Optional[float] = None, merchant_category_code: Optional[str] = None, march_amount: Optional[float] = None, april_amount: Optional[float] = None, june_amount: Optional[float] = None, payer: Optional[Credit1099Payer] = None, september_amount: Optional[float] = None, state_income_lower: Optional[float] = None, february_amount: Optional[float] = None, november_amount: Optional[float] = None, document_metadata: Optional[CreditDocumentMetadata] = None, filer: Optional[Credit1099Filer] = None, section_409_a_income: Optional[float] = None, secondary_state_id: Optional[str] = None, recipient: Optional[Credit1099Recipient] = None, payer_state_number_lower: Optional[str] = None, december_amount: Optional[float] = None, primary_state: Optional[str] = None, fishing_boat_proceeds: Optional[float] = None, other_income: Optional[float] = None, section_409_a_deferrals: Optional[float] = None, july_amount: Optional[float] = None, october_amount: Optional[float] = None, primary_state_income_tax: Optional[float] = None, rents: Optional[float] = None, primary_state_id: Optional[str] = None, august_amount: Optional[float] = None, form_1099_type: Optional[str] = None, january_amount: Optional[float] = None, nonemployee_compensation: Optional[float] = None, gross_amount: Optional[float] = None, tax_year: Optional[str] = None, state_tax_withheld_lower: Optional[float] = None, secondary_state: Optional[str] = None, document_id: Optional[str] = None, state_income: Optional[float] = None, gross_proceeds_paid_to_an_attorney: Optional[float] = None, royalties: Optional[float] = None, pse_name: Optional[str] = None, substitute_payments_in_lieu_of_dividends_or_interest: Optional[float] = None, pse_telephone_number: Optional[str] = None, number_of_payment_transactions: Optional[str] = None, may_amount: Optional[float] = None, medical_and_healthcare_payments: Optional[float] = None, secondary_state_income_tax: Optional[float] = None, payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer: Optional[str] = None, state_tax_withheld: Optional[float] = None, federal_income_tax_withheld: Optional[float] = None, excess_golden_parachute_payments: Optional[float] = None, transactions_reported: Optional[str] = None)[source]

Bases: BaseModel

april_amount: Optional[float]

Amount reported for April.

august_amount: Optional[float]

Amount reported for August.

card_not_present_transaction: Optional[float]

Amount in card not present transactions.

crop_insurance_proceeds: Optional[float]

Amount of crop insurance proceeds.

december_amount: Optional[float]

Amount reported for December.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_id: Optional[str]

An identifier of the document referenced by the document metadata.

document_metadata: Optional[CreditDocumentMetadata]

Object representing metadata pertaining to the document.

excess_golden_parachute_payments: Optional[float]

Amount of golden parachute payments made by payer.

february_amount: Optional[float]

Amount reported for February.

federal_income_tax_withheld: Optional[float]

Amount of federal income tax withheld from payer.

filer: Optional[Credit1099Filer]

An object representing a filer used by 1099-K tax documents.

fishing_boat_proceeds: Optional[float]

Amount of fishing boat proceeds from payer.

form_1099_type: Optional[str]

Form 1099 Type

gross_amount: Optional[float]

Gross amount reported.

gross_proceeds_paid_to_an_attorney: Optional[float]

Amount of gross proceeds paid to an attorney by payer.

january_amount: Optional[float]

Amount reported for January.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

july_amount: Optional[float]

Amount reported for July.

june_amount: Optional[float]

Amount reported for June.

march_amount: Optional[float]

Amount reported for March.

may_amount: Optional[float]

Amount reported for May.

medical_and_healthcare_payments: Optional[float]

Amount of medical and healthcare payments from payer.

merchant_category_code: Optional[str]

Merchant category of filer.

nonemployee_compensation: Optional[float]

Amount of nonemployee compensation from payer.

november_amount: Optional[float]

Amount reported for November.

number_of_payment_transactions: Optional[str]

Number of payment transactions made.

october_amount: Optional[float]

Amount reported for October.

other_income: Optional[float]

Amount in other income by payer.

classmethod parse_obj(data: Any) → Credit1099[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Credit1099[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payer: Optional[Credit1099Payer]

An object representing a payer used by 1099-MISC tax documents.

payer_made_direct_sales_of_5000_or_more_of_consumer_products_to_buyer: Optional[str]

Whether or not payer made direct sales over $5000 of consumer products.

payer_state_number: Optional[str]

Primary state ID.

payer_state_number_lower: Optional[str]

Secondary state ID.

primary_state: Optional[str]

Primary state of business.

primary_state_id: Optional[str]

Primary state ID.

primary_state_income_tax: Optional[float]

State income tax reported for primary state.

pse_name: Optional[str]

Name of the PSE (Payment Settlement Entity).

pse_telephone_number: Optional[str]

Formatted (XXX) XXX-XXXX. Phone number of the PSE (Payment Settlement Entity).

recipient: Optional[Credit1099Recipient]

An object representing a recipient used in both 1099-K and 1099-MISC tax documents.

rents: Optional[float]

Amount in rent by payer.

royalties: Optional[float]

Amount in royalties by payer.

secondary_state: Optional[str]

Secondary state of business.

secondary_state_id: Optional[str]

Secondary state ID.

secondary_state_income_tax: Optional[float]

State income tax reported for secondary state.

section_409_a_deferrals: Optional[float]

Amount of 409A deferrals earned by payer.

section_409_a_income: Optional[float]

Amount of 409A income earned by payer.

september_amount: Optional[float]

Amount reported for September.

state_income: Optional[float]

State income reported for primary state.

state_income_lower: Optional[float]

State income reported for secondary state.

state_tax_withheld: Optional[float]

Amount of state tax withheld of payer for primary state.

state_tax_withheld_lower: Optional[float]

Amount of state tax withheld of payer for secondary state.

substitute_payments_in_lieu_of_dividends_or_interest: Optional[float]

Amount of substitute payments made by payer.

tax_year: Optional[str]

Tax year of the tax form.

transactions_reported: Optional[str]

One of the values will be provided Payment card Third party network

class plaid2.model.Credit1099Filer(*, address: Optional[CreditPayStubAddress] = None, name: Optional[str] = None, type: Optional[str] = None, tin: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[CreditPayStubAddress]

Address on the pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

Name of filer.

classmethod parse_obj(data: Any) → Credit1099Filer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Credit1099Filer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

tin: Optional[str]

Tax identification number of filer.

type: Optional[str]

Payment Settlement Entity (PSE), Electronic Payment Fecilitator (EPF), Other Third Party

Type

One of the following values will be provided

class plaid2.model.Credit1099Payer(*, tin: Optional[str] = None, address: Optional[CreditPayStubAddress] = None, telephone_number: Optional[str] = None, name: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[CreditPayStubAddress]

Address on the pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

Name of payer.

classmethod parse_obj(data: Any) → Credit1099Payer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Credit1099Payer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

telephone_number: Optional[str]

Telephone number of payer.

tin: Optional[str]

Tax identification number of payer.

class plaid2.model.Credit1099Recipient(*, name: Optional[str] = None, address: Optional[CreditPayStubAddress] = None, facta_filing_requirement: Optional[str] = None, tin: Optional[str] = None, second_tin_exists: Optional[str] = None, account_number: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
account_number: Optional[str]

Account number number of recipient.

address: Optional[CreditPayStubAddress]

Address on the pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

facta_filing_requirement: Optional[str]

Checked if FACTA is a filing requirement.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

Name of recipient.

classmethod parse_obj(data: Any) → Credit1099Recipient[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Credit1099Recipient[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

second_tin_exists: Optional[str]

Checked if 2nd TIN exists.

tin: Optional[str]

Tax identification number of recipient.

class plaid2.model.CreditAccountSubtype(value)[source]

Bases: str, Enum

An enumeration.

all = 'all'
credit_card = 'credit card'
paypal = 'paypal'
class plaid2.model.CreditAuditCopyTokenCreateRequest(*, report_tokens: List[ReportToken], auditor_id: str)[source]

Bases: BaseModel

auditor_id: str

The auditor_id of the third party with whom you would like to share the Asset Report and/or Income Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditAuditCopyTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditAuditCopyTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

report_tokens: List[ReportToken]

List of report tokens; can include both Asset Report tokens and Income Report tokens.

class plaid2.model.CreditAuditCopyTokenCreateResponse(*, request_id: str, audit_copy_token: str)[source]

Bases: BaseModel

audit_copy_token: str

A token that can be shared with a third party auditor to allow them to obtain access to the Asset or Income Report. This token should be stored securely.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditAuditCopyTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditAuditCopyTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditAuditCopyTokenRemoveResponse(*, request_id: str, removed: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditAuditCopyTokenRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditAuditCopyTokenRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: bool

true if the Audit Copy was successfully removed.

request_id: str

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

class plaid2.model.CreditBankIncome(*, items: Optional[List[CreditBankIncomeItem]] = None, bank_income_id: Optional[str] = None, days_requested: Optional[int] = None, generated_time: Optional[str] = None, bank_income_summary: Optional[CreditBankIncomeSummary] = None, warnings: Optional[List[CreditBankIncomeWarning]] = None)[source]

Bases: BaseModel

bank_income_id: Optional[str]

The unique identifier associated with the Bank Income Report.

bank_income_summary: Optional[CreditBankIncomeSummary]

Summary for bank income across all income sources and items (max history of 730 days).

days_requested: Optional[int]

The number of days requested by the customer for the Bank Income Report.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

generated_time: Optional[str]

The time when the Bank Income Report was generated.

items: Optional[List[CreditBankIncomeItem]]

The list of Items in the report along with the associated metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncome[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncome[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

warnings: Optional[List[CreditBankIncomeWarning]]

If data from the Bank Income report was unable to be retrieved, the warnings will contain information about the error that caused the data to be incomplete.

class plaid2.model.CreditBankIncomeAccount(*, owners: Optional[List[Owner]] = None, mask: Optional[str] = None, account_id: Optional[str] = None, subtype: Optional[str] = None, name: Optional[str] = None, official_name: Optional[str] = None, type: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
account_id: Optional[str]

Plaid’s unique identifier for the account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mask: Optional[str]

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_: Optional[str]

The name of the bank account.

official_name: Optional[str]

The official name of the bank account.

owners: Optional[List[Owner]]
classmethod parse_obj(data: Any) → CreditBankIncomeAccount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeAccount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

subtype: Optional[str]

//plaid.com/docs/api/accounts/#StandaloneAccountType-depository).

Type

Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see [Account schemas](https

type: Optional[str]

The account type. This will always be depository.

class plaid2.model.CreditBankIncomeAccountType(value)[source]

Bases: str, Enum

An enumeration.

depository = 'depository'
class plaid2.model.CreditBankIncomeCategory(value)[source]

Bases: str, Enum

An enumeration.

bank_interest = 'BANK_INTEREST'
cash = 'CASH'
child_support = 'CHILD_SUPPORT'
gig_economy = 'GIG_ECONOMY'
long_term_disability = 'LONG_TERM_DISABILITY'
military = 'MILITARY'
other = 'OTHER'
rental = 'RENTAL'
retirement = 'RETIREMENT'
salary = 'SALARY'
unemployment = 'UNEMPLOYMENT'
class plaid2.model.CreditBankIncomeCause(*, error_type: Optional[str] = None, error_message: Optional[str] = None, item_id: Optional[str] = None, error_code: Optional[str] = None, display_message: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

display_message: Optional[str]

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.

error_code: Optional[str]

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. Error fields will be null if no error has occurred.

error_message: Optional[str]

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

error_type: Optional[str]

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

item_id: Optional[str]

The item_id of the Item associated with this warning.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeCause[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeCause[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreditBankIncomeErrorType(value)[source]

Bases: str, Enum

An enumeration.

access_not_granted = 'ACCESS_NOT_GRANTED'
country_not_supported = 'COUNTRY_NOT_SUPPORTED'
institution_down = 'INSTITUTION_DOWN'
institution_no_longer_supported = 'INSTITUTION_NO_LONGER_SUPPORTED'
institution_not_responding = 'INSTITUTION_NOT_RESPONDING'
insufficient_credentials = 'INSUFFICIENT_CREDENTIALS'
internal_server_error = 'INTERNAL_SERVER_ERROR'
invalid_credentials = 'INVALID_CREDENTIALS'
invalid_mfa = 'INVALID_MFA'
invalid_send_method = 'INVALID_SEND_METHOD'
item_locked = 'ITEM_LOCKED'
item_login_required = 'ITEM_LOGIN_REQUIRED'
item_not_supported = 'ITEM_NOT_SUPPORTED'
mfa_not_supported = 'MFA_NOT_SUPPORTED'
no_accounts = 'NO_ACCOUNTS'
user_setup_required = 'USER_SETUP_REQUIRED'
class plaid2.model.CreditBankIncomeGetRequest(*, user_token: Optional[str] = None, options: Optional[int] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[int]

An optional object for /credit/bank_income/get request options.

classmethod parse_obj(data: Any) → CreditBankIncomeGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_token: Optional[str]

The user token associated with the User data is being requested for.

class plaid2.model.CreditBankIncomeGetResponse(*, bank_income: Optional[List[CreditBankIncome]] = None, request_id: str)[source]

Bases: BaseModel

bank_income: Optional[List[CreditBankIncome]]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditBankIncomeHistoricalSummary(*, start_date: Optional[str] = None, total_amount: Optional[float] = None, unofficial_currency_code: Optional[str] = None, end_date: Optional[str] = None, transactions: Optional[List[CreditBankIncomeTransaction]] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

iso_currency_code: Optional[str]

The ISO 4217 currency code of the amount or balance.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeHistoricalSummary[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeHistoricalSummary[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]

Total amount of earnings for the income source(s) of the user for the month in the summary.

transactions: Optional[List[CreditBankIncomeTransaction]]
unofficial_currency_code: Optional[str]

The unofficial currency code associated with the amount or 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.

class plaid2.model.CreditBankIncomeItem(*, item_id: Optional[str] = None, bank_income_accounts: Optional[List[CreditBankIncomeAccount]] = None, bank_income_sources: Optional[List[CreditBankIncomeSource]] = None, last_updated_time: Optional[str] = None, institution_id: Optional[str] = None, institution_name: Optional[str] = None)[source]

Bases: BaseModel

bank_income_accounts: Optional[List[CreditBankIncomeAccount]]

The Item’s accounts that have Bank Income data.

bank_income_sources: Optional[List[CreditBankIncomeSource]]

The income sources for this Item. Each entry in the array is a single income source.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: Optional[str]

The unique identifier of the institution associated with the Item.

institution_name: Optional[str]

The name of the institution associated with the Item.

item_id: Optional[str]

The unique identifier for the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_updated_time: Optional[str]

The time when this Item’s data was last retrieved from the financial institution.

classmethod parse_obj(data: Any) → CreditBankIncomeItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreditBankIncomePayFrequency(value)[source]

Bases: str, Enum

An enumeration.

biweekly = 'BIWEEKLY'
monthly = 'MONTHLY'
semi_monthly = 'SEMI_MONTHLY'
unknown = 'UNKNOWN'
weekly = 'WEEKLY'
class plaid2.model.CreditBankIncomePdfGetResponse(*, __root__: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomePdfGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomePdfGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreditBankIncomeRefreshRequest(*, options: Optional[CreditBankIncomeRefreshRequestOptions] = None, user_token: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[CreditBankIncomeRefreshRequestOptions]

An optional object for /credit/bank_income/refresh request options.

classmethod parse_obj(data: Any) → CreditBankIncomeRefreshRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeRefreshRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_token: str

The user token associated with the User data is being requested for.

class plaid2.model.CreditBankIncomeRefreshRequestOptions(*, days_requested: Optional[int] = None, webhook: Optional[str] = None)[source]

Bases: BaseModel

days_requested: Optional[int]

How many days of data to include in the refresh. If not specified, this will default to the days requested in the most recently generated bank income report for the user.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeRefreshRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeRefreshRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook: Optional[str]

The URL where Plaid will send the bank income webhook.

class plaid2.model.CreditBankIncomeRefreshResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditBankIncomeSource(*, total_amount: Optional[float] = None, income_category: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, income_source_id: Optional[str] = None, historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]] = None, transaction_count: Optional[int] = None, pay_frequency: Optional[str] = None, account_id: Optional[str] = None, income_description: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

Plaid’s unique idenfier for the account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]]
income_category: Optional[str]

The income category.

income_description: Optional[str]

The most common name or original description for the underlying income transactions.

income_source_id: Optional[str]

A unique identifier for an income source.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeSource[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeSource[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_frequency: Optional[str]

The income pay frequency.

start_date: Optional[str]

Minimum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]

Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.

transaction_count: Optional[int]

Number of transactions for the income source within the start and end date.

class plaid2.model.CreditBankIncomeSummary(*, income_sources_count: Optional[int] = None, unofficial_currency_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, income_categories_count: Optional[int] = None, total_amount: Optional[float] = None, income_transactions_count: Optional[int] = None, historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

The latest date in which all income sources identified by Plaid appear in the user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

historical_summary: Optional[List[CreditBankIncomeHistoricalSummary]]
income_categories_count: Optional[int]

Number of income categories per end user.

income_sources_count: Optional[int]

Number of income sources per end user.

income_transactions_count: Optional[int]

Number of income transactions per end user.

iso_currency_code: Optional[str]

The ISO 4217 currency code of the amount or balance.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeSummary[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeSummary[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

The earliest date within the days requested in which all income sources identified by Plaid appear in a user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

total_amount: Optional[float]

Total amount of earnings across all the income sources in the end user’s Items for the days requested by the client.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the amount or 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.

class plaid2.model.CreditBankIncomeTransaction(*, unofficial_currency_code: Optional[str] = None, name: Optional[str] = None, amount: Optional[float] = None, check_number: Optional[str] = None, iso_currency_code: Optional[str] = None, pending: Optional[bool] = None, transaction_id: Optional[str] = None, date: Optional[str] = None, original_description: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
amount: Optional[float]

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, credit card purchases are positive; credit card payment, direct deposits, and refunds are negative.

check_number: Optional[str]

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

date: Optional[str]

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).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

The ISO 4217 currency code of the amount or balance.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The merchant name or transaction description.

original_description: Optional[str]

The string returned by the financial institution to describe the transaction.

classmethod parse_obj(data: Any) → CreditBankIncomeTransaction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeTransaction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pending: Optional[bool]

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

transaction_id: Optional[str]

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

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the amount or 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.

class plaid2.model.CreditBankIncomeWarning(*, warning_code: Optional[str] = None, warning_type: Optional[str] = None, cause: Optional[CreditBankIncomeCause] = None)[source]

Bases: BaseModel

cause: Optional[CreditBankIncomeCause]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditBankIncomeWarning[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditBankIncomeWarning[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

warning_code: Optional[str]

The warning code identifies a specific kind of warning. IDENTITY_UNAVAILABLE: Unable to extract identity for the Item TRANSACTIONS_UNAVAILABLE: Unable to extract transactions for the Item ITEM_UNAPPROVED: User did not grant permission to share income data for the Item REPORT_DELETED: Report deleted due to customer or consumer request

warning_type: Optional[str]

The warning type which will always be BANK_INCOME_WARNING.

class plaid2.model.CreditBankIncomeWarningCode(value)[source]

Bases: str, Enum

An enumeration.

identity_unavailable = 'IDENTITY_UNAVAILABLE'
item_unapproved = 'ITEM_UNAPPROVED'
report_deleted = 'REPORT_DELETED'
transactions_unavailable = 'TRANSACTIONS_UNAVAILABLE'
class plaid2.model.CreditBankIncomeWarningType(value)[source]

Bases: str, Enum

An enumeration.

bank_income_warning = 'BANK_INCOME_WARNING'
class plaid2.model.CreditCardLiability(*, minimum_payment_amount: Optional[float] = None, last_statement_balance: Optional[float] = None, account_id: Optional[str] = None, last_payment_amount: Optional[float] = None, next_payment_due_date: Optional[str] = None, is_overdue: Optional[bool] = None, aprs: List[Apr], last_payment_date: Optional[str] = None, last_statement_issue_date: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

The ID of the account that this liability belongs to.

aprs: List[Apr]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

is_overdue: Optional[bool]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: Optional[float]

The amount of the last payment.

last_payment_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.

Type

The date of the last payment. Dates are returned in an [ISO 8601](https

last_statement_balance: Optional[float]

The total amount owed as of the last statement issued

last_statement_issue_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date of the last statement. Dates are returned in an [ISO 8601](https

minimum_payment_amount: Optional[float]

The minimum payment due for the next billing cycle.

next_payment_due_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

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](https

classmethod parse_obj(data: Any) → CreditCardLiability[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditCardLiability[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreditDocumentMetadata(*, name: str, document_type: Optional[str] = None, status: Optional[str] = None, download_url: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_type: Optional[str]

The type of document.

PAYSTUB: A paystub.

BANK_STATEMENT: A bank statement.

US_TAX_W2: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.

US_MILITARY_ERAS: An electronic Retirement Account Statement (eRAS) issued by the US military.

US_MILITARY_LES: A Leave and Earnings Statement (LES) issued by the US military.

US_MILITARY_CLES: A Civilian Leave and Earnings Statment (CLES) issued by the US military.

GIG: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.

NONE: Used to indicate that there is no underlying document for the data.

UNKNOWN: Document type could not be determined.

download_url: Optional[str]

Signed URL to retrieve the underlying file.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the document.

classmethod parse_obj(data: Any) → CreditDocumentMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditDocumentMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: Optional[str]

The processing status of the document.

class plaid2.model.CreditEmploymentGetResponse(*, items: List[CreditEmploymentItem], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

items: List[CreditEmploymentItem]

Array of employment items.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditEmploymentGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditEmploymentGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditEmploymentItem(*, employments: List[CreditEmploymentVerification], pull_id: str, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employments: List[CreditEmploymentVerification]
item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditEmploymentItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditEmploymentItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pull_id: str

A reference id to reference what payroll data was returned from this endpoint

class plaid2.model.CreditEmploymentVerification(*, status: Optional[str] = None, employer: str, last_paystub_date: Optional[str] = None, end_date: Optional[str] = None, start_date: Optional[str] = None, title: Optional[str] = None, platform_ids: CreditPlatformIds, account_id: Optional[str] = None, employee_type: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee_type: Optional[str]

The type of employment for the individual. “FULL_TIME”: A full-time employee. “PART_TIME”: A part-time employee. “CONTRACTOR”: An employee typically hired externally through a contracting group. “TEMPORARY”: A temporary employee. “OTHER”: The employee type is not one of the above defined types.

employer: str

An object containing employer data.

end_date: Optional[str]

End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_paystub_date: Optional[str]

The date of the employee’s most recent paystub in ISO 8601 format (YYYY-MM-DD).

classmethod parse_obj(data: Any) → CreditEmploymentVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditEmploymentVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

platform_ids: CreditPlatformIds

The object containing a set of ids related to an employee.

start_date: Optional[str]

Start of employment in ISO 8601 format (YYYY-MM-DD).

status: Optional[str]

Current employment status.

title: Optional[str]

Current title of employee.

class plaid2.model.CreditPayStub(*, employee: CreditPayStubEmployee, deductions: CreditPayStubDeductions, employer: CreditPayStubEmployer, document_id: Optional[str] = None, document_metadata: CreditDocumentMetadata, pay_period_details: PayStubPayPeriodDetails, net_pay: CreditPayStubNetPay, verification: Optional[CreditPayStubVerification] = None, earnings: CreditPayStubEarnings)[source]

Bases: BaseModel

deductions: CreditPayStubDeductions

An object with the deduction information found on a pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_id: Optional[str]

An identifier of the document referenced by the document metadata.

document_metadata: CreditDocumentMetadata

Object representing metadata pertaining to the document.

earnings: CreditPayStubEarnings

An object representing both a breakdown of earnings on a pay stub and the total earnings.

employee: CreditPayStubEmployee

Data about the employee.

employer: CreditPayStubEmployer

Information about the employer on the pay stub.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

net_pay: CreditPayStubNetPay

An object representing information about the net pay amount on the pay stub.

classmethod parse_obj(data: Any) → CreditPayStub[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStub[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_period_details: PayStubPayPeriodDetails

Details about the pay period.

verification: Optional[CreditPayStubVerification]

(To be deprecated) Verification info will be moved to a separate endpoint in the future. An object containing details on the paystub’s verification status. This object will only be populated if the [income_verification.access_tokens](/docs/api/tokens/#link-token-create-request-income-verification-access-tokens) parameter was provided during the /link/token/create call or if a problem was detected with the information supplied by the user; otherwise it will be null.

class plaid2.model.CreditPayStubAddress(*, postal_code: Optional[str] = None, region: Optional[str] = None, country: Optional[str] = None, city: Optional[str] = None, street: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name.

country: Optional[str]

The ISO 3166-1 alpha-2 country code.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayStubAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code of the address.

region: Optional[str]

The region or state. Example: “NC”

street: Optional[str]

The full street address.

class plaid2.model.CreditPayStubDeductions(*, total: PayStubDeductionsTotal, breakdown: List[PayStubDeductionsBreakdown])[source]

Bases: BaseModel

breakdown: List[PayStubDeductionsBreakdown]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayStubDeductions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubDeductions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

total: PayStubDeductionsTotal

An object representing the total deductions for the pay period

class plaid2.model.CreditPayStubEarnings(*, breakdown: List[PayStubEarningsBreakdown], total: PayStubEarningsTotal)[source]

Bases: BaseModel

breakdown: List[PayStubEarningsBreakdown]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayStubEarnings[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubEarnings[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

total: PayStubEarningsTotal

An object representing both the current pay period and year to date amount for an earning category.

class plaid2.model.CreditPayStubEmployee(*, address: CreditPayStubAddress, name: Optional[str] = None, taxpayer_id: PayStubTaxpayerId, marital_status: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: CreditPayStubAddress

Address on the pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

marital_status: Optional[str]

Marital status of the employee - either SINGLE or MARRIED.

name_: Optional[str]

The name of the employee.

classmethod parse_obj(data: Any) → CreditPayStubEmployee[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubEmployee[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

taxpayer_id: PayStubTaxpayerId

Taxpayer ID of the individual receiving the paystub.

class plaid2.model.CreditPayStubEmployer(*, name: Optional[str] = None, address: CreditPayStubAddress)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: CreditPayStubAddress

Address on the pay stub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The name of the employer on the pay stub.

classmethod parse_obj(data: Any) → CreditPayStubEmployer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubEmployer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.CreditPayStubNetPay(*, description: Optional[str] = None, ytd_amount: Optional[float] = None, current_amount: Optional[float] = None, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the net pay for the pay period.

description: Optional[str]

Description of the net pay.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayStubNetPay[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubNetPay[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the net pay.

class plaid2.model.CreditPayStubVerification(*, verification_attributes: List[PayStubVerificationAttribute], verification_status: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayStubVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayStubVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

verification_attributes: List[PayStubVerificationAttribute]
verification_status: Optional[str]

Derived verification status.

class plaid2.model.CreditPayrollIncomeGetResponse(*, request_id: str, error: Optional[Error] = None, items: List[PayrollItem])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

items: List[PayrollItem]

Array of payroll items.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayrollIncomeGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayrollIncomeGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditPayrollIncomePrecheckRequest(*, us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo] = None, access_tokens: Optional[List[str]] = None, employer: Optional[IncomeVerificationPrecheckEmployer] = None, user_token: Optional[str] = None)[source]

Bases: BaseModel

access_tokens: Optional[List[str]]

An array of access tokens corresponding to Items belonging to the user whose eligibility is being checked. Note that if the Items specified here are not already initialized with transactions, providing them in this field will cause these Items to be initialized with (and billed for) the Transactions product.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer: Optional[IncomeVerificationPrecheckEmployer]

Information about the end user’s employer

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayrollIncomePrecheckRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayrollIncomePrecheckRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo]

Data about military info in the income verification precheck.

user_token: Optional[str]

The user token associated with the User data is being requested for.

class plaid2.model.CreditPayrollIncomePrecheckResponse(*, request_id: str, confidence: str)[source]

Bases: BaseModel

confidence: str

The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload. One of the following:

“HIGH”: It is very likely that this user can use the digital income verification flow.

“LOW”: It is unlikely that this user can use the digital income verification flow.

“UNKNOWN”: It was not possible to determine if the user is supportable with the information passed.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayrollIncomePrecheckResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayrollIncomePrecheckResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditPayrollIncomeRefreshResponse(*, request_id: str, verification_refresh_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayrollIncomeRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayrollIncomeRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

verification_refresh_status: str

The verification refresh status. One of the following:

“USER_PRESENCE_REQUIRED” User presence is required to refresh an income verification. “SUCCESSFUL” The income verification refresh was successful. “NOT_FOUND” No new data was found after the income verification refresh.

class plaid2.model.CreditPayrollIncomeRiskSignalsGetResponse(*, error: Optional[Error] = None, request_id: str, items: List[PayrollRiskSignalsItem])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

items: List[PayrollRiskSignalsItem]

Array of payroll items.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPayrollIncomeRiskSignalsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPayrollIncomeRiskSignalsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.CreditPlatformIds(*, employee_id: Optional[str] = None, position_id: Optional[str] = None, payroll_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee_id: Optional[str]

The ID of an employee as given by their employer.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditPlatformIds[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditPlatformIds[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payroll_id: Optional[str]

The ID of an employee as given by their payroll.

position_id: Optional[str]

The ID of the position of the employee.

class plaid2.model.CreditRelayCreateRequest(*, webhook: Optional[str] = None, report_tokens: List[ReportToken], secondary_client_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

report_tokens: List[ReportToken]

List of report tokens, with at most one token of each report type. Currently only Asset Report token is supported.

secondary_client_id: str

The secondary_client_id is the client id of the third party with whom you would like to share the Relay Token.

webhook: Optional[str]

URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling /credit/relay/get.

class plaid2.model.CreditRelayCreateResponse(*, request_id: str, relay_token: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_token: str

A token that can be shared with a third party to allow them to access the Asset Report. This token should be stored securely.

request_id: str

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

class plaid2.model.CreditRelayGetRequest(*, report_type: str, relay_token: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_token: str

The relay_token granting access to the report you would like to get.

report_type: str

The report type. It can be assets or income.

class plaid2.model.CreditRelayRefreshRequest(*, relay_token: str, webhook: Optional[str] = None, report_type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayRefreshRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayRefreshRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_token: str

The relay_token granting access to the report you would like to refresh.

report_type: str

The report type. It can be assets or income.

webhook: Optional[str]

The URL registered to receive webhooks when the report of a Relay Token has been refreshed.

class plaid2.model.CreditRelayRefreshResponse(*, relay_token: str, request_id: str, asset_report_id: Optional[str] = None)[source]

Bases: BaseModel

asset_report_id: Optional[str]

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_token: str
request_id: str

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

class plaid2.model.CreditRelayRemoveResponse(*, request_id: str, removed: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CreditRelayRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditRelayRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: bool

true if the Relay token was successfully removed.

request_id: str

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

class plaid2.model.CreditW2(*, employee: CreditPayStubEmployee, federal_income_tax_withheld: Optional[str] = None, retirement_plan: Optional[str] = None, employer: CreditPayStubEmployer, medicare_wages_and_tips: Optional[str] = None, dependent_care_benefits: Optional[str] = None, social_security_wages: Optional[str] = None, document_id: str, wages_tips_other_comp: Optional[str] = None, box_9: Optional[str] = None, nonqualified_plans: Optional[str] = None, document_metadata: CreditDocumentMetadata, allocated_tips: Optional[str] = None, other: Optional[str] = None, state_and_local_wages: List[W2StateAndLocalWages], box_12: List[W2Box12], social_security_tax_withheld: Optional[str] = None, medicare_tax_withheld: Optional[str] = None, third_party_sick_pay: Optional[str] = None, tax_year: Optional[str] = None, employer_id_number: Optional[str] = None, social_security_tips: Optional[str] = None, statutory_employee: Optional[str] = None)[source]

Bases: BaseModel

allocated_tips: Optional[str]

Allocated tips.

box_12: List[W2Box12]
box_9: Optional[str]

Contents from box 9 on the W2.

dependent_care_benefits: Optional[str]

Dependent care benefits.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_id: str

An identifier of the document referenced by the document metadata.

document_metadata: CreditDocumentMetadata

Object representing metadata pertaining to the document.

employee: CreditPayStubEmployee

Data about the employee.

employer: CreditPayStubEmployer

Information about the employer on the pay stub.

employer_id_number: Optional[str]

An employee identification number or EIN.

federal_income_tax_withheld: Optional[str]

Federal income tax withheld for the tax year.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

medicare_tax_withheld: Optional[str]

Medicare tax withheld for the tax year.

medicare_wages_and_tips: Optional[str]

Wages and tips from medicare.

nonqualified_plans: Optional[str]

Nonqualified plans.

other: Optional[str]

Other.

classmethod parse_obj(data: Any) → CreditW2[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CreditW2[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

retirement_plan: Optional[str]

Retirement plan.

social_security_tax_withheld: Optional[str]

Social security tax withheld for the tax year.

social_security_tips: Optional[str]

Tips from social security.

social_security_wages: Optional[str]

Wages from social security.

state_and_local_wages: List[W2StateAndLocalWages]
statutory_employee: Optional[str]

Statutory employee.

tax_year: Optional[str]

The tax year of the W2 document.

third_party_sick_pay: Optional[str]

Third party sick pay.

wages_tips_other_comp: Optional[str]

Wages from tips and other compensation.

class plaid2.model.CustomerInitiatedReturnRisk(*, score: int, risk_tier: int)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → CustomerInitiatedReturnRisk[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → CustomerInitiatedReturnRisk[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

risk_tier: int

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%

score: int

a higher risk score suggests a higher return likelihood.

Type

A score from 0-99 that indicates the transaction return risk

class plaid2.model.DashboardUser(*, created_at: str, email_address: str, id: str, status: str)[source]

Bases: BaseModel

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: str

A valid email address.

id: str

ID of the associated user.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DashboardUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DashboardUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

The current status of the user.

class plaid2.model.DashboardUserResponse(*, email_address: str, created_at: str, id: str, status: str, request_id: str)[source]

Bases: BaseModel

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: str

A valid email address.

id: str

ID of the associated user.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DashboardUserResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DashboardUserResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

status: str

The current status of the user.

class plaid2.model.DashboardUserStatus(value)[source]

Bases: str, Enum

An enumeration.

active = 'active'
deactivated = 'deactivated'
invited = 'invited'
class plaid2.model.DateRange(*, beginning: str, ending: str)[source]

Bases: BaseModel

beginning: str

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

ending: str

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DateRange[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DateRange[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.Deductions(*, totals: Optional[List[Total]] = None, total: DeductionsTotal, subtotals: Optional[List[Total]] = None, breakdown: List[DeductionsBreakdown])[source]

Bases: BaseModel

breakdown: List[DeductionsBreakdown]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Deductions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Deductions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

subtotals: Optional[List[Total]]
total: DeductionsTotal

An object representing the total deductions for the pay period

totals: Optional[List[Total]]
class plaid2.model.DeductionsBreakdown(*, unofficial_currency_code: Optional[str] = None, ytd_amount: Optional[float] = None, current_amount: Optional[float] = None, description: Optional[str] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the deduction

description: Optional[str]

Description of the deduction line item

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DeductionsBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DeductionsBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the deduction

class plaid2.model.DeductionsTotal(*, current_amount: Optional[float] = None, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, ytd_amount: Optional[float] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the deduction

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DeductionsTotal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DeductionsTotal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date total amount of the deductions

class plaid2.model.DefaultUpdateWebhook(*, new_transactions: float, error: Optional[Error] = None, item_id: str, webhook_type: str, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item the webhook relates to.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_transactions: float

The number of new transactions detected since the last time this webhook was fired.

classmethod parse_obj(data: Any) → DefaultUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DefaultUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

DEFAULT_UPDATE

webhook_type: str

TRANSACTIONS

class plaid2.model.DepositSwitchAddressData(*, city: str, region: str, postal_code: str, country: str, street: str)[source]

Bases: BaseModel

city: str

The full city name

country: str

The ISO 3166-1 alpha-2 country code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchAddressData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchAddressData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: str

The postal code

region: str

The region or state Example: “NC”

street: str

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

class plaid2.model.DepositSwitchAltCreateRequest(*, country_code: Optional[str] = None, options: Optional[DepositSwitchCreateRequestOptions] = None, target_account: DepositSwitchTargetAccount, target_user: DepositSwitchTargetUser)[source]

Bases: BaseModel

country_code: Optional[str]

ISO-3166-1 alpha-2 country code standard.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[DepositSwitchCreateRequestOptions]

Options to configure the /deposit_switch/create request. If provided, cannot be null.

classmethod parse_obj(data: Any) → DepositSwitchAltCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchAltCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

target_account: DepositSwitchTargetAccount

The deposit switch destination account

target_user: DepositSwitchTargetUser

The deposit switch target user

class plaid2.model.DepositSwitchAltCreateResponse(*, request_id: str, deposit_switch_id: str)[source]

Bases: BaseModel

deposit_switch_id: str

ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchAltCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchAltCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.DepositSwitchCreateRequest(*, target_account_id: str, options: Optional[DepositSwitchCreateRequestOptions] = None, country_code: Optional[str] = None, target_access_token: str)[source]

Bases: BaseModel

country_code: Optional[str]

ISO-3166-1 alpha-2 country code standard.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[DepositSwitchCreateRequestOptions]

Options to configure the /deposit_switch/create request. If provided, cannot be null.

classmethod parse_obj(data: Any) → DepositSwitchCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

target_access_token: str

Access token for the target Item, typically provided in the Import Item response.

target_account_id: str

Plaid Account ID that specifies the target bank account. This account will become the recipient for a user’s direct deposit.

class plaid2.model.DepositSwitchCreateRequestOptions(*, transaction_item_access_tokens: Optional[List[str]] = None, webhook: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchCreateRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchCreateRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transaction_item_access_tokens: Optional[List[str]]

An array of access tokens corresponding to transaction items to use when attempting to match the user to their Payroll Provider. These tokens must be created by the same client id as the one creating the switch, and have access to the transactions product.

webhook: Optional[str]

The URL registered to receive webhooks when the status of a deposit switch request has changed.

class plaid2.model.DepositSwitchCreateResponse(*, deposit_switch_id: str, request_id: str)[source]

Bases: BaseModel

deposit_switch_id: str

ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.DepositSwitchGetResponse(*, amount_allocated: Optional[float] = None, account_has_multiple_allocations: Optional[bool] = None, institution_name: Optional[str] = None, target_item_id: Optional[str] = None, target_account_id: Optional[str] = None, date_created: str, is_allocated_remainder: Optional[bool] = None, percent_allocated: Optional[float] = None, date_completed: Optional[str] = None, request_id: str, switch_method: Optional[str] = None, employer_name: Optional[str] = None, employer_id: Optional[str] = None, institution_id: Optional[str] = None, state: str, deposit_switch_id: str)[source]

Bases: BaseModel

account_has_multiple_allocations: Optional[bool]

When true, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always null if the deposit switch has not been completed.

amount_allocated: Optional[float]

The dollar amount of direct deposit allocated to the target account. Always null if the target account is not allocated an amount or if the deposit switch has not been completed.

date_completed: Optional[str]

//wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always null if the deposit switch has not been completed.

Type

[ISO 8601](https

date_created: str

//wikipedia.org/wiki/ISO_8601) date the deposit switch was created.

Type

[ISO 8601](https

deposit_switch_id: str

The ID of the deposit switch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer_id: Optional[str]

The ID of the employer selected by the user. If the user did not select an employer, the value returned is null.

employer_name: Optional[str]

The name of the employer selected by the user. If the user did not select an employer, the value returned is null.

institution_id: Optional[str]

The ID of the institution selected by the user. If the user did not select an institution, the value returned is null.

institution_name: Optional[str]

The name of the institution selected by the user. If the user did not select an institution, the value returned is null.

is_allocated_remainder: Optional[bool]

When true, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When false, user’s direct deposit is allocated as a percent or amount. Always null if the deposit switch has not been completed.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

percent_allocated: Optional[float]

The percentage of direct deposit allocated to the target account. Always null if the target account is not allocated a percentage or if the deposit switch has not been completed or if is_allocated_remainder is true.

request_id: str

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

state: str

The state, or status, of the deposit switch.

  • initialized – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request.

  • processing – The deposit switch request has been submitted and is being processed.

  • completed – The user’s employer has fulfilled the deposit switch request.

  • error – There was an error processing the deposit switch request.

switch_method: Optional[str]

The method used to make the deposit switch.

  • instant – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account.

  • mail – User requested that Plaid contact their employer by mail to make the direct deposit switch.

  • pdf – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.’

target_account_id: Optional[str]

The ID of the bank account the direct deposit was switched to.

target_item_id: Optional[str]

The ID of the Item the direct deposit was switched to.

class plaid2.model.DepositSwitchStateUpdateWebhook(*, webhook_code: Optional[str] = None, state: Optional[str] = None, deposit_switch_id: Optional[str] = None, webhook_type: Optional[str] = None)[source]

Bases: BaseModel

deposit_switch_id: Optional[str]

The ID of the deposit switch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchStateUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchStateUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

state: Optional[str]

The state, or status, of the deposit switch.

initialized: The deposit switch has been initialized with the user entering the information required to submit the deposit switch request.

processing: The deposit switch request has been submitted and is being processed.

completed: The user’s employer has fulfilled and completed the deposit switch request.

error: There was an error processing the deposit switch request.

For more information, see the [Deposit Switch API reference](/docs/deposit-switch/reference#deposit_switchget).

webhook_code: Optional[str]

“SWITCH_STATE_UPDATE”

webhook_type: Optional[str]

“DEPOSIT_SWITCH”

class plaid2.model.DepositSwitchTargetAccount(*, account_number: str, account_subtype: str, routing_number: str, account_name: str)[source]

Bases: BaseModel

account_name: str

The name of the deposit switch destination account, as it will be displayed to the end user in the Deposit Switch interface. It is not required to match the name used in online banking.

account_number: str

Account number for deposit switch destination

account_subtype: str

The account subtype of the account, either checking or savings.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchTargetAccount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchTargetAccount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

routing_number: str

Routing number for deposit switch destination

class plaid2.model.DepositSwitchTargetUser(*, phone: str, family_name: str, email: str, tax_payer_id: Optional[str] = None, given_name: str, address: Optional[DepositSwitchAddressData] = None)[source]

Bases: BaseModel

address: Optional[DepositSwitchAddressData]

The user’s address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email: str

The email address of the user.

family_name: str

The family name (last name) of the user.

given_name: str

The given name (first name) of the user.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchTargetUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchTargetUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone: str

The phone number of the user. The endpoint can accept a variety of phone number formats, including E.164.

tax_payer_id: Optional[str]

The taxpayer ID of the user, generally their SSN, EIN, or TIN.

class plaid2.model.DepositSwitchTokenCreateResponse(*, deposit_switch_token: str, deposit_switch_token_expiration_time: str, request_id: str)[source]

Bases: BaseModel

deposit_switch_token: str

Deposit switch token, used to initialize Link for the Deposit Switch product

deposit_switch_token_expiration_time: str

//wikipedia.org/wiki/ISO_8601) format

Type

Expiration time of the token, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DepositSwitchTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DepositSwitchTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.DepositoryAccountSubtype(value)[source]

Bases: str, Enum

An enumeration.

all = 'all'
cash_management = 'cash management'
cd = 'cd'
checking = 'checking'
ebt = 'ebt'
hsa = 'hsa'
money_market = 'money market'
paypal = 'paypal'
prepaid = 'prepaid'
savings = 'savings'
class plaid2.model.DistributionBreakdown(*, unofficial_currency_code: Optional[str] = None, type: Optional[str] = None, current_pay: Optional[Pay] = None, bank_name: Optional[str] = None, iso_currency_code: Optional[str] = None, current_amount: Optional[float] = None, account_name: Optional[str] = None, mask: Optional[str] = None)[source]

Bases: BaseModel

account_name: Optional[str]

Name of the account for the given distribution.

bank_name: Optional[str]

The name of the bank that the payment is being deposited to.

current_amount: Optional[float]

The amount distributed to this account.

current_pay: Optional[Pay]

An object representing a monetary amount.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mask: Optional[str]

The last 2-4 alphanumeric characters of an account’s official account number.

classmethod parse_obj(data: Any) → DistributionBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DistributionBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: Optional[str]

Type of the account that the paystub was sent to (e.g. ‘checking’).

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.DocType(value)[source]

Bases: str, Enum

An enumeration.

document_type_bank_statement = 'DOCUMENT_TYPE_BANK_STATEMENT'
document_type_gig = 'DOCUMENT_TYPE_GIG'
document_type_none = 'DOCUMENT_TYPE_NONE'
document_type_paystub = 'DOCUMENT_TYPE_PAYSTUB'
document_type_us_military_cles = 'DOCUMENT_TYPE_US_MILITARY_CLES'
document_type_us_military_eras = 'DOCUMENT_TYPE_US_MILITARY_ERAS'
document_type_us_military_les = 'DOCUMENT_TYPE_US_MILITARY_LES'
document_type_us_tax_1099_k = 'DOCUMENT_TYPE_US_TAX_1099_K'
document_type_us_tax_1099_misc = 'DOCUMENT_TYPE_US_TAX_1099_MISC'
document_type_us_tax_w_2 = 'DOCUMENT_TYPE_US_TAX_W2'
unknown = 'UNKNOWN'
class plaid2.model.DocumentAnalysis(*, authenticity: str, image_quality: str, extracted_data: Optional[PhysicalDocumentExtractedDataAnalysis] = None)[source]

Bases: BaseModel

authenticity: str

High level summary of whether the document in the provided image matches the formatting rules and security checks for the associated jurisdiction.

For example, most identity documents have formatting rules like the following:

The image of the person’s face must have a certain contrast in order to highlight skin tone

The subject in the document’s image must remove eye glasses and pose in a certain way

The informational fields (name, date of birth, ID number, etc.) must be colored and aligned according to specific rules

Security features like watermarks and background patterns must be present

So a match status for this field indicates that the document in the provided image seems to conform to the various formatting and security rules associated with the detected document.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

extracted_data: Optional[PhysicalDocumentExtractedDataAnalysis]

Analysis of the data extracted from the submitted document.

image_quality: str

A high level description of the quality of the image the user submitted.

For example, an image that is blurry, distorted by glare from a nearby light source, or improperly framed might be marked as low or medium quality. Poor quality images are more likely to fail OCR and/or template conformity checks.

Note: By default, Plaid will let a user recapture document images twice before failing the entire session if we attribute the failure to low image quality.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DocumentAnalysis[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentAnalysis[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.DocumentAuthenticityMatchCode(value)[source]

Bases: str, Enum

An enumeration.

match = 'match'
no_data = 'no_data'
no_match = 'no_match'
partial_match = 'partial_match'
class plaid2.model.DocumentDateOfBirthMatchCode(value)[source]

Bases: str, Enum

An enumeration.

match = 'match'
no_match = 'no_match'
partial_match = 'partial_match'
class plaid2.model.DocumentMetadata(*, status: Optional[str] = None, doc_type: Optional[str] = None, name: Optional[str] = None, doc_id: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

doc_id: Optional[str]

An identifier of the document that is also present in the paystub response.

doc_type: Optional[str]

The type of document.

DOCUMENT_TYPE_PAYSTUB: A paystub.

DOCUMENT_TYPE_BANK_STATEMENT: A bank statement.

DOCUMENT_TYPE_US_TAX_W2: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.

DOCUMENT_TYPE_US_MILITARY_ERAS: An electronic Retirement Account Statement (eRAS) issued by the US military.

DOCUMENT_TYPE_US_MILITARY_LES: A Leave and Earnings Statement (LES) issued by the US military.

DOCUMENT_TYPE_US_MILITARY_CLES: A Civilian Leave and Earnings Statment (CLES) issued by the US military.

DOCUMENT_TYPE_GIG: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.

DOCUMENT_TYPE_NONE: Used to indicate that there is no underlying document for the data.

UNKNOWN: Document type could not be determined.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The name of the document.

classmethod parse_obj(data: Any) → DocumentMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: Optional[str]

The processing status of the document.

class plaid2.model.DocumentNameMatchCode(value)[source]

Bases: str, Enum

An enumeration.

match = 'match'
no_match = 'no_match'
partial_match = 'partial_match'
class plaid2.model.DocumentRiskSignal(*, signal_description: Optional[str] = None, actual_value: Optional[str] = None, has_fraud_risk: Optional[bool] = None, institution_metadata: Optional[str] = None, field: Optional[str] = None, expected_value: Optional[str] = None, type: Optional[str] = None)[source]

Bases: BaseModel

actual_value: Optional[str]

The derived value obtained in the risk signal calculation process for this field

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expected_value: Optional[str]

The expected value of the field, as seen on the document

field: Optional[str]

The field which the risk signal was computed for

has_fraud_risk: Optional[bool]

A flag used to quickly identify if the signal indicates that this field is authentic or fraudulent

institution_metadata: Optional[str]

An object which contains additional metadata about the institution used to compute the verification attribute

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DocumentRiskSignal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentRiskSignal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

signal_description: Optional[str]

A human-readable explanation providing more detail into the particular risk signal

type: Optional[str]

The result from the risk signal check.

class plaid2.model.DocumentRiskSignalsObject(*, multi_document_risk_signals: List[MultiDocumentRiskSignal], account_id: Optional[str] = None, single_document_risk_signals: List[SingleDocumentRiskSignal])[source]

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

multi_document_risk_signals: List[MultiDocumentRiskSignal]

Array of risk signals computed from a set of uploaded documents and the associated documents’ metadata

classmethod parse_obj(data: Any) → DocumentRiskSignalsObject[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentRiskSignalsObject[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

single_document_risk_signals: List[SingleDocumentRiskSignal]

Array of document metadata and associated risk signals per document

class plaid2.model.DocumentStatus(value)[source]

Bases: str, Enum

An enumeration.

failed = 'failed'
manually_approved = 'manually_approved'
success = 'success'
class plaid2.model.DocumentaryVerification(*, status: str, documents: List[DocumentaryVerificationDocument])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documents: List[DocumentaryVerificationDocument]

An array of documents submitted to the documentary_verification step. Each entry represents one user submission, where each submission will contain both a front and back image, or just a front image, depending on the document type.

Note: Plaid will automatically let a user submit a new set of document images up to three times if we detect that a previous attempt might have failed due to user error. For example, if the first set of document images are blurry or obscured by glare, the user will be asked to capture their documents again, resulting in at least two separate entries within documents. If the overall documentary_verification is failed, the user has exhausted their retry attempts.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DocumentaryVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentaryVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

The outcome status for the associated Identity Verification attempt’s documentary_verification step. This field will always have the same value as steps.documentary_verification.

class plaid2.model.DocumentaryVerificationDocument(*, analysis: DocumentAnalysis, attempt: float, status: str, images: PhysicalDocumentImages, extracted_data: Optional[PhysicalDocumentExtractedData] = None)[source]

Bases: BaseModel

analysis: DocumentAnalysis

High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.

attempt: float

The attempt field begins with 1 and increments with each subsequent document upload.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

extracted_data: Optional[PhysicalDocumentExtractedData]

Data extracted from a user-submitted document.

images: PhysicalDocumentImages

URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL will only serve the document image for 60 seconds before expiring. The expiration time is 60 seconds after the GET request for the associated Identity Verification attempt. A new expiring URL is generated with each request, so you can always rerequest the Identity Verification attempt if one of your URLs expires.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → DocumentaryVerificationDocument[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → DocumentaryVerificationDocument[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

An outcome status for this specific document submission. Distinct from the overall documentary_verification.status that summarizes the verification outcome from one or more documents.

class plaid2.model.Earnings(*, subtotals: Optional[List[EarningsTotal]] = None, total: Optional[EarningsTotal] = None, totals: Optional[List[EarningsTotal]] = None, breakdown: Optional[List[EarningsBreakdown]] = None)[source]

Bases: BaseModel

breakdown: Optional[List[EarningsBreakdown]]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Earnings[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Earnings[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

subtotals: Optional[List[EarningsTotal]]
total: Optional[EarningsTotal]

An object representing both the current pay period and year to date amount for an earning category.

totals: Optional[List[EarningsTotal]]
class plaid2.model.EarningsBreakdown(*, iso_currency_code: Optional[str] = None, current_amount: Optional[float] = None, hours: Optional[float] = None, rate: Optional[float] = None, ytd_amount: Optional[float] = None, description: Optional[str] = None, canonical_description: Optional[str] = None, unofficial_currency_code: Optional[str] = None)[source]

Bases: BaseModel

canonical_description: Optional[str]

Commonly used term to describe the earning line item.

current_amount: Optional[float]

Raw amount of the earning line item.

description: Optional[str]

Description of the earning line item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hours: Optional[float]

Number of hours applicable for this earning.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EarningsBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EarningsBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

rate: Optional[float]

Hourly rate applicable for this earning.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the deduction.

class plaid2.model.EarningsBreakdownCanonicalDescription(value)[source]

Bases: str, Enum

An enumeration.

basic_allowance_housing = 'BASIC ALLOWANCE HOUSING'
basic_allowance_subsistence = 'BASIC ALLOWANCE SUBSISTENCE'
bonus = 'BONUS'
commission = 'COMMISSION'
other = 'OTHER'
overtime = 'OVERTIME'
paid_time_off = 'PAID TIME OFF'
regular_pay = 'REGULAR PAY'
vacation = 'VACATION'
class plaid2.model.EarningsTotal(*, hours: Optional[float] = None, unofficial_currency_code: Optional[str] = None, ytd_amount: Optional[float] = None, iso_currency_code: Optional[str] = None, current_pay: Optional[Pay] = None, current_amount: Optional[float] = None, ytd_pay: Optional[Pay] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Total amount of the earnings for this pay period

current_pay: Optional[Pay]

An object representing a monetary amount.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hours: Optional[float]

Total number of hours worked for this pay period

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EarningsTotal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EarningsTotal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the security. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The total year-to-date amount of the earnings

ytd_pay: Optional[Pay]

An object representing a monetary amount.

class plaid2.model.Email(*, type: str, data: str, primary: bool)[source]

Bases: BaseModel

data: str

The email address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Email[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Email[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

primary: bool

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

type: str

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

class plaid2.model.Employee(*, marital_status: Optional[str] = None, name: Optional[str] = None, taxpayer_id: Optional[TaxpayerId] = None, address: PaystubAddress)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: PaystubAddress

Address on the paystub

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

marital_status: Optional[str]

Marital status of the employee - either single or married.

name_: Optional[str]

The name of the employee.

classmethod parse_obj(data: Any) → Employee[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Employee[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

taxpayer_id: Optional[TaxpayerId]

Taxpayer ID of the individual receiving the paystub.

class plaid2.model.Employer(*, address: Optional[AddressData] = None, confidence_score: float, employer_id: str, name: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[AddressData]

Data about the components comprising an address.

confidence_score: float

A number from 0 to 1 indicating Plaid’s level of confidence in the pairing between the employer and the institution (not yet implemented).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer_id: str

Plaid’s unique identifier for the employer.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the employer

classmethod parse_obj(data: Any) → Employer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Employer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EmployersSearchRequest(*, products: List[str], query: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EmployersSearchRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EmployersSearchRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: List[str]

The Plaid products the returned employers should support. Currently, this field must be set to “deposit_switch”.

query: str

The employer name to be searched for.

class plaid2.model.EmployersSearchResponse(*, employers: List[Employer], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employers: List[Employer]

A list of employers matching the search criteria.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EmployersSearchResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EmployersSearchResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.EmploymentDetails(*, annual_salary: Optional[Pay] = None, hire_date: Optional[str] = None)[source]

Bases: BaseModel

annual_salary: Optional[Pay]

An object representing a monetary amount.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hire_date: Optional[str]

Date on which the employee was hired, in the YYYY-MM-DD format.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EmploymentDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EmploymentDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EmploymentVerification(*, platform_ids: Optional[PlatformIds] = None, start_date: Optional[str] = None, status: Optional[str] = None, end_date: Optional[str] = None, employer: Optional[str] = None, title: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer: Optional[str]

An object containing employer data.

end_date: Optional[str]

End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EmploymentVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EmploymentVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

platform_ids: Optional[PlatformIds]

An object containing a set of ids related to an employee

start_date: Optional[str]

Start of employment in ISO 8601 format (YYYY-MM-DD).

status: Optional[str]

Current employment status.

title: Optional[str]

Current title of employee.

class plaid2.model.EmploymentVerificationGetResponse(*, employments: List[EmploymentVerification], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employments: List[EmploymentVerification]

A list of employment verification summaries.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EmploymentVerificationGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EmploymentVerificationGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.EmploymentVerificationStatus(value)[source]

Bases: str, Enum

An enumeration.

employment_status_active = 'EMPLOYMENT_STATUS_ACTIVE'
employment_status_inactive = 'EMPLOYMENT_STATUS_INACTIVE'
class plaid2.model.Enhancements(*, payment_channel: str, merchant_name: Optional[str] = None, location: Location, personal_finance_category_icon_url: Optional[str] = None, website: Optional[str] = None, category: List[str], personal_finance_category: Optional[PersonalFinanceCategory] = None, logo_url: Optional[str] = None, check_number: Optional[str] = None, category_id: Optional[str] = None)[source]

Bases: BaseModel

category: List[str]

//plaid.com/docs/api/products/transactions/#categoriesget).

Type

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [/categories/get](https

category_id: Optional[str]

//plaid.com/docs/api/products/transactions/#categoriesget).

Type

The ID of the category to which this transaction belongs. For a full list of categories, see [/categories/get](https

check_number: Optional[str]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

location: Location

A representation of where a transaction took place

logo_url: Optional[str]

A link to the logo associated with this transaction. The logo will always be 100x100 resolution.

merchant_name: Optional[str]

The merchant name, as extracted by Plaid from the raw description.

classmethod parse_obj(data: Any) → Enhancements[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Enhancements[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_channel: str

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.

personal_finance_category: Optional[PersonalFinanceCategory]

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](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

personal_finance_category_icon_url: Optional[str]

A link to the icon associated with the primary personal finance category. The logo will always be 100x100 resolution.

website: Optional[str]

The website associated with this transaction.

class plaid2.model.EntityDocument(*, number: str, type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

number: str

The numeric or alphanumeric identifier associated with this document.

classmethod parse_obj(data: Any) → EntityDocument[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityDocument[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: str

The kind of official document represented by this object.

bik - Russian bank code

business_number - A number that uniquely identifies the business within a category of businesses

imo - Number assigned to the entity by the International Maritime Organization

other - Any document not covered by other categories

swift - Number identifying a bank and branch.

tax_id - Identification issued for the purpose of collecting taxes

class plaid2.model.EntityDocumentType(value)[source]

Bases: str, Enum

An enumeration.

bik = 'bik'
business_number = 'business_number'
imo = 'imo'
other = 'other'
swift = 'swift'
tax_id = 'tax_id'
class plaid2.model.EntityScreeningHitAnalysis(*, locations: Optional[str] = None, documents: Optional[str] = None, urls: Optional[str] = None, phone_numbers: Optional[str] = None, email_addresses: Optional[str] = None, names: Optional[str] = None, search_terms_version: float)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documents: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

email_addresses: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

locations: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

names: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

classmethod parse_obj(data: Any) → EntityScreeningHitAnalysis[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitAnalysis[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_numbers: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

search_terms_version: float

The version of the entity screening’s search_terms that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening’s search_terms, the associated entity program, or the list’s source data prior to review, the entity screening hit will be updated to reflect those changes.

urls: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

class plaid2.model.EntityScreeningHitData(*, email_addresses: Optional[List[EntityScreeningHitEmailsItems]] = None, names: Optional[List[EntityScreeningHitNamesItems]] = None, phone_numbers: Optional[List[EntityScreeningHitsPhoneNumberItems]] = None, documents: Optional[List[EntityScreeningHitDocumentsItems]] = None, locations: Optional[List[GenericScreeningHitLocationItems]] = None, urls: Optional[List[EntityScreeningHitUrlsItems]] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documents: Optional[List[EntityScreeningHitDocumentsItems]]

Documents associated with the watchlist hit

email_addresses: Optional[List[EntityScreeningHitEmailsItems]]

Email addresses associated with the watchlist hit

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

locations: Optional[List[GenericScreeningHitLocationItems]]

Locations associated with the watchlist hit

names: Optional[List[EntityScreeningHitNamesItems]]

Names associated with the watchlist hit

classmethod parse_obj(data: Any) → EntityScreeningHitData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_numbers: Optional[List[EntityScreeningHitsPhoneNumberItems]]

Phone numbers associated with the watchlist hit

urls: Optional[List[EntityScreeningHitUrlsItems]]

URLs associated with the watchlist hit

class plaid2.model.EntityScreeningHitDocumentsItems(*, analysis: Optional[str] = None, data: Optional[EntityDocument] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[EntityDocument]

An official document, usually issued by a governing body or institution, with an associated identifier.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitDocumentsItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitDocumentsItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityScreeningHitEmailsItems(*, analysis: Optional[str] = None, data: Optional[str] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[str]

Email address information for the associated entity watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitEmailsItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitEmailsItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityScreeningHitNames(*, weak_alias_determination: str, full: str, is_primary: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

full: str

The full name of the entity.

is_primary: bool

Primary names are those most commonly used to refer to this entity. Only one name will ever be marked as primary.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitNames[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitNames[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

weak_alias_determination: str

Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.

class plaid2.model.EntityScreeningHitNamesItems(*, analysis: Optional[str] = None, data: Optional[EntityScreeningHitNames] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[EntityScreeningHitNames]

Name information for the associated entity watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitNamesItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitNamesItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityScreeningHitPhoneNumbers(*, type: str, phone_number: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitPhoneNumbers[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitPhoneNumbers[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: str

A phone number in E.164 format.

type: str

An enum indicating whether a phone number is a phone line or a fax line.

class plaid2.model.EntityScreeningHitUrlsItems(*, data: Optional[str] = None, analysis: Optional[str] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[str]

URLs associated with the entity screening hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitUrlsItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitUrlsItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityScreeningHitsPhoneNumberItems(*, analysis: Optional[str] = None, data: Optional[EntityScreeningHitPhoneNumbers] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[EntityScreeningHitPhoneNumbers]

Phone number information associated with the entity screening hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningHitsPhoneNumberItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningHitsPhoneNumberItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityScreeningStatusUpdatedWebhook(*, webhook_type: str, screening_id: Any = None, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityScreeningStatusUpdatedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityScreeningStatusUpdatedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

screening_id: Any

The ID of the associated screening.

webhook_code: str

STATUS_UPDATED

webhook_type: str

ENTITY_SCREENING

class plaid2.model.EntityWatchlistCode(value)[source]

Bases: str, Enum

An enumeration.

au_con = 'AU_CON'
ca_con = 'CA_CON'
eu_con = 'EU_CON'
iz_soe = 'IZ_SOE'
iz_unc = 'IZ_UNC'
uk_hmc = 'UK_HMC'
us_cap = 'US_CAP'
us_cmc = 'US_CMC'
us_fse = 'US_FSE'
us_mbs = 'US_MBS'
us_sdn = 'US_SDN'
us_ssi = 'US_SSI'
us_uvl = 'US_UVL'
class plaid2.model.EntityWatchlistProgram(*, name: str, created_at: str, lists_enabled: List[str], name_sensitivity: str, id: str, audit_trail: WatchlistScreeningAuditTrail, is_archived: bool, is_rescanning_enabled: bool)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated entity program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

lists_enabled: List[str]

Watchlists enabled for the associated program

name_: str

A name for the entity program to define its purpose. For example, “High Risk Organizations” or “Applicants”.

name_sensitivity: str

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

classmethod parse_obj(data: Any) → EntityWatchlistProgram[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistProgram[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityWatchlistProgramResponse(*, name_sensitivity: str, id: str, created_at: str, lists_enabled: List[str], request_id: str, is_rescanning_enabled: bool, is_archived: bool, name: str, audit_trail: WatchlistScreeningAuditTrail)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated entity program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

lists_enabled: List[str]

Watchlists enabled for the associated program

name_: str

A name for the entity program to define its purpose. For example, “High Risk Organizations” or “Applicants”.

name_sensitivity: str

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

classmethod parse_obj(data: Any) → EntityWatchlistProgramResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistProgramResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.EntityWatchlistScreening(*, search_terms: EntityWatchlistScreeningSearchTerms, status: str, audit_trail: WatchlistScreeningAuditTrail, client_user_id: Optional[str] = None, id: str, assignee: Optional[str] = None)[source]

Bases: BaseModel

assignee: Optional[str]
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityWatchlistScreening[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreening[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

search_terms: EntityWatchlistScreeningSearchTerms

Search terms associated with an entity used for searching against watchlists

status: str

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

class plaid2.model.EntityWatchlistScreeningHit(*, id: str, review_status: str, first_active: str, historical_since: Optional[str] = None, plaid_uid: str, analysis: Optional[EntityScreeningHitAnalysis] = None, inactive_since: Optional[str] = None, list_code: str, source_uid: Optional[str] = None, data: Optional[EntityScreeningHitData] = None)[source]

Bases: BaseModel

analysis: Optional[EntityScreeningHitAnalysis]

Analysis information describing why a screening hit matched the provided entity information

data: Optional[EntityScreeningHitData]

Information associated with the entity watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

first_active: str

An ISO8601 formatted timestamp.

historical_since: Optional[str]

An ISO8601 formatted timestamp.

id: str

ID of the associated entity screening hit.

inactive_since: Optional[str]

An ISO8601 formatted timestamp.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

list_code: str

Shorthand identifier for a specific screening list for entities.

classmethod parse_obj(data: Any) → EntityWatchlistScreeningHit[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreeningHit[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

plaid_uid: str

A universal identifier for a watchlist individual that is stable across searches and updates.

review_status: str

The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.

source_uid: Optional[str]

The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.

class plaid2.model.EntityWatchlistScreeningResponse(*, audit_trail: WatchlistScreeningAuditTrail, assignee: Optional[str] = None, client_user_id: Optional[str] = None, request_id: str, id: str, status: str, search_terms: EntityWatchlistScreeningSearchTerms)[source]

Bases: BaseModel

assignee: Optional[str]
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityWatchlistScreeningResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreeningResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

search_terms: EntityWatchlistScreeningSearchTerms

Search terms associated with an entity used for searching against watchlists

status: str

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

class plaid2.model.EntityWatchlistScreeningReview(*, audit_trail: WatchlistScreeningAuditTrail, id: str, confirmed_hits: List[str], dismissed_hits: List[str], comment: Optional[str] = None)[source]

Bases: BaseModel

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

id: str

ID of the associated entity review.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityWatchlistScreeningReview[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreeningReview[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.EntityWatchlistScreeningReviewResponse(*, comment: Optional[str] = None, request_id: str, confirmed_hits: List[str], audit_trail: WatchlistScreeningAuditTrail, id: str, dismissed_hits: List[str])[source]

Bases: BaseModel

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

id: str

ID of the associated entity review.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → EntityWatchlistScreeningReviewResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreeningReviewResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.EntityWatchlistScreeningSearchTerms(*, version: float, country: Optional[str] = None, url: Optional[str] = None, legal_name: str, document_number: Optional[str] = None, entity_watchlist_program_id: str, email_address: Optional[str] = None, phone_number: Optional[str] = None)[source]

Bases: BaseModel

country: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
email_address: Optional[str]
entity_watchlist_program_id: str

ID of the associated entity program.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The name of the organization being screened.

classmethod parse_obj(data: Any) → EntityWatchlistScreeningSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistScreeningSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]
url: Optional[str]
version: float

The current version of the search terms. Starts at 1 and increments with each edit to search_terms.

class plaid2.model.EntityWatchlistSearchTerms(*, email_address: Optional[str] = None, country: Optional[str] = None, entity_watchlist_program_id: str, phone_number: Optional[str] = None, url: Optional[str] = None, document_number: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

country: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
email_address: Optional[str]
entity_watchlist_program_id: str

ID of the associated entity program.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The name of the organization being screened.

classmethod parse_obj(data: Any) → EntityWatchlistSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → EntityWatchlistSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]
url: Optional[str]
class plaid2.model.Error(*, status: Optional[float] = None, causes: Optional[List[Any]] = None, display_message: Optional[str] = None, error_type: str, request_id: Optional[str] = None, documentation_url: Optional[str] = None, error_code: str, error_message: str, suggested_action: Optional[str] = None)[source]

Bases: BaseModel

causes: Optional[List[Any]]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

display_message: Optional[str]

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.

documentation_url: Optional[str]

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

error_code: str

The particular error code. Safe for programmatic use.

error_message: str

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

error_type: str

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Error[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Error[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: Optional[str]

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

status: Optional[float]

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.

suggested_action: Optional[str]

Suggested steps for resolving the error

class plaid2.model.ExpirationDate(value)[source]

Bases: str, Enum

An enumeration.

expired = 'expired'
no_data = 'no_data'
not_expired = 'not_expired'
class plaid2.model.ExternalPaymentInitiationConsentOptions(*, request_refund_details: Optional[bool] = None, bacs: Optional[RecipientBacs] = None, iban: Optional[str] = None, wallet_id: Optional[str] = None)[source]

Bases: BaseModel

bacs: Optional[RecipientBacs]

An optional object used to restrict the accounts used for payments. If provided, the end user will be able to send payments only from the specified bank account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the payer’s account. If provided, the end user will be able to set up payment consent using only the specified bank account.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ExternalPaymentInitiationConsentOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ExternalPaymentInitiationConsentOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_refund_details: Optional[bool]

When true, Plaid will attempt to request refund details from the payee’s financial institution. Support varies between financial institutions and will not always be available. If refund details could be retrieved, they will be available in the /payment_initiation/payment/get response.

wallet_id: Optional[str]

The EMI (E-Money Institution) wallet that this payment consent is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.

class plaid2.model.ExternalPaymentOptions(*, request_refund_details: Optional[bool] = None, wallet_id: Optional[str] = None, bacs: Optional[RecipientBacs] = None, scheme: Optional[str] = None, iban: Optional[str] = None)[source]

Bases: BaseModel

bacs: Optional[RecipientBacs]

An optional object used to restrict the accounts used for payments. If provided, the end user will be able to send payments only from the specified bank account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the payer’s account. If provided, the end user will be able to send payments only from the specified bank account.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ExternalPaymentOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ExternalPaymentOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_refund_details: Optional[bool]

When true, Plaid will attempt to request refund details from the payee’s financial institution. Support varies between financial institutions and will not always be available. If refund details could be retrieved, they will be available in the /payment_initiation/payment/get response.

scheme: Optional[str]

Payment scheme. If not specified - the default in the region will be used (e.g. SEPA_CREDIT_TRANSFER for EU). Using unsupported values will result in a failed payment.

FASTER_PAYMENTS: Enables payments to move quickly between UK bank accounts. Default value in the UK.

SEPA_CREDIT_TRANSFER: The standard payment to a beneficiary within the SEPA area.

SEPA_CREDIT_TRANSFER_INSTANT: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.

wallet_id: Optional[str]

The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.

class plaid2.model.ExternalPaymentRefundDetails(*, name: str, bacs: Optional[RecipientBacs] = None, iban: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the account.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the account holder.

classmethod parse_obj(data: Any) → ExternalPaymentRefundDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ExternalPaymentRefundDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ExternalPaymentScheduleBase(*, adjusted_start_date: Optional[str] = None, interval: Optional[str] = None, end_date: Optional[str] = None, interval_execution_day: Optional[int] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

adjusted_start_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, this field will be null.

Type

The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will end on the last interval_execution_day on or before the end_date. If the only interval_execution_day between the start date and the end date (inclusive) is also the same day that /payment_initiation/payment/create was called, the bank may make a payment on that day, but it is not guaranteed to do so.

Type

A date in [ISO 8601](https

interval: Optional[str]

The frequency interval of the payment.

interval_execution_day: Optional[int]

The day of the interval on which to schedule the payment.

If the payment interval is weekly, interval_execution_day should be an integer from 1 (Monday) to 7 (Sunday).

If the payment interval is monthly, interval_execution_day should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ExternalPaymentScheduleBase[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ExternalPaymentScheduleBase[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will begin on the first interval_execution_day on or after the start_date.

If the first interval_execution_day on or after the start date is also the same day that /payment_initiation/payment/create was called, the bank may make the first payment on that day, but it is not guaranteed to do so.

Type

A date in [ISO 8601](https

class plaid2.model.Form1099Type(value)[source]

Bases: str, Enum

An enumeration.

form_1099_type_k = 'FORM_1099_TYPE_K'
form_1099_type_misc = 'FORM_1099_TYPE_MISC'
form_1099_type_unknown = 'FORM_1099_TYPE_UNKNOWN'
class plaid2.model.GenericScreeningHitLocationItems(*, data: Optional[WatchlistScreeningHitLocations] = None, analysis: Optional[str] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[WatchlistScreeningHitLocations]

Location information for the associated individual watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → GenericScreeningHitLocationItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → GenericScreeningHitLocationItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.HealthIncident(*, incident_updates: List[IncidentUpdate], start_date: str, end_date: Optional[str] = None, title: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

26:48Z”`.

Type

The end date of the incident, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format, e.g. `”2020-10-30T15

incident_updates: List[IncidentUpdate]

Updates on the health incident.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → HealthIncident[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → HealthIncident[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: str

26:48Z”`.

Type

The start date of the incident, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format, e.g. `”2020-10-30T15

title: str

The title of the incident

class plaid2.model.HistoricalBalance(*, current: float, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, date: str)[source]

Bases: BaseModel

current: float

The total amount of funds in the account, calculated from the current balance in the balance object by subtracting inflows and adding back outflows according to the posted date of each transaction.

If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.

date: str

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)

Type

The date of the calculated historical balance, in an [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → HistoricalBalance[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → HistoricalBalance[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null.

See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.HistoricalUpdateWebhook(*, webhook_type: str, webhook_code: str, item_id: str, error: Optional[Error] = None, new_transactions: float)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_transactions: float

The number of new, unfetched transactions available

classmethod parse_obj(data: Any) → HistoricalUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → HistoricalUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

HISTORICAL_UPDATE

webhook_type: str

TRANSACTIONS

class plaid2.model.Holding(*, account_id: str, institution_price_as_of: Optional[str] = None, cost_basis: Optional[float] = None, unofficial_currency_code: Optional[str] = None, security_id: str, institution_price_datetime: Optional[str] = None, quantity: float, iso_currency_code: Optional[str] = None, institution_value: float, institution_price: float)[source]

Bases: BaseModel

account_id: str

The Plaid account_id associated with the holding.

cost_basis: Optional[float]

The original total value or the purchase price per share of the holding. This field is an aggregate on a per holding basis and dependent on the information provided by the institution.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_price: float

The last price given by the institution for this security.

institution_price_as_of: Optional[str]

The date at which institution_price was current.

institution_price_datetime: Optional[str]

ssZ).

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).

Type

Date and time at which institution_price was current, in ISO 8601 format (YYYY-MM-DDTHH

Type

mm

institution_value: float

The value of the holding, as reported by the institution.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Holding[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Holding[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

quantity: float

The total quantity of the asset held, as reported by the financial institution. If the security is an option, quantity will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.

security_id: str

The Plaid security_id associated with the holding.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the holding. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.HoldingsDefaultUpdateWebhook(*, updated_holdings: float, new_holdings: float, webhook_code: str, item_id: str, error: Optional[Error] = None, webhook_type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_holdings: float

The number of new holdings reported since the last time this webhook was fired.

classmethod parse_obj(data: Any) → HoldingsDefaultUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → HoldingsDefaultUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

updated_holdings: float

The number of updated holdings reported since the last time this webhook was fired.

webhook_code: str

DEFAULT_UPDATE

webhook_type: str

HOLDINGS

class plaid2.model.HoldingsOverride(*, institution_price_as_of: Optional[str] = None, cost_basis: Optional[float] = None, security: SecurityOverride, currency: str, quantity: float, institution_price: float)[source]

Bases: BaseModel

cost_basis: Optional[float]

The average original value of the holding. Multiple cost basis values for the same security purchased at different prices are not supported.

currency: str

Either a valid iso_currency_code or unofficial_currency_code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_price: float

The last price given by the institution for this security

institution_price_as_of: Optional[str]

//wikipedia.org/wiki/ISO_8601) date.

Type

The date at which institution_price was current. Must be formatted as an [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → HoldingsOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → HoldingsOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

quantity: float

The total quantity of the asset held, as reported by the financial institution.

security: SecurityOverride

Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (ticker_symbol, cusip, isin, or sedol) are required.

class plaid2.model.IdNumberType(value)[source]

Bases: str, Enum

An enumeration.

ar_dni = 'ar_dni'
au_drivers_license = 'au_drivers_license'
au_passport = 'au_passport'
br_cpf = 'br_cpf'
ca_sin = 'ca_sin'
cl_run = 'cl_run'
cn_resident_card = 'cn_resident_card'
co_nit = 'co_nit'
dk_cpr = 'dk_cpr'
eg_national_id = 'eg_national_id'
es_dni = 'es_dni'
es_nie = 'es_nie'
hk_hkid = 'hk_hkid'
in_pan = 'in_pan'
it_cf = 'it_cf'
jo_civil_id = 'jo_civil_id'
jp_my_number = 'jp_my_number'
ke_huduma_namba = 'ke_huduma_namba'
kw_civil_id = 'kw_civil_id'
mx_curp = 'mx_curp'
mx_rfc = 'mx_rfc'
my_nric = 'my_nric'
ng_nin = 'ng_nin'
nz_drivers_license = 'nz_drivers_license'
om_civil_id = 'om_civil_id'
ph_psn = 'ph_psn'
pl_pesel = 'pl_pesel'
ro_cnp = 'ro_cnp'
sa_national_id = 'sa_national_id'
se_pin = 'se_pin'
sg_nric = 'sg_nric'
tr_tc_kimlik = 'tr_tc_kimlik'
us_ssn = 'us_ssn'
us_ssn_last_4 = 'us_ssn_last_4'
za_smart_id = 'za_smart_id'
class plaid2.model.IdentityDefaultUpdateWebhook(*, error: Optional[Error] = None, webhook_type: str, account_ids_with_updated_identity: AccountIdsWithUpdatedIdentity, item_id: str, webhook_code: str)[source]

Bases: BaseModel

account_ids_with_updated_identity: AccountIdsWithUpdatedIdentity

An object with keys of account_id’s that are mapped to their respective identity attributes that changed.

Example: { “XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58”: [“PHONES”] }

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityDefaultUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityDefaultUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

DEFAULT_UPDATE

webhook_type: str

IDENTITY

class plaid2.model.IdentityGetRequest(*, options: Optional[List[str]] = None, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /identity/get results.

classmethod parse_obj(data: Any) → IdentityGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IdentityGetResponse(*, accounts: List[AccountIdentity], item: Item, request_id: str)[source]

Bases: BaseModel

accounts: List[AccountIdentity]

The accounts for which Identity data has been requested

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.IdentityMatchRequest(*, access_token: str, user: Optional[IdentityMatchUser] = None, options: Optional[List[str]] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /identity/match results

classmethod parse_obj(data: Any) → IdentityMatchRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityMatchRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user: Optional[IdentityMatchUser]

The user’s legal name, phone number, email address and address used to perform fuzzy match.

class plaid2.model.IdentityMatchResponse(*, request_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityMatchResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityMatchResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: Optional[str]

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

class plaid2.model.IdentityMatchUser(*, phone_number: Optional[str] = None, address: Optional[AddressData] = None, legal_name: Optional[str] = None, email_address: Optional[str] = None)[source]

Bases: BaseModel

address: Optional[AddressData]

Data about the components comprising an address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: Optional[str]

The user’s full legal name.

classmethod parse_obj(data: Any) → IdentityMatchUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityMatchUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

“+14151234567”. Phone numbers provided in other formats will be parsed on a best-effort basis.

Type

The user’s phone number, in E.164 format

Type

+{countrycode}{number}. For example

class plaid2.model.IdentityUpdateTypes(value)[source]

Bases: str, Enum

An enumeration.

addresses = 'ADDRESSES'
emails = 'EMAILS'
names = 'NAMES'
phones = 'PHONES'
class plaid2.model.IdentityVerification(*, steps: IdentityVerificationStepSummary, shareable_url: Optional[str] = None, template: IdentityVerificationTemplateReference, created_at: str, status: str, watchlist_screening_id: Optional[str] = None, completed_at: Optional[str] = None, client_user_id: str, previous_attempt_id: Optional[str] = None, documentary_verification: Optional[DocumentaryVerification] = None, id: str, user: IdentityVerificationUserData, kyc_check: Optional[KycCheckDetails] = None)[source]

Bases: BaseModel

client_user_id: str

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.

completed_at: Optional[str]

An ISO8601 formatted timestamp.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documentary_verification: Optional[DocumentaryVerification]

data, images, analysis, and results from the documentary_verification step.

id: str

ID of the associated Identity Verification attempt.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

kyc_check: Optional[KycCheckDetails]

The outcome of the kyc_check step.

classmethod parse_obj(data: Any) → IdentityVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

previous_attempt_id: Optional[str]

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

shareable_url: Optional[str]

A shareable URL that can be sent directly to the user to complete verification

status: str

The status of this Identity Verification attempt.

active - The Identity Verification attempt is incomplete. The user may have completed part of the session, but has neither failed or passed.

success - The Identity Verification attempt has completed, passing all steps defined to the associated Identity Verification template

failed - The user failed one or more steps in the session and was told to contact support.

expired - The Identity Verification attempt was active for more than 48 hours without being completed and was automatically marked as expired.

canceled - The Identity Verification attempt was canceled, either via the dashboard by a user, or via API. The user may have completed part of the session, but has neither failed or passed.

pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.

steps: IdentityVerificationStepSummary

Each step will be one of the following values:

active - This step is the user’s current step. They are either in the process of completing this step, or they recently closed their Identity Verification attempt while in the middle of this step. Only one step will be marked as active at any given point.

success - The Identity Verification attempt has completed this step.

failed - The user failed this step. This can either call the user to fail the session as a whole, or cause them to fallback to another step depending on how the Identity Verification template is configured. A failed step does not imply a failed session.

waiting_for_prerequisite - The user needs to complete another step first, before they progress to this step. This step may never run, depending on if the user fails an earlier step or if the step is only run as a fallback.

not_applicable - This step will not be run for this session.

skipped - The retry instructions that created this Identity Verification attempt specified that this step should be skipped.

expired - This step had not yet been completed when the Identity Verification attempt as a whole expired.

canceled - The Identity Verification attempt was canceled before the user completed this step.

pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.

manually_approved - The step was manually overridden to pass by a team member in the dashboard.

manually_rejected - The step was manually overridden to fail by a team member in the dashboard.

template: IdentityVerificationTemplateReference

The resource ID and version number of the template configuring the behavior of a given identity verification.

user: IdentityVerificationUserData

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

watchlist_screening_id: Optional[str]
class plaid2.model.IdentityVerificationCreateRequest(*, gave_consent: bool, user: IdentityVerificationRequestUser, is_idempotent: Optional[bool] = None, is_shareable: bool, template_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes.

If gave_consent is set to true, the accept_tos step will be marked as skipped and the end user’s session will start at the next step requirement.

is_idempotent: Optional[bool]

An optional flag specifying how you would like Plaid to handle attempts to create an Identity Verification when an Identity Verification already exists for the provided client_user_id and template_id. If idempotency is enabled, Plaid will return the existing Identity Verification. If idempotency is disabled, Plaid will reject the request with a 400 Bad Request status code if an Identity Verification already exists for the supplied client_user_id and template_id.

is_shareable: bool

A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

template_id: str

ID of the associated Identity Verification template.

user: IdentityVerificationRequestUser

User information collected outside of Link, most likely via your own onboarding process.

Each of the following identity fields are optional:

email_address

phone_number

date_of_birth

name

address

id_number Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the accept_tos step, depending on the value provided to the gave_consent field.

class plaid2.model.IdentityVerificationRequestUser(*, email_address: Optional[str] = None, phone_number: Optional[str] = None, client_user_id: str, date_of_birth: Optional[str] = None, name: Optional[UserName] = None, address: Optional[UserAddress] = None, id_number: Optional[UserIdNumber] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[UserAddress]

Home address for the user.

client_user_id: str

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.

date_of_birth: Optional[str]

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]
id_number: Optional[UserIdNumber]

ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[UserName]

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

classmethod parse_obj(data: Any) → IdentityVerificationRequestUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationRequestUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

A phone number in E.164 format.

class plaid2.model.IdentityVerificationResponse(*, request_id: str, user: IdentityVerificationUserData, template: IdentityVerificationTemplateReference, id: str, previous_attempt_id: Optional[str] = None, status: str, steps: IdentityVerificationStepSummary, documentary_verification: Optional[DocumentaryVerification] = None, shareable_url: Optional[str] = None, watchlist_screening_id: Optional[str] = None, completed_at: Optional[str] = None, created_at: str, kyc_check: Optional[KycCheckDetails] = None, client_user_id: str)[source]

Bases: BaseModel

client_user_id: str

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.

completed_at: Optional[str]

An ISO8601 formatted timestamp.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documentary_verification: Optional[DocumentaryVerification]

data, images, analysis, and results from the documentary_verification step.

id: str

ID of the associated Identity Verification attempt.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

kyc_check: Optional[KycCheckDetails]

The outcome of the kyc_check step.

classmethod parse_obj(data: Any) → IdentityVerificationResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

previous_attempt_id: Optional[str]

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.

request_id: str

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

shareable_url: Optional[str]

A shareable URL that can be sent directly to the user to complete verification

status: str

The status of this Identity Verification attempt.

active - The Identity Verification attempt is incomplete. The user may have completed part of the session, but has neither failed or passed.

success - The Identity Verification attempt has completed, passing all steps defined to the associated Identity Verification template

failed - The user failed one or more steps in the session and was told to contact support.

expired - The Identity Verification attempt was active for more than 48 hours without being completed and was automatically marked as expired.

canceled - The Identity Verification attempt was canceled, either via the dashboard by a user, or via API. The user may have completed part of the session, but has neither failed or passed.

pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.

steps: IdentityVerificationStepSummary

Each step will be one of the following values:

active - This step is the user’s current step. They are either in the process of completing this step, or they recently closed their Identity Verification attempt while in the middle of this step. Only one step will be marked as active at any given point.

success - The Identity Verification attempt has completed this step.

failed - The user failed this step. This can either call the user to fail the session as a whole, or cause them to fallback to another step depending on how the Identity Verification template is configured. A failed step does not imply a failed session.

waiting_for_prerequisite - The user needs to complete another step first, before they progress to this step. This step may never run, depending on if the user fails an earlier step or if the step is only run as a fallback.

not_applicable - This step will not be run for this session.

skipped - The retry instructions that created this Identity Verification attempt specified that this step should be skipped.

expired - This step had not yet been completed when the Identity Verification attempt as a whole expired.

canceled - The Identity Verification attempt was canceled before the user completed this step.

pending_review - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review.

manually_approved - The step was manually overridden to pass by a team member in the dashboard.

manually_rejected - The step was manually overridden to fail by a team member in the dashboard.

template: IdentityVerificationTemplateReference

The resource ID and version number of the template configuring the behavior of a given identity verification.

user: IdentityVerificationUserData

The identity data that was either collected from the user or provided via API in order to perform an identity verification.

watchlist_screening_id: Optional[str]
class plaid2.model.IdentityVerificationRetriedWebhook(*, identity_verification_id: Any = None, webhook_code: str, webhook_type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

identity_verification_id: Any

The ID of the associated Identity Verification attempt.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationRetriedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationRetriedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

RETRIED

webhook_type: str

IDENTITY_VERIFICATION

class plaid2.model.IdentityVerificationRetryRequest(*, client_user_id: str, steps: Optional[IdentityVerificationRetryRequestStepsObject] = None, template_id: str, strategy: str)[source]

Bases: BaseModel

client_user_id: str

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationRetryRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationRetryRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

steps: Optional[IdentityVerificationRetryRequestStepsObject]

Instructions for the custom retry strategy specifying which steps should be required or skipped.

Note:

This field must be provided when the retry strategy is custom and must be omitted otherwise.

Custom retries override settings in your Plaid Template. For example, if your Plaid Template has verify_sms disabled, a custom retry with verify_sms enabled will still require the step.

The selfie_check step is currently not supported on the sandbox server. Sandbox requests will silently disable the selfie_check step when provided.

strategy: str

An instruction specifying what steps the new Identity Verification attempt should require the user to complete:

reset - Restart the user at the beginning of the session, regardless of whether they successfully completed part of their previous session.

incomplete - Start the new session at the step that the user failed in the previous session, skipping steps that have already been successfully completed.

infer - If the most recent Identity Verification attempt associated with the given client_user_id has a status of failed or expired, retry using the incomplete strategy. Otherwise, use the reset strategy.

custom - Start the new session with a custom configuration, specified by the value of the steps field

Note:

The incomplete strategy cannot be applied if the session’s failing step is screening or risk_check.

The infer strategy cannot be applied if the session’s status is still active

template_id: str

ID of the associated Identity Verification template.

class plaid2.model.IdentityVerificationRetryRequestStepsObject(*, documentary_verification: bool, selfie_check: bool, verify_sms: bool, kyc_check: bool)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documentary_verification: bool

A boolean field specifying whether the new session should require or skip the documentary_verification step.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

kyc_check: bool

A boolean field specifying whether the new session should require or skip the kyc_check step.

classmethod parse_obj(data: Any) → IdentityVerificationRetryRequestStepsObject[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationRetryRequestStepsObject[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

selfie_check: bool

A boolean field specifying whether the new session should require or skip the selfie_check step.

verify_sms: bool

A boolean field specifying whether the new session should require or skip the verify_sms step.

class plaid2.model.IdentityVerificationStatus(value)[source]

Bases: str, Enum

An enumeration.

active = 'active'
canceled = 'canceled'
expired = 'expired'
failed = 'failed'
pending_review = 'pending_review'
success = 'success'
class plaid2.model.IdentityVerificationStatusUpdatedWebhook(*, webhook_code: str, webhook_type: str, identity_verification_id: Any = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

identity_verification_id: Any

The ID of the associated Identity Verification attempt.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationStatusUpdatedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationStatusUpdatedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

STATUS_UPDATED

webhook_type: str

IDENTITY_VERIFICATION

class plaid2.model.IdentityVerificationStepStatus(value)[source]

Bases: str, Enum

An enumeration.

active = 'active'
canceled = 'canceled'
expired = 'expired'
failed = 'failed'
manually_approved = 'manually_approved'
manually_rejected = 'manually_rejected'
not_applicable = 'not_applicable'
pending_review = 'pending_review'
skipped = 'skipped'
success = 'success'
waiting_for_prerequisite = 'waiting_for_prerequisite'
class plaid2.model.IdentityVerificationStepSummary(*, watchlist_screening: str, risk_check: str, selfie_check: str, kyc_check: str, verify_sms: str, accept_tos: str, documentary_verification: str)[source]

Bases: BaseModel

accept_tos: str

The status of a step in the identity verification process.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documentary_verification: str

The status of a step in the identity verification process.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

kyc_check: str

The status of a step in the identity verification process.

classmethod parse_obj(data: Any) → IdentityVerificationStepSummary[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationStepSummary[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

risk_check: str

The status of a step in the identity verification process.

selfie_check: str

The status of a step in the identity verification process.

verify_sms: str

The status of a step in the identity verification process.

watchlist_screening: str

The status of a step in the identity verification process.

class plaid2.model.IdentityVerificationStepUpdatedWebhook(*, webhook_type: str, webhook_code: str, identity_verification_id: Any = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

identity_verification_id: Any

The ID of the associated Identity Verification attempt.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationStepUpdatedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationStepUpdatedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

STEP_UPDATED

webhook_type: str

IDENTITY_VERIFCATION

class plaid2.model.IdentityVerificationTemplateReference(*, id: str, version: float)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated Identity Verification template.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationTemplateReference[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationTemplateReference[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

version: float

Version of the associated Identity Verification template.

class plaid2.model.IdentityVerificationUserAddress(*, region: Optional[str] = None, street: Optional[str] = None, postal_code: Optional[str] = None, country: str, street_2: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]
country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IdentityVerificationUserAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationUserAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]
region: Optional[str]
street: Optional[str]
street_2: Optional[str]

Extra street information, like an apartment or suite number.

class plaid2.model.IdentityVerificationUserData(*, name: Optional[UserName] = None, address: Optional[IdentityVerificationUserAddress] = None, id_number: Optional[UserIdNumber] = None, ip_address: Optional[str] = None, date_of_birth: Optional[str] = None, phone_number: Optional[str] = None, email_address: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[IdentityVerificationUserAddress]

  • Addresses from the United Kingdom will not include a region * Addresses from Hong Kong will not include postal code

Type

Even if an address has been collected, some fields may be null depending on the region’s addressing system. For example

date_of_birth: Optional[str]

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]
id_number: Optional[UserIdNumber]

ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.

ip_address: Optional[str]

An IPv4 or IPV6 address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[UserName]

The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.

classmethod parse_obj(data: Any) → IdentityVerificationUserData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IdentityVerificationUserData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

A phone number in E.164 format.

class plaid2.model.ImageQuality(value)[source]

Bases: str, Enum

An enumeration.

high = 'high'
low = 'low'
medium = 'medium'
class plaid2.model.IncidentUpdate(*, description: Optional[str] = None, status: Optional[str] = None, updated_date: Optional[str] = None)[source]

Bases: BaseModel

description: Optional[str]

The content of the update.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncidentUpdate[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncidentUpdate[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: Optional[str]

The status of the incident.

updated_date: Optional[str]

26:48Z”`.

Type

The date when the update was published, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format, e.g. `”2020-10-30T15

class plaid2.model.IncomeBreakdown(*, type: Optional[str] = None, hours: Optional[float] = None, rate: Optional[float] = None, total: Optional[float] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hours: Optional[float]

The number of hours logged for this income for this pay period.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

rate: Optional[float]

The hourly rate at which the income is paid.

total: Optional[float]

The total pay for this pay period.

type: Optional[str]

The type of income. Possible values include: “regular”: regular income “overtime”: overtime income “bonus”: bonus income

class plaid2.model.IncomeBreakdownType(value)[source]

Bases: str, Enum

An enumeration.

bonus = 'bonus'
overtime = 'overtime'
regular = 'regular'
class plaid2.model.IncomeSummary(*, projected_wage: IncomeSummaryFieldNumber, employer_name: IncomeSummaryFieldString, verified_transaction: Optional[TransactionData] = None, pay_frequency: Optional[PayFrequency] = None, employee_name: IncomeSummaryFieldString, ytd_gross_income: IncomeSummaryFieldNumber, ytd_net_income: IncomeSummaryFieldNumber)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee_name: IncomeSummaryFieldString

The name of the employee, as reported on the paystub.

employer_name: IncomeSummaryFieldString

The name of the employer, as reported on the paystub.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeSummary[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeSummary[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_frequency: Optional[PayFrequency]

The frequency of the pay period.

projected_wage: IncomeSummaryFieldNumber

The employee’s estimated annual salary, as derived from information reported on the paystub.

verified_transaction: Optional[TransactionData]

Information about the matched direct deposit transaction used to verify a user’s payroll information.

ytd_gross_income: IncomeSummaryFieldNumber

Year-to-date pre-tax earnings, as reported on the paystub.

ytd_net_income: IncomeSummaryFieldNumber

Year-to-date earnings after any tax withholdings, benefit payments or deductions, as reported on the paystub.

class plaid2.model.IncomeSummaryFieldNumber(*, value: float, verification_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeSummaryFieldNumber[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeSummaryFieldNumber[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

value: float

The value of the field.

verification_status: str

The verification status. One of the following:

“VERIFIED”: The information was successfully verified.

“UNVERIFIED”: The verification has not yet been performed.

“NEEDS_INFO”: The verification was attempted but could not be completed due to missing information.

“UNABLE_TO_VERIFY”: The verification was performed and the information could not be verified.

“UNKNOWN”: The verification status is unknown.

class plaid2.model.IncomeSummaryFieldString(*, value: str, verification_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeSummaryFieldString[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeSummaryFieldString[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

value: str

The value of the field.

verification_status: str

The verification status. One of the following:

“VERIFIED”: The information was successfully verified.

“UNVERIFIED”: The verification has not yet been performed.

“NEEDS_INFO”: The verification was attempted but could not be completed due to missing information.

“UNABLE_TO_VERIFY”: The verification was performed and the information could not be verified.

“UNKNOWN”: The verification status is unknown.

class plaid2.model.IncomeVerificationCreateRequest(*, webhook: str, options: Optional[List[str]] = None, precheck_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

Optional arguments for /income/verification/create

classmethod parse_obj(data: Any) → IncomeVerificationCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

precheck_id: Optional[str]

The ID of a precheck created with /income/verification/precheck. Will be used to improve conversion of the income verification flow.

webhook: str

The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.

class plaid2.model.IncomeVerificationCreateResponse(*, request_id: str, income_verification_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_verification_id: str

ID of the verification. This ID is persisted throughout the lifetime of the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.IncomeVerificationDocumentsDownloadRequest(*, income_verification_id: Optional[str] = None, document_id: Optional[str] = None, access_token: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_id: Optional[str]

The document ID to download. If passed, a single document will be returned in the resulting zip file, rather than all document

income_verification_id: Optional[str]

The ID of the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationDocumentsDownloadRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationDocumentsDownloadRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationPayrollFlowType(value)[source]

Bases: str, Enum

An enumeration.

payroll_digital_income = 'payroll_digital_income'
payroll_document_income = 'payroll_document_income'
class plaid2.model.IncomeVerificationPaystubsGetRequest(*, access_token: Optional[str] = None, income_verification_id: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_verification_id: Optional[str]

The ID of the verification for which to get paystub information.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPaystubsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPaystubsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationPaystubsGetResponse(*, document_metadata: Optional[List[DocumentMetadata]] = None, paystubs: List[Paystub], error: Optional[Error] = None, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_metadata: Optional[List[DocumentMetadata]]

Metadata for an income document.

error: Optional[Error]

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. Error fields will be null if no error has occurred.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPaystubsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPaystubsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

paystubs: List[Paystub]
request_id: str

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

class plaid2.model.IncomeVerificationPrecheckConfidence(value)[source]

Bases: str, Enum

An enumeration.

high = 'HIGH'
low = 'LOW'
unknown = 'UNKNOWN'
class plaid2.model.IncomeVerificationPrecheckEmployer(*, address: Optional[IncomeVerificationPrecheckEmployerAddress] = None, tax_id: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[IncomeVerificationPrecheckEmployerAddress]

The address of the employer

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The employer’s name

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckEmployer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckEmployer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

tax_id: Optional[str]

The employer’s tax id

url: Optional[str]

The URL for the employer’s public website

class plaid2.model.IncomeVerificationPrecheckEmployerAddress[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckEmployerAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckEmployerAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationPrecheckEmployerAddressData(*, postal_code: Optional[str] = None, street: Optional[str] = None, region: Optional[str] = None, country: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name

country: Optional[str]

The ISO 3166-1 alpha-2 country code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckEmployerAddressData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckEmployerAddressData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

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

region: Optional[str]

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

street: Optional[str]

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

class plaid2.model.IncomeVerificationPrecheckMilitaryInfo(*, branch: Optional[str] = None, is_active_duty: Optional[bool] = None)[source]

Bases: BaseModel

branch: Optional[str]

If the user is currently serving in the US military, the branch of the military in which they are serving Valid values: ‘AIR FORCE’, ‘ARMY’, ‘COAST GUARD’, ‘MARINES’, ‘NAVY’, ‘UNKNOWN’

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

is_active_duty: Optional[bool]

Is the user currently active duty in the US military

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckMilitaryInfo[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckMilitaryInfo[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationPrecheckRequest(*, employer: Optional[IncomeVerificationPrecheckEmployer] = None, transactions_access_tokens: Optional[List[str]] = None, us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo] = None, transactions_access_token: Optional[str] = None, user: Optional[IncomeVerificationPrecheckUser] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer: Optional[IncomeVerificationPrecheckEmployer]

Information about the end user’s employer

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactions_access_token: Optional[str]
transactions_access_tokens: Optional[List[str]]

An array of access tokens corresponding to Items belonging to the user whose eligibility is being checked. Note that if the Items specified here are not already initialized with transactions, providing them in this field will cause these Items to be initialized with (and billed for) the Transactions product.

us_military_info: Optional[IncomeVerificationPrecheckMilitaryInfo]

Data about military info in the income verification precheck.

user: Optional[IncomeVerificationPrecheckUser]

Information about the user whose eligibility is being evaluated.

class plaid2.model.IncomeVerificationPrecheckResponse(*, precheck_id: str, request_id: str, confidence: str)[source]

Bases: BaseModel

confidence: str

The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload. One of the following:

“HIGH”: It is very likely that this user can use the digital income verification flow.

“LOW”: It is unlikely that this user can use the digital income verification flow.

“UNKNOWN”: It was not possible to determine if the user is supportable with the information passed.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

precheck_id: str

ID of the precheck. Provide this value when calling /link/token/create in order to optimize Link conversion.

request_id: str

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

class plaid2.model.IncomeVerificationPrecheckUser(*, email_address: Optional[str] = None, home_address: Optional[SignalAddressData] = None, last_name: Optional[str] = None, first_name: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address

first_name: Optional[str]

The user’s first name

home_address: Optional[SignalAddressData]

Data about the components comprising an address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_name: Optional[str]

The user’s last name

classmethod parse_obj(data: Any) → IncomeVerificationPrecheckUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationPrecheckUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationRefreshRequest(*, access_token: Optional[str] = None, income_verification_id: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_verification_id: Optional[str]

The ID of the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationRefreshRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationRefreshRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationRefreshResponse(*, request_id: str, verification_refresh_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

verification_refresh_status: str

The verification refresh status. One of the following:

“VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED” User presence is required to refresh an income verification. “VERIFICATION_REFRESH_SUCCESSFUL” The income verification refresh was successful. “VERIFICATION_REFRESH_NOT_FOUND” No new data was found after the income verification refresh.

class plaid2.model.IncomeVerificationSourceType(value)[source]

Bases: str, Enum

An enumeration.

bank = 'bank'
payroll = 'payroll'
class plaid2.model.IncomeVerificationStatusWebhook(*, user_id: Optional[str] = None, webhook_code: str, verification_status: str, webhook_type: str, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The Item ID associated with the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationStatusWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationStatusWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_id: Optional[str]

The Plaid user_id of the User associated with this webhook, warning, or error.

verification_status: str

The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /income/verification/paystubs/get endpoint and check the document metadata to see which documents were successfully parsed.

VERIFICATION_STATUS_PROCESSING_FAILED: A failure occurred when attempting to process the verification documentation.

VERIFICATION_STATUS_PENDING_APPROVAL: The income verification has been sent to the user for review.

Type

VERIFICATION_STATUS_PROCESSING_COMPLETE

webhook_code: str

INCOME_VERIFICATION

webhook_type: str

“INCOME”

class plaid2.model.IncomeVerificationTaxformsGetRequest(*, income_verification_id: Optional[str] = None, access_token: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_verification_id: Optional[str]

The ID of the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationTaxformsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationTaxformsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IncomeVerificationTaxformsGetResponse(*, document_metadata: List[DocumentMetadata], taxforms: List[Taxform], request_id: Optional[str] = None, error: Optional[Error] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_metadata: List[DocumentMetadata]
error: Optional[Error]

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. Error fields will be null if no error has occurred.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IncomeVerificationTaxformsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeVerificationTaxformsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: Optional[str]

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

taxforms: List[Taxform]

A list of forms.

class plaid2.model.IndividualScreeningHitNames(*, is_primary: bool, weak_alias_determination: str, full: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

full: str

The full name of the individual, including all parts.

is_primary: bool

Primary names are those most commonly used to refer to this person. Only one name will ever be marked as primary.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → IndividualScreeningHitNames[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IndividualScreeningHitNames[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

weak_alias_determination: str

Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.

class plaid2.model.IndividualWatchlistCode(value)[source]

Bases: str, Enum

An enumeration.

au_con = 'AU_CON'
ca_con = 'CA_CON'
eu_con = 'EU_CON'
iz_cia = 'IZ_CIA'
iz_ipl = 'IZ_IPL'
iz_pep = 'IZ_PEP'
iz_unc = 'IZ_UNC'
sg_sof = 'SG_SOF'
tr_dfd = 'TR_DFD'
tr_for = 'TR_FOR'
tr_twl = 'TR_TWL'
tr_wmd = 'TR_WMD'
uk_hmc = 'UK_HMC'
us_dpl = 'US_DPL'
us_dtc = 'US_DTC'
us_fbi = 'US_FBI'
us_fse = 'US_FSE'
us_isn = 'US_ISN'
us_mbc = 'US_MBC'
us_plc = 'US_PLC'
us_sdn = 'US_SDN'
us_ssi = 'US_SSI'
class plaid2.model.IndividualWatchlistProgram(*, id: str, is_rescanning_enabled: bool, lists_enabled: List[str], name_sensitivity: str, created_at: str, name: str, is_archived: bool, audit_trail: WatchlistScreeningAuditTrail)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

lists_enabled: List[str]

Watchlists enabled for the associated program

name_: str

A name for the program to define its purpose. For example, “High Risk Individuals”, “US Cardholders”, or “Applicants”.

name_sensitivity: str

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

classmethod parse_obj(data: Any) → IndividualWatchlistProgram[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IndividualWatchlistProgram[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.IndividualWatchlistProgramResponse(*, name_sensitivity: str, is_archived: bool, created_at: str, id: str, lists_enabled: List[str], audit_trail: WatchlistScreeningAuditTrail, request_id: str, is_rescanning_enabled: bool, name: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

created_at: str

An ISO8601 formatted timestamp.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated program.

is_archived: bool

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

is_rescanning_enabled: bool

Indicator specifying whether the program is enabled and will perform daily rescans.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

lists_enabled: List[str]

Watchlists enabled for the associated program

name_: str

A name for the program to define its purpose. For example, “High Risk Individuals”, “US Cardholders”, or “Applicants”.

name_sensitivity: str

The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every sensitivity.

coarse - See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.

balanced - A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.

strict - Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse and balanced settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.

exact - Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.

classmethod parse_obj(data: Any) → IndividualWatchlistProgramResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IndividualWatchlistProgramResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.InflowModel(*, statement_day_of_month: str, transaction_name: str, income_amount: float, type: str, payment_day_of_month: float)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_amount: float

Amount of income per month. This value is required if type is monthly-income.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InflowModel[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InflowModel[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_day_of_month: float

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

statement_day_of_month: str

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if type is monthly-balance-payment or monthly-interest-only-payment.

transaction_name: str

The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

type: str

Inflow model. One of the following:

none: No income

monthly-income: Income occurs once per month monthly-balance-payment: Pays off the balance on a liability account at the given statement day of month.

monthly-interest-only-payment: Makes an interest-only payment on a liability account at the given statement day of month.

Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type credit with subtype credit or paypal, and account type loan with subtype student or mortgage.

class plaid2.model.InitialUpdateWebhook(*, webhook_type: str, webhook_code: str, error: Optional[str] = None, new_transactions: float, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[str]

The error code associated with the webhook.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_transactions: float

The number of new, unfetched transactions available.

classmethod parse_obj(data: Any) → InitialUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InitialUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

INITIAL_UPDATE

webhook_type: str

TRANSACTIONS

class plaid2.model.Institution(*, institution_id: str, products: List[str], payment_initiation_metadata: Optional[PaymentInitiationMetadata] = None, country_codes: List[str], routing_numbers: List[str], logo: Optional[str] = None, url: Optional[str] = None, primary_color: Optional[str] = None, name: str, status: Optional[InstitutionStatus] = None, auth_metadata: Optional[AuthSupportedMethods] = None, oauth: bool)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
auth_metadata: Optional[AuthSupportedMethods]

Metadata that captures information about the Auth features of an institution.

country_codes: List[str]

A list of the country codes supported by the institution.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: str

Unique identifier for the institution

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

Base64 encoded representation of the institution’s logo

name_: str

The official name of the institution

oauth: bool

Indicates that the institution has an OAuth login flow.

classmethod parse_obj(data: Any) → Institution[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Institution[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation_metadata: Optional[PaymentInitiationMetadata]

Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.

primary_color: Optional[str]

Hexadecimal representation of the primary color used by the institution

products: List[str]

//plaid.com/docs/auth/coverage/).

Type

A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return auth in the product array; institutions that do not list auth may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the auth_metadata object. For more details, see [Full Auth coverage](https

routing_numbers: List[str]

A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution.

status: Optional[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. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution’s status, Plaid will return null rather than potentially inaccurate data.

Institution status is accessible in the Dashboard and via the API using the /institutions/get_by_id endpoint with the include_status option set to true. Note that institution status is not available in the Sandbox environment.

url: Optional[str]

The URL for the institution’s website

class plaid2.model.InstitutionStatus(*, health_incidents: Optional[List[HealthIncident]] = None, item_logins: Optional[ProductStatus] = None, auth: Optional[ProductStatus] = None, investments: Optional[ProductStatus] = None, investments_updates: Optional[ProductStatus] = None, liabilities_updates: Optional[ProductStatus] = None, transactions_updates: Optional[ProductStatus] = None, liabilities: Optional[ProductStatus] = None, identity: Optional[ProductStatus] = None)[source]

Bases: BaseModel

auth: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

health_incidents: Optional[List[HealthIncident]]

Details of recent health incidents associated with the institution.

identity: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

investments: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

investments_updates: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

item_logins: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

liabilities: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

liabilities_updates: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

classmethod parse_obj(data: Any) → InstitutionStatus[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionStatus[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactions_updates: Optional[ProductStatus]

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

class plaid2.model.InstitutionsGetByIdRequest(*, country_codes: List[str], options: Optional[InstitutionsGetByIdRequestOptions] = None, institution_id: str)[source]

Bases: BaseModel

country_codes: List[str]

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the country_codes parameter is an optional parameter within the options object and will default to [US] if it is not supplied.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: str

The ID of the institution to get details about

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[InstitutionsGetByIdRequestOptions]

Specifies optional parameters for /institutions/get_by_id. If provided, must not be null.

classmethod parse_obj(data: Any) → InstitutionsGetByIdRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetByIdRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InstitutionsGetByIdRequestOptions(*, include_payment_initiation_metadata: Optional[bool] = None, include_optional_metadata: Optional[bool] = None, include_status: Optional[bool] = None, include_auth_metadata: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_auth_metadata: Optional[bool]

When true, returns metadata related to the Auth product indicating which auth methods are supported.

include_optional_metadata: Optional[bool]

When true, return an institution’s logo, brand color, and URL. When available, the bank’s logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is false.

Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.

include_payment_initiation_metadata: Optional[bool]

When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

include_status: Optional[bool]

If true, the response will include status information about the institution. Default value is false.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsGetByIdRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetByIdRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InstitutionsGetByIdResponse(*, request_id: str, institution: Institution)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution: Institution

Details relating to a specific financial institution

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsGetByIdResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetByIdResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.InstitutionsGetRequest(*, country_codes: List[str], options: Optional[InstitutionsGetRequestOptions] = None, offset: int, count: int)[source]

Bases: BaseModel

count: int

The total number of Institutions to return.

country_codes: List[str]

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.

In API versions 2019-05-29 and earlier, the country_codes parameter is an optional parameter within the options object and will default to [US] if it is not supplied.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: int

The number of Institutions to skip.

options: Optional[InstitutionsGetRequestOptions]

An optional object to filter /institutions/get results.

classmethod parse_obj(data: Any) → InstitutionsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InstitutionsGetRequestOptions(*, products: Optional[List[str]] = None, include_optional_metadata: Optional[bool] = None, oauth: Optional[bool] = None, include_auth_metadata: Optional[bool] = None, include_payment_initiation_metadata: Optional[bool] = None, routing_numbers: Optional[List[str]] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_auth_metadata: Optional[bool]

When true, returns metadata related to the Auth product indicating which auth methods are supported.

include_optional_metadata: Optional[bool]

When true, return the institution’s homepage URL, logo and primary brand color.

Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.

include_payment_initiation_metadata: Optional[bool]

When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

oauth: Optional[bool]

Limit results to institutions with or without OAuth login flows.

classmethod parse_obj(data: Any) → InstitutionsGetRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: Optional[List[str]]

Filter the Institutions based on which products they support.

routing_numbers: Optional[List[str]]

Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are not comprehensive; failure to match a given routing number to an institution does not mean that the institution is unsupported by Plaid.

class plaid2.model.InstitutionsGetResponse(*, total: int, request_id: str, institutions: List[Institution])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institutions: List[Institution]

A list of Plaid institutions

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

total: int

The total number of institutions available via this endpoint

class plaid2.model.InstitutionsSearchAccountFilter(*, depository: Optional[List[str]] = None, credit: Optional[List[str]] = None, investment: Optional[List[str]] = None, loan: Optional[List[str]] = None)[source]

Bases: BaseModel

credit: Optional[List[str]]
depository: Optional[List[str]]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: Optional[List[str]]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: Optional[List[str]]
classmethod parse_obj(data: Any) → InstitutionsSearchAccountFilter[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchAccountFilter[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InstitutionsSearchPaymentInitiationOptions(*, consent_id: Optional[str] = None, payment_id: Optional[str] = None)[source]

Bases: BaseModel

consent_id: Optional[str]

A unique ID identifying the payment consent

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsSearchPaymentInitiationOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchPaymentInitiationOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: Optional[str]

A unique ID identifying the payment

class plaid2.model.InstitutionsSearchRequest(*, options: Optional[InstitutionsSearchRequestOptions] = None, country_codes: List[str], products: Optional[List[str]] = None, query: str)[source]

Bases: BaseModel

country_codes: List[str]

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the country_codes parameter is an optional parameter within the options object and will default to [US] if it is not supplied.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[InstitutionsSearchRequestOptions]

An optional object to filter /institutions/search results.

classmethod parse_obj(data: Any) → InstitutionsSearchRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: Optional[List[str]]

Filter the Institutions based on whether they support all products listed in products. Provide null to get institutions regardless of supported products. Note that when auth is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if auth is not present in their product array.

query: str

The search query. Institutions with names matching the query are returned

class plaid2.model.InstitutionsSearchRequestOptions(*, include_optional_metadata: Optional[bool] = None, oauth: Optional[bool] = None, include_payment_initiation_metadata: Optional[bool] = None, payment_initiation: Optional[InstitutionsSearchPaymentInitiationOptions] = None, include_auth_metadata: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_auth_metadata: Optional[bool]

When true, returns metadata related to the Auth product indicating which auth methods are supported.

include_optional_metadata: Optional[bool]

When true, return the institution’s homepage URL, logo and primary brand color.

include_payment_initiation_metadata: Optional[bool]

When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

oauth: Optional[bool]

Limit results to institutions with or without OAuth login flows.

classmethod parse_obj(data: Any) → InstitutionsSearchRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation: Optional[InstitutionsSearchPaymentInitiationOptions]

Additional options that will be used to filter institutions by various Payment Initiation configurations.

class plaid2.model.InstitutionsSearchResponse(*, request_id: str, institutions: List[Institution])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institutions: List[Institution]

An array of institutions matching the search criteria

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsSearchResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.InvestmentAccountSubtype(value)[source]

Bases: str, Enum

An enumeration.

all = 'all'
brokerage = 'brokerage'
cash_isa = 'cash isa'
crypto_exchange = 'crypto exchange'
education_savings_account = 'education savings account'
fixed_annuity = 'fixed annuity'
gic = 'gic'
health_reimbursement_arrangement = 'health reimbursement arrangement'
hsa = 'hsa'
ira = 'ira'
isa = 'isa'
keogh = 'keogh'
lif = 'lif'
life_insurance = 'life insurance'
lira = 'lira'
lrif = 'lrif'
lrsp = 'lrsp'
mutual_fund = 'mutual fund'
non_taxable_brokerage_account = 'non-taxable brokerage account'
other = 'other'
other_annuity = 'other annuity'
other_insurance = 'other insurance'
pension = 'pension'
prif = 'prif'
profit_sharing_plan = 'profit sharing plan'
qshr = 'qshr'
rdsp = 'rdsp'
resp = 'resp'
retirement = 'retirement'
rlif = 'rlif'
roth = 'roth'
roth_401_k = 'roth 401k'
rrif = 'rrif'
rrsp = 'rrsp'
sarsep = 'sarsep'
sep_ira = 'sep ira'
simple_ira = 'simple ira'
sipp = 'sipp'
stock_plan = 'stock plan'
tfsa = 'tfsa'
trust = 'trust'
ugma = 'ugma'
utma = 'utma'
variable_annuity = 'variable annuity'
class plaid2.model.InvestmentTransaction(*, security_id: Optional[str] = None, investment_transaction_id: str, price: float, amount: float, name: str, type: str, account_id: str, date: str, cancel_transaction_id: Optional[str] = None, unofficial_currency_code: Optional[str] = None, iso_currency_code: Optional[str] = None, fees: Optional[float] = None, quantity: float, subtype: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
account_id: str

The account_id of the account against which this transaction posted.

amount: float

The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.

cancel_transaction_id: Optional[str]

A legacy field formerly used internally by Plaid to identify certain canceled transactions.

date: str

//wikipedia.org/wiki/ISO_8601) posting date for the transaction.

Type

The [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

fees: Optional[float]

The combined value of all fees applied to this transaction

investment_transaction_id: str

The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the investment_transaction_id is case sensitive.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The institution’s description of the transaction.

classmethod parse_obj(data: Any) → InvestmentTransaction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentTransaction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

price: float

The price of the security at which this transaction occurred.

quantity: float

The number of units of the security involved in this transaction.

security_id: Optional[str]

The security_id to which this transaction is related.

subtype: str

//plaid.com/docs/api/accounts/#investment-transaction-types-schema).

Type

For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https

type: str

Value is one of the following: buy: Buying an investment sell: Selling an investment cancel: A cancellation of a pending transaction cash: Activity that modifies a cash position fee: A fee on the account transfer: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer

For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the holding. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.InvestmentTransactionSubtype(value)[source]

Bases: str, Enum

An enumeration.

account_fee = 'account fee'
adjustment = 'adjustment'
assignment = 'assignment'
buy = 'buy'
buy_to_cover = 'buy to cover'
contribution = 'contribution'
deposit = 'deposit'
distribution = 'distribution'
dividend = 'dividend'
dividend_reinvestment = 'dividend reinvestment'
exercise = 'exercise'
expire = 'expire'
fund_fee = 'fund fee'
interest = 'interest'
interest_receivable = 'interest receivable'
interest_reinvestment = 'interest reinvestment'
legal_fee = 'legal fee'
loan_payment = 'loan payment'
long_term_capital_gain = 'long-term capital gain'
long_term_capital_gain_reinvestment = 'long-term capital gain reinvestment'
management_fee = 'management fee'
margin_expense = 'margin expense'
merger = 'merger'
miscellaneous_fee = 'miscellaneous fee'
non_qualified_dividend = 'non-qualified dividend'
non_resident_tax = 'non-resident tax'
pending_credit = 'pending credit'
pending_debit = 'pending debit'
qualified_dividend = 'qualified dividend'
rebalance = 'rebalance'
request = 'request'
return_of_principal = 'return of principal'
sell = 'sell'
sell_short = 'sell short'
send = 'send'
short_term_capital_gain = 'short-term capital gain'
short_term_capital_gain_reinvestment = 'short-term capital gain reinvestment'
spin_off = 'spin off'
split_ = 'split'
stock_distribution = 'stock distribution'
tax = 'tax'
tax_withheld = 'tax withheld'
transfer = 'transfer'
transfer_fee = 'transfer fee'
trust_fee = 'trust fee'
unqualified_gain = 'unqualified gain'
withdrawal = 'withdrawal'
class plaid2.model.InvestmentTransactionType(value)[source]

Bases: str, Enum

An enumeration.

buy = 'buy'
cancel = 'cancel'
cash = 'cash'
fee = 'fee'
sell = 'sell'
transfer = 'transfer'
class plaid2.model.InvestmentsDefaultUpdateWebhook(*, new_investments_transactions: float, canceled_investments_transactions: float, webhook_type: str, webhook_code: str, item_id: str, error: Optional[Error] = None)[source]

Bases: BaseModel

canceled_investments_transactions: float

The number of canceled transactions reported since the last time this webhook was fired.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_investments_transactions: float

The number of new transactions reported since the last time this webhook was fired.

classmethod parse_obj(data: Any) → InvestmentsDefaultUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsDefaultUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

DEFAULT_UPDATE

webhook_type: str

INVESTMENTS_TRANSACTIONS

class plaid2.model.InvestmentsHoldingsGetRequest(*, access_token: str, options: Optional[List[str]] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /investments/holdings/get results. If provided, must not be null.

classmethod parse_obj(data: Any) → InvestmentsHoldingsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsHoldingsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InvestmentsHoldingsGetResponse(*, request_id: str, holdings: List[Holding], securities: List[Security], accounts: List[AccountBase], item: Item)[source]

Bases: BaseModel

accounts: List[AccountBase]

The accounts associated with the Item

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

holdings: List[Holding]

The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the securities field.

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InvestmentsHoldingsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsHoldingsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

securities: List[Security]

Objects describing the securities held in the accounts associated with the Item.

class plaid2.model.InvestmentsTransactionsGetRequest(*, start_date: str, options: Optional[InvestmentsTransactionsGetRequestOptions] = None, end_date: str, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: str

The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[InvestmentsTransactionsGetRequestOptions]

An optional object to filter /investments/transactions/get results. If provided, must be non-null.

classmethod parse_obj(data: Any) → InvestmentsTransactionsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsTransactionsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: str

The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

class plaid2.model.InvestmentsTransactionsGetRequestOptions(*, offset: Optional[int] = None, count: Optional[int] = None, account_ids: Optional[List[str]] = None)[source]

Bases: BaseModel

account_ids: Optional[List[str]]

An array of account_ids to retrieve for the Item.

count: Optional[int]

The number of transactions to fetch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of transactions to skip when fetching transaction history

classmethod parse_obj(data: Any) → InvestmentsTransactionsGetRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsTransactionsGetRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.InvestmentsTransactionsGetResponse(*, request_id: str, total_investment_transactions: int, item: Item, investment_transactions: List[InvestmentTransaction], securities: List[Security], accounts: List[AccountBase])[source]

Bases: BaseModel

accounts: List[AccountBase]

The accounts for which transaction history is being fetched.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment_transactions: List[InvestmentTransaction]

The transactions being fetched

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InvestmentsTransactionsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsTransactionsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

securities: List[Security]

All securities for which there is a corresponding transaction being fetched.

total_investment_transactions: int

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

class plaid2.model.InvestmentsTransactionsOverride(*, quantity: float, fees: Optional[float] = None, date: str, currency: str, security: Optional[SecurityOverride] = None, price: float, name: str, type: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
currency: str

Either a valid iso_currency_code or unofficial_currency_code

date: str

//wikipedia.org/wiki/ISO_8601) date.

Type

Posting date for the transaction. Must be formatted as an [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

fees: Optional[float]

The combined value of all fees applied to this transaction.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The institution’s description of the transaction.

classmethod parse_obj(data: Any) → InvestmentsTransactionsOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InvestmentsTransactionsOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

price: float

The price of the security at which this transaction occurred.

quantity: float

The number of units of the security involved in this transaction. Must be positive if the type is a buy and negative if the type is a sell.

security: Optional[SecurityOverride]

Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (ticker_symbol, cusip, isin, or sedol) are required.

type: str

The type of the investment transaction. Possible values are: buy: Buying an investment sell: Selling an investment cash: Activity that modifies a cash position fee: A fee on the account transfer: Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer

class plaid2.model.IssuingCountry(value)[source]

Bases: str, Enum

An enumeration.

match = 'match'
no_match = 'no_match'
class plaid2.model.Item(*, webhook: Optional[str] = None, item_id: str, update_type: str, billed_products: List[str], products: Optional[List[str]] = None, consented_products: Optional[List[str]] = None, error: Optional[Error] = None, available_products: List[str], consent_expiration_time: Optional[str] = None, institution_id: Optional[str] = None)[source]

Bases: BaseModel

available_products: List[str]

A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products.

billed_products: List[str]

A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.

consent_expiration_time: Optional[str]

The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ITEM_LOGIN_REQUIRED error state. To circumvent the ITEM_LOGIN_REQUIRED error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.

Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.

consented_products: Optional[List[str]]

A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.

Type

Beta

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

institution_id: Optional[str]

The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.

item_id: str

The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Item[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Item[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: Optional[List[str]]

A list of authorized products for the Item.

update_type: str

Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.

background - Item can be updated in the background

user_present_required - Item requires user interaction to be updated

webhook: Optional[str]

The URL registered to receive webhooks for the Item.

class plaid2.model.ItemAccessTokenInvalidateResponse(*, request_id: str, new_access_token: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_access_token: str

The access token associated with the Item data is being requested for.

classmethod parse_obj(data: Any) → ItemAccessTokenInvalidateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemAccessTokenInvalidateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ItemApplicationListResponse(*, request_id: Optional[str] = None, applications: List[ConnectedApplication])[source]

Bases: BaseModel

applications: List[ConnectedApplication]

A list of connected applications.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemApplicationListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemApplicationListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: Optional[str]

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

class plaid2.model.ItemApplicationListUserAuth(*, fi_username_hash: Optional[str] = None, user_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

fi_username_hash: Optional[str]

Account username hashed by FI.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemApplicationListUserAuth[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemApplicationListUserAuth[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_id: Optional[str]

Account username.

class plaid2.model.ItemApplicationScopesUpdateRequest(*, scopes: Scopes, state: Optional[str] = None, context: str, access_token: str, application_id: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

application_id: str

This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.

context: str

An indicator for when scopes are being updated. When scopes are updated via enrollment (i.e. OAuth), the partner must send ENROLLMENT. When scopes are updated in a post-enrollment view, the partner must send PORTAL.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemApplicationScopesUpdateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemApplicationScopesUpdateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

scopes: Scopes

The scopes object

state: Optional[str]

When scopes are updated during enrollment, this field must be populated with the state sent to the partner in the OAuth Login URI. This field is required when the context is ENROLLMENT.

class plaid2.model.ItemApplicationScopesUpdateResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemApplicationScopesUpdateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemApplicationScopesUpdateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ItemErrorWebhook(*, webhook_type: str, webhook_code: str, error: Optional[Error] = None, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemErrorWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemErrorWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

ERROR

webhook_type: str

ITEM

class plaid2.model.ItemGetResponse(*, status: Optional[ItemStatus] = None, item: Item, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

status: Optional[ItemStatus]

Information about the last successful and failed transactions update for the Item.

class plaid2.model.ItemImportRequest(*, products: List[str], user_auth: ItemImportRequestUserAuth, options: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[str]

An optional object to configure /item/import request.

classmethod parse_obj(data: Any) → ItemImportRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemImportRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: List[str]

Array of product strings

user_auth: ItemImportRequestUserAuth

Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts

class plaid2.model.ItemImportRequestUserAuth(*, auth_token: str, user_id: str)[source]

Bases: BaseModel

auth_token: str

Authorization token Plaid will use to aggregate this user’s accounts

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemImportRequestUserAuth[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemImportRequestUserAuth[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_id: str

Opaque user identifier

class plaid2.model.ItemImportResponse(*, request_id: str, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemImportResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemImportResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ItemProductReadyWebhook(*, item_id: str, error: Optional[Error] = None, webhook_type: str, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemProductReadyWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemProductReadyWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

PRODUCT_READY

webhook_type: str

INCOME

class plaid2.model.ItemPublicTokenCreateResponse(*, request_id: str, public_token: str, expiration: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expiration: Optional[str]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemPublicTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemPublicTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

public_token: str

A public_token for the particular Item corresponding to the specified access_token

request_id: str

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

class plaid2.model.ItemPublicTokenExchangeResponse(*, access_token: str, item_id: str, request_id: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id value of the Item associated with the returned access_token

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemPublicTokenExchangeResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemPublicTokenExchangeResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ItemRemoveResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ItemStatus(*, transactions: Optional[ItemStatusTransactions] = None, investments: Optional[ItemStatusInvestments] = None, last_webhook: Optional[ItemStatusLastWebhook] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investments: Optional[ItemStatusInvestments]

Information about the last successful and failed investments update for the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_webhook: Optional[ItemStatusLastWebhook]

Information about the last webhook fired for the Item.

classmethod parse_obj(data: Any) → ItemStatus[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemStatus[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactions: Optional[ItemStatusTransactions]

Information about the last successful and failed transactions update for the Item.

class plaid2.model.ItemStatusInvestments(*, last_successful_update: Optional[str] = None, last_failed_update: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_failed_update: Optional[str]

//wikipedia.org/wiki/ISO_8601) timestamp of the last failed investments update for the Item. The status will update each time Plaid fails an attempt to connect with the institution, regardless of whether any new data is available in the update.

Type

[ISO 8601](https

last_successful_update: Optional[str]

//wikipedia.org/wiki/ISO_8601) timestamp of the last successful investments update for the Item. The status will update each time Plaid successfully connects with the institution, regardless of whether any new data is available in the update.

Type

[ISO 8601](https

classmethod parse_obj(data: Any) → ItemStatusInvestments[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemStatusInvestments[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ItemStatusLastWebhook(*, code_sent: Optional[str] = None, sent_at: Optional[str] = None)[source]

Bases: BaseModel

code_sent: Optional[str]

The last webhook code sent.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemStatusLastWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemStatusLastWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sent_at: Optional[str]

//wikipedia.org/wiki/ISO_8601) timestamp of when the webhook was fired.

Type

[ISO 8601](https

class plaid2.model.ItemStatusTransactions(*, last_failed_update: Optional[str] = None, last_successful_update: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_failed_update: Optional[str]

//wikipedia.org/wiki/ISO_8601) timestamp of the last failed transactions update for the Item. The status will update each time Plaid fails an attempt to connect with the institution, regardless of whether any new data is available in the update.

Type

[ISO 8601](https

last_successful_update: Optional[str]

//wikipedia.org/wiki/ISO_8601) timestamp of the last successful transactions update for the Item. The status will update each time Plaid successfully connects with the institution, regardless of whether any new data is available in the update.

Type

[ISO 8601](https

classmethod parse_obj(data: Any) → ItemStatusTransactions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemStatusTransactions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ItemWebhookUpdateRequest(*, access_token: str, webhook: Optional[str] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemWebhookUpdateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemWebhookUpdateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook: Optional[str]

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

class plaid2.model.ItemWebhookUpdateResponse(*, request_id: str, item: Item)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ItemWebhookUpdateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ItemWebhookUpdateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.JwkPublicKey(*, crv: str, y: str, x: str, created_at: int, use: str, kid: str, alg: str, kty: str, expired_at: Optional[int] = None)[source]

Bases: BaseModel

alg: str

The alg member identifies the cryptographic algorithm family used with the key.

created_at: int

The timestamp when the key was created, in Unix time.

crv: str

The crv member identifies the cryptographic curve used with the key.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expired_at: Optional[int]

The timestamp when the key expired, in Unix time.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

kid: str

The kid (Key ID) member can be used to match a specific key. This can be used, for instance, to choose among a set of keys within the JWK during key rollover.

kty: str

The kty (key type) parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC.

classmethod parse_obj(data: Any) → JwkPublicKey[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → JwkPublicKey[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

use: str

The use (public key use) parameter identifies the intended use of the public key.

x: str

The x member contains the x coordinate for the elliptic curve point.

y: str

The y member contains the y coordinate for the elliptic curve point.

class plaid2.model.KycCheckAddressSummary(*, type: str, summary: str, po_box: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → KycCheckAddressSummary[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → KycCheckAddressSummary[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

po_box: str

Field describing whether the associated address is a post office box. Will be yes when a P.O. box is detected, no when Plaid confirmed the address is not a P.O. box, and no_data when Plaid was not able to determine if the address is a P.O. box.

summary: str

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

type: str

Field describing whether the associated address is being used for commercial or residential purposes.

Note: This value will be no_data when Plaid does not have sufficient data to determine the address’s use.

class plaid2.model.KycCheckDetails(*, id_number: str, address: KycCheckAddressSummary, date_of_birth: str, phone_number: str, name: str, status: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: KycCheckAddressSummary

Result summary object specifying how the address field matched.

date_of_birth: str

Result summary object specifying how the date_of_birth field matched.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id_number: str

Result summary object specifying how the id_number field matched.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

Result summary object specifying how the name field matched.

classmethod parse_obj(data: Any) → KycCheckDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → KycCheckDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: str

Result summary object specifying how the phone field matched.

status: str

The outcome status for the associated Identity Verification attempt’s kyc_check step. This field will always have the same value as steps.kyc_check.

class plaid2.model.LiabilitiesAccountIdsWithUpdatedLiabilities[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LiabilitiesAccountIdsWithUpdatedLiabilities[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilitiesAccountIdsWithUpdatedLiabilities[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LiabilitiesDefaultUpdateWebhook(*, error: Optional[Error] = None, account_ids_with_updated_liabilities: LiabilitiesAccountIdsWithUpdatedLiabilities, webhook_type: str, webhook_code: str, item_id: str, account_ids_with_new_liabilities: List[str])[source]

Bases: BaseModel

account_ids_with_new_liabilities: List[str]

An array of account_id’s for accounts that contain new liabilities.’

account_ids_with_updated_liabilities: LiabilitiesAccountIdsWithUpdatedLiabilities

An object with keys of account_id’s that are mapped to their respective liabilities fields that changed.

Example: { “XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58”: [“past_amount_due”] }

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LiabilitiesDefaultUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilitiesDefaultUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

DEFAULT_UPDATE

webhook_type: str

LIABILITIES

class plaid2.model.LiabilitiesGetRequest(*, access_token: str, options: Optional[List[str]] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[List[str]]

An optional object to filter /liabilities/get results. If provided, options cannot be null.

classmethod parse_obj(data: Any) → LiabilitiesGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilitiesGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LiabilitiesGetResponse(*, request_id: str, accounts: List[AccountBase], item: Item, liabilities: LiabilitiesObject)[source]

Bases: BaseModel

accounts: List[AccountBase]

An array of accounts associated with the Item

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

liabilities: LiabilitiesObject

An object containing liability accounts

classmethod parse_obj(data: Any) → LiabilitiesGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilitiesGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.LiabilitiesObject(*, mortgage: Optional[List[MortgageLiability]] = None, credit: Optional[List[CreditCardLiability]] = None, student: Optional[List[StudentLoan]] = None)[source]

Bases: BaseModel

credit: Optional[List[CreditCardLiability]]

The credit accounts returned.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mortgage: Optional[List[MortgageLiability]]

The mortgage accounts returned.

classmethod parse_obj(data: Any) → LiabilitiesObject[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilitiesObject[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

student: Optional[List[StudentLoan]]

The student loan accounts returned.

class plaid2.model.LiabilityOverride(*, origination_date: str, loan_name: str, cash_apr: float, interest_capitalization_grace_period_months: float, last_payment_amount: float, pslf_status: PslfStatus, nominal_apr: float, expected_payoff_date: str, purchase_apr: float, is_overdue: bool, servicer_address: Address, type: str, minimum_payment_amount: float, principal: float, payment_reference_number: str, repayment_plan_description: str, repayment_model: StudentLoanRepaymentModel, special_apr: float, sequence_number: str, balance_transfer_apr: float, is_federal: bool, guarantor: str, loan_status: StudentLoanStatus, repayment_plan_type: str)[source]

Bases: BaseModel

balance_transfer_apr: float

The balance transfer APR percentage value. Can only be set if type is credit. Can only be set if type is credit.

cash_apr: float

The cash APR percentage value. Can only be set if type is credit.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expected_payoff_date: str

Override the expected_payoff_date field. Can only be set if type is student.

guarantor: str

Override the guarantor field. Can only be set if type is student.

interest_capitalization_grace_period_months: float

If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if type is student.

is_federal: bool

Override the is_federal field. Can only be set if type is student.

is_overdue: bool

Override the is_overdue field

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: float

Override the last_payment_amount field. Can only be set if type is credit.

loan_name: str

Override the loan_name field. Can only be set if type is student.

loan_status: StudentLoanStatus

An object representing the status of the student loan

minimum_payment_amount: float

Override the minimum_payment_amount field. Can only be set if type is credit or student.

nominal_apr: float

The interest rate on the loan as a percentage. Can only be set if type is student.

origination_date: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Can only be set if type is student.

Type

The date on which the loan was initially lent, in [ISO 8601](https

classmethod parse_obj(data: Any) → LiabilityOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LiabilityOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_reference_number: str

Override the payment_reference_number field. Can only be set if type is student.

principal: float

The original loan principal. Can only be set if type is student.

pslf_status: PslfStatus

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

purchase_apr: float

The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if type is credit.

repayment_model: StudentLoanRepaymentModel

Student loan repayment information used to configure Sandbox test data for the Liabilities product

repayment_plan_description: str

Override the repayment_plan.description field. Can only be set if type is student.

repayment_plan_type: str

“extended graduated”, “extended standard”, “graduated”, “income-contingent repayment”, “income-based repayment”, “interest only”, “other”, “pay as you earn”, “revised pay as you earn”, or “standard”.

Type

Override the repayment_plan.type field. Can only be set if type is student. Possible values are

sequence_number: str

Override the sequence_number field. Can only be set if type is student.

servicer_address: Address

A physical mailing address.

special_apr: float

The special APR percentage value. Can only be set if type is credit.

type: str

The type of the liability object, either credit or student. Mortgages are not currently supported in the custom Sandbox.

class plaid2.model.LinkTokenAccountFilters(*, credit: Optional[List[str]] = None, depository: Optional[List[str]] = None, loan: Optional[List[str]] = None, investment: Optional[List[str]] = None)[source]

Bases: BaseModel

credit: Optional[List[str]]

A filter to apply to credit-type accounts

depository: Optional[List[str]]

A filter to apply to depository-type accounts

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: Optional[List[str]]

A filter to apply to investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: Optional[List[str]]

A filter to apply to loan-type accounts

classmethod parse_obj(data: Any) → LinkTokenAccountFilters[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenAccountFilters[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LinkTokenCreateRequest(*, income_verification: Optional[LinkTokenCreateRequestIncomeVerification] = None, client_name: str, institution_data: Optional[str] = None, auth: Optional[LinkTokenCreateRequestAuth] = None, transfer: Optional[LinkTokenCreateRequestTransfer] = None, additional_consented_products: Optional[List[str]] = None, products: Optional[List[str]] = None, identity_verification: Optional[LinkTokenCreateRequestIdentityVerification] = None, account_filters: Optional[LinkTokenAccountFilters] = None, webhook: Optional[str] = None, eu_config: Optional[bool] = None, update: Optional[bool] = None, country_codes: List[str], android_package_name: Optional[str] = None, language: str, user_token: Optional[str] = None, link_customization_name: Optional[str] = None, institution_id: Optional[str] = None, user: LinkTokenCreateRequestUser, redirect_uri: Optional[str] = None, access_token: Optional[str] = None, payment_initiation: Optional[LinkTokenCreateRequestPaymentInitiation] = None, deposit_switch: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The access_token associated with the Item to update, used when updating or modifying an existing access_token. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow.

account_filters: Optional[LinkTokenAccountFilters]

//plaid.com/docs/api/accounts#account-type-schema).

For institutions using OAuth, the filter will not affect the list of accounts shown by the bank in the OAuth window.

Type

By default, Link will provide limited account filtering

Type

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. You can further limit the accounts shown in Link by using account_filters to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value “all”. If the account_filters filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the [Account schema](https

additional_consented_products: Optional[List[str]]

(Beta) This field has no effect unless you are participating in the Product Scope Transparency beta program. List of additional Plaid product(s) you wish to collect consent for. These products will not be billed until you start using them by calling the relevant endpoints.

balance is not a valid value, the Balance product does not require explicit initialization and will automatically have consent collected.

Institutions that do not support these products will still be shown in Link

android_package_name: Optional[str]

//dashboard.plaid.com/team/api).

Type

The name of your app’s Android package. Required if using the link_token to initialize Link on Android. When creating a link_token for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](https

auth: Optional[LinkTokenCreateRequestAuth]

Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link session. Omitting any field will result in a default that can be configured by your account manager.

client_name: str

The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display “This Application” instead.

country_codes: List[str]

//plaid.com/global/.

If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.

If using a Link customization, make sure the country codes in the customization match those specified in country_codes. If both country_codes and a Link customization are used, the value in country_codes may override the value in the customization.

If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, country_codes must be set to [‘US’].

Type

Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. Supported country codes are

Type

US, CA, DE, ES, FR, GB, IE, IT, NL. For a complete mapping of supported products by country, see https

deposit_switch: Optional[str]

Specifies options for initializing Link for use with the Deposit Switch (beta) product. This field is required if deposit_switch is included in the products array.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

eu_config: Optional[bool]

Configuration parameters for EU flows

identity_verification: Optional[LinkTokenCreateRequestIdentityVerification]

Specifies option for initializing Link for use with the Identity Verification product.

income_verification: Optional[LinkTokenCreateRequestIncomeVerification]

Specifies options for initializing Link for use with the Income (beta) product. This field is required if income_verification is included in the products array.

institution_data: Optional[str]

A map containing data used to highlight institutions in Link.

institution_id: Optional[str]

Used for certain Europe-only configurations, as well as certain legacy use cases in other regions.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

language: str

The language that Link should be displayed in.

Supported languages are: - English (‘en’) - French (‘fr’) - Spanish (‘es’) - Dutch (‘nl’) - German(‘de’)

When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.

The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the default customization will be used. When using a Link customization, the language in the customization must match the language selected via the language parameter, and the countries in the customization should match the country codes selected via country_codes.

classmethod parse_obj(data: Any) → LinkTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation: Optional[LinkTokenCreateRequestPaymentInitiation]

Specifies options for initializing Link for use with the Payment Initiation (Europe) product. This field is required if payment_initiation is included in the products array.

products: Optional[List[str]]

List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise.

balance is not a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized.

The products specified here will determine which institutions will be available to your users in Link. Only institutions that support all requested products can be selected; a if a user attempts to select an institution that does not support a listed product, a “Connectivity not supported” error message will appear in Link. To maximize the number of institutions available, initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](https://plaid.com/docs/link/best-practices/#choosing-when-to-initialize-products).

Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if auth is specified as a product, even though these institutions do not contain auth in their product array.

In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via /item/remove.

redirect_uri: Optional[str]

//dashboard.plaid.com/team/api).

Type

A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The redirect_uri should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use * as a wildcard character, e.g. `https

Type

//*.example.com/oauth.html`. If android_package_name is specified, this field should be left blank. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](https

transfer: Optional[LinkTokenCreateRequestTransfer]

Specifies options for initializing Link for use with the Transfer product.

update: Optional[bool]

//plaid.com/docs/link/update-mode).

Type

Specifies options for initializing Link for [update mode](https

user: LinkTokenCreateRequestUser

An object specifying information about the end user who will be linking their account.

user_token: Optional[str]

A user token generated using /user/create. Any item created during the link session will be associated with the user.

webhook: Optional[str]

The destination URL to which any webhooks should be sent.

class plaid2.model.LinkTokenCreateRequestAccountSubtypes(*, credit: Optional[List[str]] = None, investment: Optional[List[str]] = None, loan: Optional[List[str]] = None, depository: Optional[List[str]] = None)[source]

Bases: BaseModel

credit: Optional[List[str]]

A filter to apply to credit-type accounts

depository: Optional[List[str]]

A filter to apply to depository-type accounts

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: Optional[List[str]]

A filter to apply to investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: Optional[List[str]]

A filter to apply to loan-type accounts

classmethod parse_obj(data: Any) → LinkTokenCreateRequestAccountSubtypes[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestAccountSubtypes[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LinkTokenCreateRequestAuth(*, flow_type: Optional[str] = None, auth_type_select_enabled: Optional[bool] = None, automated_microdeposits_enabled: Optional[bool] = None, instant_match_enabled: Optional[bool] = None, same_day_microdeposits_enabled: Optional[bool] = None)[source]

Bases: BaseModel

auth_type_select_enabled: Optional[bool]

Specifies whether Auth Type Select is enabled for the Link session, allowing the end user to choose between linking instantly or manually prior to selecting their financial institution. Note that this can only be true if same_day_microdeposits_enabled is set to true.

automated_microdeposits_enabled: Optional[bool]

Specifies whether the Link session is enabled for the Automated Micro-deposits flow.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

flow_type: Optional[str]

This field has been deprecated in favor of auth_type_select_enabled.

instant_match_enabled: Optional[bool]

Specifies whether the Link session is enabled for the Instant Match flow.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestAuth[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestAuth[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

same_day_microdeposits_enabled: Optional[bool]

Specifies whether the Link session is enabled for the Same Day Micro-deposits flow.

class plaid2.model.LinkTokenCreateRequestIdentityVerification(*, consent: Optional[bool] = None, template_id: str, gave_consent: Optional[bool] = None)[source]

Bases: BaseModel

consent: Optional[bool]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes.

If gave_consent is set to true, the accept_tos step will be marked as skipped and the end user’s session will start at the next step requirement.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestIdentityVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestIdentityVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

template_id: str

ID of the associated Identity Verification template.

class plaid2.model.LinkTokenCreateRequestIncomeVerification(*, stated_income_sources: Optional[List[LinkTokenCreateRequestUserStatedIncomeSource]] = None, precheck_id: Optional[str] = None, income_source_types: Optional[List[str]] = None, access_tokens: Optional[List[str]] = None, asset_report_id: Optional[str] = None, income_verification_id: Optional[str] = None, payroll_income: Optional[LinkTokenCreateRequestIncomeVerificationPayrollIncome] = None, bank_income: Optional[LinkTokenCreateRequestIncomeVerificationBankIncome] = None)[source]

Bases: BaseModel

access_tokens: Optional[List[str]]

An array of access tokens corresponding to Items that a user has previously connected with. Data from these institutions will be cross-referenced with document data received during the Document Income flow to help verify that the uploaded documents are accurate. If the transactions product was not initialized for these Items during link, it will be initialized after this Link session.

This field should only be used with the payroll income source type.

asset_report_id: Optional[str]

The asset_report_id of an asset report associated with the user, as provided by /asset_report/create. Providing an asset_report_id is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped.

bank_income: Optional[LinkTokenCreateRequestIncomeVerificationBankIncome]

Specifies options for initializing Link for use with Bank Income. This field is required if income_verification is included in the products array and bank is specified in income_source_types.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

income_source_types: Optional[List[str]]

The types of source income data that users will be permitted to share. Options include bank and payroll. Currently you can only specify one of these options.

income_verification_id: Optional[str]

The income_verification_id of the verification instance, as provided by /income/verification/create.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestIncomeVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestIncomeVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payroll_income: Optional[LinkTokenCreateRequestIncomeVerificationPayrollIncome]

Specifies options for initializing Link for use with Payroll Income. This field is required if income_verification is included in the products array and payroll is specified in income_source_types.

precheck_id: Optional[str]

The ID of a precheck created with /income/verification/precheck. Will be used to improve conversion of the income verification flow by streamlining the Link interface presented to the end user.

stated_income_sources: Optional[List[LinkTokenCreateRequestUserStatedIncomeSource]]

A list of user stated income sources

class plaid2.model.LinkTokenCreateRequestIncomeVerificationBankIncome(*, enable_multiple_items: Optional[bool] = None, days_requested: Optional[int] = None)[source]

Bases: BaseModel

days_requested: Optional[int]

The number of days of data to request for the Bank Income product

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

enable_multiple_items: Optional[bool]

Whether to enable multiple items to be added in the link session

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestIncomeVerificationBankIncome[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestIncomeVerificationBankIncome[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LinkTokenCreateRequestIncomeVerificationPayrollIncome(*, flow_types: Optional[List[str]] = None, is_update_mode: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

flow_types: Optional[List[str]]

The types of payroll income verification to enable for the link session. If none are specified, then users will see both document and digital payroll income.

is_update_mode: Optional[bool]

An identifier to indicate whether the income verification link token will be used for an update or not

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestIncomeVerificationPayrollIncome[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestIncomeVerificationPayrollIncome[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.LinkTokenCreateRequestPaymentInitiation(*, payment_id: str, consent_id: Optional[str] = None)[source]

Bases: BaseModel

consent_id: Optional[str]

The consent_id provided by the /payment_initiation/consent/create endpoint.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestPaymentInitiation[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestPaymentInitiation[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

The payment_id provided by the /payment_initiation/payment/create endpoint.

class plaid2.model.LinkTokenCreateRequestTransfer(*, payment_profile_id: Optional[str] = None, intent_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

intent_id: Optional[str]

The id returned by the /transfer/intent/create endpoint.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestTransfer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestTransfer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_profile_id: Optional[str]

The payment_profile_id returned by the /payment_profile/create endpoint.

class plaid2.model.LinkTokenCreateRequestUser(*, name: Optional[UserName] = None, date_of_birth: Optional[str] = None, client_user_id: str, address: Optional[UserAddress] = None, phone_number_verified_time: Optional[str] = None, id_number: Optional[UserIdNumber] = None, legal_name: Optional[str] = None, email_address_verified_time: Optional[str] = None, phone_number: Optional[str] = None, ssn: Optional[str] = None, email_address: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[UserAddress]

Home address for the user.

client_user_id: str

A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. It is currently used as a means of searching logs for the given user in the Plaid Dashboard.

date_of_birth: Optional[str]

To be provided in the format “yyyy-mm-dd”. Not currently used.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

//plaid.com/docs/link/returning-user/#enabling-the-returning-user-experience).

Type

The user’s email address. This field is optional, but required to enable the [pre-authenticated returning user flow](https

email_address_verified_time: Optional[str]

mm:ssZ`). This is an optional field used in the [returning user experience](https://plaid.com/docs/link/returning-user).

Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.

Example: 2020-01-01T00:00:00Z

Type

The date and time the email address was verified in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh

id_number: Optional[UserIdNumber]

ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: Optional[str]

The user’s full legal name. Currently used only to support certain legacy flows.

name_: Optional[UserName]

//plaid.com/docs/api/products/identity-verification) product; if not using Identity Verification, this field is not allowed. Users will not be asked for their name when this field is provided.

Type

The user’s full name. Optional if using the [Identity Verification](https

classmethod parse_obj(data: Any) → LinkTokenCreateRequestUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

//plaid.com/docs/link/returning-user).

Type

The user’s phone number in [E.164](https

Type

//en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](https

phone_number_verified_time: Optional[str]

mm:ssZ`). This field is optional, but required to enable any [returning user experience](https://plaid.com/docs/link/returning-user).

Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.

Example: 2020-01-01T00:00:00Z

Type

The date and time the phone number was verified in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh

ssn: Optional[str]

To be provided in the format “ddd-dd-dddd”. Not currently used.

class plaid2.model.LinkTokenCreateRequestUserStatedIncomeSource(*, employer: Optional[str] = None, pay_per_cycle: Optional[float] = None, category: Optional[str] = None, pay_frequency: Optional[str] = None, pay_annual: Optional[float] = None, pay_type: Optional[str] = None)[source]

Bases: BaseModel

category: Optional[str]

The income category for a specified income source

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer: Optional[str]

The employer corresponding to an income source specified by the user

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → LinkTokenCreateRequestUserStatedIncomeSource[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateRequestUserStatedIncomeSource[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_annual: Optional[float]

The income amount paid annually for a specified income source

pay_frequency: Optional[str]

The pay frequency of a specified income source

pay_per_cycle: Optional[float]

The income amount paid per cycle for a specified income source

pay_type: Optional[str]

The pay type - GROSS, NET, or UNKNOWN for a specified income source

class plaid2.model.LinkTokenCreateResponse(*, request_id: str, link_token: str, expiration: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expiration: str

//wikipedia.org/wiki/ISO_8601) format. A link_token created to generate a public_token that will be exchanged for a new access_token expires after 4 hours. A link_token created for an existing Item (such as when updating an existing access_token by launching Link in update mode) expires after 30 minutes.

Type

The expiration date for the link_token, in [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

A link_token, which can be supplied to Link in order to initialize it and receive a public_token, which can be exchanged for an access_token.

classmethod parse_obj(data: Any) → LinkTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.LinkTokenGetMetadataResponse(*, country_codes: List[str], language: Optional[str] = None, client_name: Optional[str] = None, redirect_uri: Optional[str] = None, initial_products: List[str], institution_data: Optional[str] = None, webhook: Optional[str] = None, account_filters: Optional[AccountFiltersResponse] = None)[source]

Bases: BaseModel

account_filters: Optional[AccountFiltersResponse]

The account_filters specified in the original call to /link/token/create.

client_name: Optional[str]

The client_name specified in the /link/token/create call.

country_codes: List[str]

The country_codes specified in the /link/token/create call.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

initial_products: List[str]

The products specified in the /link/token/create call.

institution_data: Optional[str]

A map containing data used to highlight institutions in Link.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

language: Optional[str]

The language specified in the /link/token/create call.

classmethod parse_obj(data: Any) → LinkTokenGetMetadataResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenGetMetadataResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

redirect_uri: Optional[str]

The redirect_uri specified in the /link/token/create call.

webhook: Optional[str]

The webhook specified in the /link/token/create call.

class plaid2.model.LinkTokenGetResponse(*, created_at: Optional[str] = None, metadata: LinkTokenGetMetadataResponse, expiration: Optional[str] = None, link_token: str, request_id: str)[source]

Bases: BaseModel

created_at: Optional[str]

//wikipedia.org/wiki/ISO_8601) format.

Type

The creation timestamp for the link_token, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expiration: Optional[str]

//wikipedia.org/wiki/ISO_8601) format.

Type

The expiration timestamp for the link_token, in [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

A link_token, which can be supplied to Link in order to initialize it and receive a public_token, which can be exchanged for an access_token.

metadata: LinkTokenGetMetadataResponse

An object specifying the arguments originally provided to the /link/token/create call.

classmethod parse_obj(data: Any) → LinkTokenGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → LinkTokenGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ListEntityWatchlistScreeningRequest(*, status: Optional[str] = None, cursor: Optional[str] = None, assignee: Optional[str] = None, client_user_id: Optional[str] = None, entity_watchlist_program_id: str)[source]

Bases: BaseModel

assignee: Optional[str]
client_user_id: Optional[str]
cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_program_id: str

ID of the associated entity program.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListEntityWatchlistScreeningRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListEntityWatchlistScreeningRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: Optional[str]
class plaid2.model.ListIdentityVerificationRequest(*, template_id: str, client_user_id: str, cursor: Optional[str] = None)[source]

Bases: BaseModel

client_user_id: str

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListIdentityVerificationRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListIdentityVerificationRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

template_id: str

ID of the associated Identity Verification template.

class plaid2.model.ListIndividualWatchlistScreeningRequest(*, watchlist_program_id: str, assignee: Optional[str] = None, client_user_id: Optional[str] = None, cursor: Optional[str] = None, status: Optional[str] = None)[source]

Bases: BaseModel

assignee: Optional[str]
client_user_id: Optional[str]
cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListIndividualWatchlistScreeningRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListIndividualWatchlistScreeningRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: Optional[str]
watchlist_program_id: str

ID of the associated program.

class plaid2.model.ListWatchlistScreeningEntityHistoryRequest(*, entity_watchlist_screening_id: str, cursor: Optional[str] = None)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningEntityHistoryRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningEntityHistoryRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ListWatchlistScreeningEntityHitRequest(*, entity_watchlist_screening_id: str, cursor: Optional[str] = None)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningEntityHitRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningEntityHitRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ListWatchlistScreeningEntityReviewsRequest(*, entity_watchlist_screening_id: str, cursor: Optional[str] = None)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningEntityReviewsRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningEntityReviewsRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ListWatchlistScreeningIndividualHistoryRequest(*, cursor: Optional[str] = None, watchlist_screening_id: str)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningIndividualHistoryRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningIndividualHistoryRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_screening_id: str

ID of the associated screening.

class plaid2.model.ListWatchlistScreeningIndividualHitRequest(*, cursor: Optional[str] = None, watchlist_screening_id: str)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningIndividualHitRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningIndividualHitRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_screening_id: str

ID of the associated screening.

class plaid2.model.ListWatchlistScreeningIndividualReviewsRequest(*, watchlist_screening_id: str, cursor: Optional[str] = None)[source]

Bases: BaseModel

cursor: Optional[str]

An identifier that determines which page of results you receive.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ListWatchlistScreeningIndividualReviewsRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ListWatchlistScreeningIndividualReviewsRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_screening_id: str

ID of the associated screening.

class plaid2.model.LoanAccountSubtype(value)[source]

Bases: str, Enum

An enumeration.

all = 'all'
auto = 'auto'
business = 'business'
commercial = 'commercial'
construction = 'construction'
consumer = 'consumer'
home_equity = 'home equity'
line_of_credit = 'line of credit'
loan = 'loan'
mortgage = 'mortgage'
other = 'other'
student = 'student'
class plaid2.model.Location(*, lat: Optional[float] = None, store_number: Optional[str] = None, postal_code: Optional[str] = None, city: Optional[str] = None, region: Optional[str] = None, lon: Optional[float] = None, country: Optional[str] = None, address: Optional[str] = None)[source]

Bases: BaseModel

address: Optional[str]

The street address where the transaction occurred.

city: Optional[str]

The city where the transaction occurred.

country: Optional[str]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

lat: Optional[float]

The latitude where the transaction occurred.

lon: Optional[float]

The longitude where the transaction occurred.

classmethod parse_obj(data: Any) → Location[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Location[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

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

region: Optional[str]

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

store_number: Optional[str]

The merchant defined store number where the transaction occurred.

class plaid2.model.MatchSummaryCode(value)[source]

Bases: str, Enum

An enumeration.

match = 'match'
no_data = 'no_data'
no_input = 'no_input'
no_match = 'no_match'
partial_match = 'partial_match'
class plaid2.model.Meta(*, official_name: str, name: str, limit: float)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

limit: float

The account’s limit

name_: str

The account’s name

official_name: str

The account’s official name

classmethod parse_obj(data: Any) → Meta[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Meta[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.Mfa(*, question_rounds: float, questions_per_round: float, selection_rounds: float, selections_per_question: float, type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Mfa[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Mfa[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

question_rounds: float

Number of rounds of questions. Required if value of type is questions.

questions_per_round: float

Number of questions per round. Required if value of type is questions. If value of type is selections, default value is 2.

selection_rounds: float

Number of rounds of selections, used if type is selections. Defaults to 1.

selections_per_question: float

Number of available answers per question, used if type is selection. Defaults to 2.

type: str

Possible values are device, selections, or questions.

If value is device, the MFA answer is 1234.

If value is selections, the MFA answer is always the first option.

If value is questions, the MFA answer is answer_<i>_<j> for the j-th question in the i-th round, starting from 0. For example, the answer to the first question in the second round is answer_1_0.

class plaid2.model.MortgageInterestRate(*, type: Optional[str] = None, percentage: Optional[float] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → MortgageInterestRate[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → MortgageInterestRate[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

percentage: Optional[float]

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

type: Optional[str]

The type of interest charged (fixed or variable).

class plaid2.model.MortgageLiability(*, property_address: MortgagePropertyAddress, escrow_balance: Optional[float] = None, has_pmi: Optional[bool] = None, last_payment_amount: Optional[float] = None, loan_term: Optional[str] = None, account_number: str, next_monthly_payment: Optional[float] = None, current_late_fee: Optional[float] = None, next_payment_due_date: Optional[str] = None, last_payment_date: Optional[str] = None, account_id: str, ytd_principal_paid: Optional[float] = None, maturity_date: Optional[str] = None, loan_type_description: Optional[str] = None, has_prepayment_penalty: Optional[bool] = None, origination_date: Optional[str] = None, origination_principal_amount: Optional[float] = None, past_due_amount: Optional[float] = None, interest_rate: MortgageInterestRate, ytd_interest_paid: Optional[float] = None)[source]

Bases: BaseModel

account_id: str

The ID of the account that this liability belongs to.

account_number: str

The account number of the loan.

current_late_fee: Optional[float]

The current outstanding amount charged for late payment.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

escrow_balance: Optional[float]

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

has_pmi: Optional[bool]

Indicates whether the borrower has private mortgage insurance in effect.

has_prepayment_penalty: Optional[bool]

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

interest_rate: MortgageInterestRate

Object containing metadata about the interest rate for the mortgage.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: Optional[float]

The amount of the last payment.

last_payment_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date of the last payment. Dates are returned in an [ISO 8601](https

loan_term: Optional[str]

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

loan_type_description: Optional[str]

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.

maturity_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

Original date on which mortgage is due in full. Dates are returned in an [ISO 8601](https

next_monthly_payment: Optional[float]

The amount of the next payment.

next_payment_due_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The due date for the next payment. Dates are returned in an [ISO 8601](https

origination_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https

origination_principal_amount: Optional[float]

The original principal balance of the mortgage.

classmethod parse_obj(data: Any) → MortgageLiability[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → MortgageLiability[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

past_due_amount: Optional[float]

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

property_address: MortgagePropertyAddress

Object containing fields describing property address.

ytd_interest_paid: Optional[float]

The year to date (YTD) interest paid.

ytd_principal_paid: Optional[float]

The YTD principal paid.

class plaid2.model.MortgagePropertyAddress(*, country: Optional[str] = None, street: Optional[str] = None, postal_code: Optional[str] = None, region: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The city name.

country: Optional[str]

The ISO 3166-1 alpha-2 country code.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → MortgagePropertyAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → MortgagePropertyAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The five or nine digit postal code.

region: Optional[str]

The region or state (example “NC”).

street: Optional[str]

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

class plaid2.model.MultiDocumentRiskSignal(*, risk_signals: List[DocumentRiskSignal], document_references: List[RiskSignalDocumentReference])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_references: List[RiskSignalDocumentReference]

Array of objects containing attributes that could indicate if a document is fraudulent

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → MultiDocumentRiskSignal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → MultiDocumentRiskSignal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

risk_signals: List[DocumentRiskSignal]

Array of attributes that indicate whether or not there is fraud risk with a set of documents

class plaid2.model.NetPay(*, description: Optional[str] = None, iso_currency_code: Optional[str] = None, current_amount: Optional[float] = None, unofficial_currency_code: Optional[str] = None, ytd_amount: Optional[float] = None, total: Optional[Total] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the net pay for the pay period

description: Optional[str]

Description of the net pay

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NetPay[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NetPay[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

total: Optional[Total]

An object representing both the current pay period and year to date amount for a category.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the net pay

class plaid2.model.NewAccountsAvailableWebhook(*, webhook_type: Optional[str] = None, webhook_code: Optional[str] = None, item_id: Optional[str] = None, error: Optional[Error] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: Optional[str]

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NewAccountsAvailableWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NewAccountsAvailableWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: Optional[str]

NEW_ACCOUNTS_AVAILABLE

webhook_type: Optional[str]

ITEM

class plaid2.model.Numbers(*, eft_institution: Optional[str] = None, account: Optional[str] = None, international_iban: Optional[str] = None, ach_wire_routing: Optional[str] = None, bacs_sort_code: Optional[str] = None, international_bic: Optional[str] = None, ach_routing: Optional[str] = None, eft_branch: Optional[str] = None)[source]

Bases: BaseModel

account: Optional[str]

Will be used for the account number.

ach_routing: Optional[str]

Must be a valid ACH routing number.

ach_wire_routing: Optional[str]

Must be a valid wire transfer routing number.

bacs_sort_code: Optional[str]

BACS sort code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

eft_branch: Optional[str]

EFT branch number. Must be specified alongside eft_institution.

eft_institution: Optional[str]

EFT institution number. Must be specified alongside eft_branch.

international_bic: Optional[str]

Bank identifier code (BIC). Must be specified alongside international_iban.

international_iban: Optional[str]

International bank account number (IBAN). If no account number is specified via account, will also be used as the account number by default. Must be specified alongside international_bic.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Numbers[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Numbers[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.NumbersAch(*, account: str, account_id: str, routing: str, wire_routing: Optional[str] = None)[source]

Bases: BaseModel

account: str

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 numbers 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 continue to work for ACH deposits, but not withdrawals.

account_id: str

The Plaid account ID associated with the account numbers

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NumbersAch[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NumbersAch[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

routing: str

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: Optional[str]

The wire transfer routing number for the account, if available

class plaid2.model.NumbersBacs(*, sort_code: str, account_id: str, account: str)[source]

Bases: BaseModel

account: str

The BACS account number for the account

account_id: str

The Plaid account ID associated with the account numbers

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NumbersBacs[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NumbersBacs[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sort_code: str

The BACS sort code for the account

class plaid2.model.NumbersEft(*, account: str, institution: str, branch: str, account_id: str)[source]

Bases: BaseModel

account: str

The EFT account number for the account

account_id: str

The Plaid account ID associated with the account numbers

branch: str

The EFT branch number for the account

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution: str

The EFT institution number for the account

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NumbersEft[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NumbersEft[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.NumbersInternational(*, iban: str, account_id: str, bic: str)[source]

Bases: BaseModel

account_id: str

The Plaid account ID associated with the account numbers

bic: str

The Bank Identifier Code (BIC) for the account

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: str

The International Bank Account Number (IBAN) for the account

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NumbersInternational[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NumbersInternational[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.NumbersInternationalIban(*, iban: str, bic: str)[source]

Bases: BaseModel

bic: str

The Business Identifier Code, also known as SWIFT code, for this bank account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: str

International Bank Account Number (IBAN).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → NumbersInternationalIban[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → NumbersInternationalIban[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.OverrideAccountType(value)[source]

Bases: str, Enum

An enumeration.

credit = 'credit'
depository = 'depository'
investment = 'investment'
loan = 'loan'
other = 'other'
payroll = 'payroll'
class plaid2.model.OverrideAccounts(*, currency: str, liability: LiabilityOverride, subtype: Optional[str] = None, transactions: List[TransactionOverride], starting_balance: float, investment_transactions: Optional[InvestmentsTransactionsOverride] = None, identity: OwnerOverride, inflow_model: InflowModel, numbers: Numbers, income: Optional[List[PaystubOverride]] = None, meta: Meta, type: str, force_available_balance: float, holdings: Optional[HoldingsOverride] = None)[source]

Bases: BaseModel

currency: str

ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

force_available_balance: float

If provided, the account will always have this amount as its available balance, regardless of current balance or changes in transactions over time.

holdings: Optional[HoldingsOverride]

Specify the holdings on the account.

identity: OwnerOverride

Data about the owner or owners of an account. Any fields not specified will be filled in with default Sandbox information.

income: Optional[List[PaystubOverride]]

Specify payroll data on the account.

inflow_model: InflowModel

The inflow_model allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the inflow_model will appear in addition to randomly generated test data or transactions specified by override_accounts.

investment_transactions: Optional[InvestmentsTransactionsOverride]

Specify the list of investments transactions on the account.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

liability: LiabilityOverride

Used to configure Sandbox test data for the Liabilities product

meta: Meta

Allows specifying the metadata of the test account

numbers: Numbers

Account and bank identifier number data used to configure the test account. All values are optional.

classmethod parse_obj(data: Any) → OverrideAccounts[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → OverrideAccounts[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

starting_balance: float

If provided, the account will start with this amount as the current balance.

subtype: Optional[str]

//plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.

Type

See the [Account type schema](https

transactions: List[TransactionOverride]

Specify the list of transactions on the account.

type: str

` Investment account.

credit: Credit card

depository: Depository account

loan: Loan account

payroll: Payroll account

other: Non-specified account type

See the [Account type schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.

Type

`investment

class plaid2.model.Owner(*, addresses: List[Address], phone_numbers: List[PhoneNumber], names: List[str], emails: List[Email])[source]

Bases: BaseModel

addresses: List[Address]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

emails: List[Email]

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.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

names: List[str]

A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support. 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.

classmethod parse_obj(data: Any) → Owner[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Owner[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_numbers: List[PhoneNumber]

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.

class plaid2.model.OwnerOverride(*, addresses: List[Address], emails: List[Email], phone_numbers: List[PhoneNumber], names: List[str])[source]

Bases: BaseModel

addresses: List[Address]

Data about the various addresses associated with the account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

emails: List[Email]

A list of email addresses associated with the account.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

names: List[str]

A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. Note that the same name data will be used for all accounts associated with an Item.

classmethod parse_obj(data: Any) → OwnerOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → OwnerOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_numbers: List[PhoneNumber]

A list of phone numbers associated with the account.

class plaid2.model.PaginatedDashboardUserListResponse(*, request_id: str, next_cursor: Optional[str] = None, dashboard_users: List[DashboardUser])[source]

Bases: BaseModel

dashboard_users: List[DashboardUser]

List of dashboard users

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedDashboardUserListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedDashboardUserListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedEntityWatchlistProgramListResponse(*, entity_watchlist_programs: List[EntityWatchlistProgram], request_id: str, next_cursor: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_programs: List[EntityWatchlistProgram]

List of entity watchlist screening programs

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedEntityWatchlistProgramListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedEntityWatchlistProgramListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedEntityWatchlistScreeningHitListResponse(*, next_cursor: Optional[str] = None, entity_watchlist_screening_hits: List[EntityWatchlistScreeningHit], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_hits: List[EntityWatchlistScreeningHit]

List of entity watchlist screening hits

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedEntityWatchlistScreeningHitListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedEntityWatchlistScreeningHitListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedEntityWatchlistScreeningListResponse(*, request_id: str, entity_watchlist_screenings: List[EntityWatchlistScreening], next_cursor: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screenings: List[EntityWatchlistScreening]

List of entity watchlist screening

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedEntityWatchlistScreeningListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedEntityWatchlistScreeningListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedEntityWatchlistScreeningReviewListResponse(*, next_cursor: Optional[str] = None, request_id: str, entity_watchlist_screening_reviews: List[EntityWatchlistScreeningReview])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_reviews: List[EntityWatchlistScreeningReview]

List of entity watchlist screening reviews

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedEntityWatchlistScreeningReviewListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedEntityWatchlistScreeningReviewListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedIdentityVerificationListResponse(*, next_cursor: Optional[str] = None, request_id: str, identity_verifications: List[IdentityVerification])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

identity_verifications: List[IdentityVerification]

List of Plaid sessions

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedIdentityVerificationListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedIdentityVerificationListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaginatedIndividualWatchlistProgramListResponse(*, next_cursor: Optional[str] = None, request_id: str, watchlist_programs: List[IndividualWatchlistProgram])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedIndividualWatchlistProgramListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedIndividualWatchlistProgramListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

watchlist_programs: List[IndividualWatchlistProgram]

List of individual watchlist screening programs

class plaid2.model.PaginatedIndividualWatchlistScreeningHitListResponse(*, request_id: str, next_cursor: Optional[str] = None, watchlist_screening_hits: List[WatchlistScreeningHit])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedIndividualWatchlistScreeningHitListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedIndividualWatchlistScreeningHitListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

watchlist_screening_hits: List[WatchlistScreeningHit]

List of individual watchlist screening hits

class plaid2.model.PaginatedIndividualWatchlistScreeningListResponse(*, request_id: str, next_cursor: Optional[str] = None, watchlist_screenings: List[WatchlistScreeningIndividual])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedIndividualWatchlistScreeningListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedIndividualWatchlistScreeningListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

watchlist_screenings: List[WatchlistScreeningIndividual]

List of individual watchlist screenings

class plaid2.model.PaginatedIndividualWatchlistScreeningReviewListResponse(*, watchlist_screening_reviews: List[WatchlistScreeningReview], request_id: str, next_cursor: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

An identifier that determines which page of results you receive.

classmethod parse_obj(data: Any) → PaginatedIndividualWatchlistScreeningReviewListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaginatedIndividualWatchlistScreeningReviewListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

watchlist_screening_reviews: List[WatchlistScreeningReview]

List of screening reviews

class plaid2.model.PartnerCustomersCreateRequest(*, create_link_customization: Optional[bool] = None, is_diligence_attested: bool, company_name: str, products: List[str])[source]

Bases: BaseModel

company_name: str

The company name of the end customer being created.

If true, sets end customer’s link customization to match partner’s link customization.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

is_diligence_attested: bool

Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PartnerCustomersCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PartnerCustomersCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

products: List[str]

The products to be enabled on for the end customer.

class plaid2.model.PartnerCustomersCreateResponse(*, request_id: Optional[str] = None, end_customer: Optional[str] = None, production_secret: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_customer: Optional[str]

The end customer details for the newly-created customer client.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PartnerCustomersCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PartnerCustomersCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

production_secret: Optional[str]
request_id: Optional[str]

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

class plaid2.model.Pay(*, amount: Optional[float] = None, currency: Optional[str] = None)[source]

Bases: BaseModel

amount: Optional[float]

A numerical amount of a specific currency.

currency: Optional[str]

Currency code, e.g. USD

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Pay[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Pay[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PayFrequency(*, value: str, verification_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayFrequency[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayFrequency[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

value: str

The frequency of the pay period.

verification_status: str

The verification status. One of the following:

“VERIFIED”: The information was successfully verified.

“UNVERIFIED”: The verification has not yet been performed.

“NEEDS_INFO”: The verification was attempted but could not be completed due to missing information.

“UNABLE_TO_VERIFY”: The verification was performed and the information could not be verified.

“UNKNOWN”: The verification status is unknown.

class plaid2.model.PayFrequencyValue(value)[source]

Bases: str, Enum

An enumeration.

biweekly = 'biweekly'
monthly = 'monthly'
semimonthly = 'semimonthly'
unknown = 'unknown'
weekly = 'weekly'
class plaid2.model.PayPeriodDetails(*, start_date: Optional[str] = None, distribution_breakdown: Optional[List[DistributionBreakdown]] = None, end_date: Optional[str] = None, gross_earnings: Optional[float] = None, pay_date: Optional[str] = None, pay_frequency: Optional[str] = None, pay_day: Optional[str] = None, check_amount: Optional[float] = None)[source]

Bases: BaseModel

check_amount: Optional[float]

The amount of the paycheck.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

distribution_breakdown: Optional[List[DistributionBreakdown]]
end_date: Optional[str]

“yyyy-mm-dd”.

Type

The pay period end date, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format

gross_earnings: Optional[float]

Total earnings before tax/deductions.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayPeriodDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayPeriodDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date on which the paystub was issued, in [ISO 8601](https

pay_day: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date on which the paystub was issued, in [ISO 8601](https

pay_frequency: Optional[str]

The frequency at which an individual is paid.

start_date: Optional[str]

“yyyy-mm-dd”.

Type

The pay period start date, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format

class plaid2.model.PayStubDeductionsBreakdown(*, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, description: Optional[str] = None, current_amount: Optional[float] = None, ytd_amount: Optional[float] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the deduction

description: Optional[str]

Description of the deduction line item

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubDeductionsBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubDeductionsBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the deduction

class plaid2.model.PayStubDeductionsTotal(*, current_amount: Optional[float] = None, unofficial_currency_code: Optional[str] = None, iso_currency_code: Optional[str] = None, ytd_amount: Optional[float] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Raw amount of the deduction

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubDeductionsTotal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubDeductionsTotal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date total amount of the deductions

class plaid2.model.PayStubDistributionBreakdown(*, mask: Optional[str] = None, type: Optional[str] = None, unofficial_currency_code: Optional[str] = None, iso_currency_code: Optional[str] = None, bank_name: Optional[str] = None, current_amount: Optional[float] = None, account_name: Optional[str] = None)[source]

Bases: BaseModel

account_name: Optional[str]

Name of the account for the given distribution.

bank_name: Optional[str]

The name of the bank that the payment is being deposited to.

current_amount: Optional[float]

The amount distributed to this account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mask: Optional[str]

The last 2-4 alphanumeric characters of an account’s official account number.

classmethod parse_obj(data: Any) → PayStubDistributionBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubDistributionBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: Optional[str]

Type of the account that the paystub was sent to (e.g. ‘checking’).

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.PayStubEarningsBreakdown(*, hours: Optional[float] = None, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, canonical_description: Optional[str] = None, current_amount: Optional[float] = None, description: Optional[str] = None, rate: Optional[float] = None, ytd_amount: Optional[float] = None)[source]

Bases: BaseModel

canonical_description: Optional[str]

Commonly used term to describe the earning line item.

current_amount: Optional[float]

Raw amount of the earning line item.

description: Optional[str]

Description of the earning line item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hours: Optional[float]

Number of hours applicable for this earning.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubEarningsBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubEarningsBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

rate: Optional[float]

Hourly rate applicable for this earning.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the line item. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The year-to-date amount of the deduction.

class plaid2.model.PayStubEarningsTotal(*, current_amount: Optional[float] = None, ytd_amount: Optional[float] = None, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, hours: Optional[float] = None)[source]

Bases: BaseModel

current_amount: Optional[float]

Total amount of the earnings for this pay period.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

hours: Optional[float]

Total number of hours worked for this pay period.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubEarningsTotal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubEarningsTotal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the security. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

ytd_amount: Optional[float]

The total year-to-date amount of the earnings.

class plaid2.model.PayStubPayPeriodDetails(*, iso_currency_code: Optional[str] = None, distribution_breakdown: List[PayStubDistributionBreakdown], pay_date: Optional[str] = None, end_date: Optional[str] = None, pay_amount: Optional[float] = None, gross_earnings: Optional[float] = None, unofficial_currency_code: Optional[str] = None, pay_frequency: Optional[str] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

distribution_breakdown: List[PayStubDistributionBreakdown]
end_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date on which the pay period ended, in [ISO 8601](https

gross_earnings: Optional[float]

Total earnings before tax/deductions.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubPayPeriodDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubPayPeriodDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_amount: Optional[float]

The amount of the paycheck.

pay_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date on which the pay stub was issued, in [ISO 8601](https

pay_frequency: Optional[str]

The frequency at which an individual is paid.

start_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date on which the pay period started, in [ISO 8601](https

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.PayStubTaxpayerId(*, id_type: Optional[str] = None, id_mask: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id_mask: Optional[str]

ID mask; i.e. last 4 digits of the taxpayer ID.

id_type: Optional[str]

Type of ID, e.g. ‘SSN’.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubTaxpayerId[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayStubTaxpayerId[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentAmount(*, currency: str, value: float)[source]

Bases: BaseModel

currency: str

The ISO-4217 currency code of the payment. For standing orders and payment consents, “GBP” must be used.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentAmount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentAmount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

value: float

The amount of the payment. Must contain at most two digits of precision e.g. 1.23. Minimum accepted value is 1.

class plaid2.model.PaymentAmountCurrency(value)[source]

Bases: str, Enum

An enumeration.

eur = 'EUR'
gbp = 'GBP'
class plaid2.model.PaymentChannel(value)[source]

Bases: str, Enum

An enumeration.

in_store = 'in store'
online = 'online'
other = 'other'
class plaid2.model.PaymentConsentPeriodicAlignment(value)[source]

Bases: str, Enum

An enumeration.

calendar = 'CALENDAR'
consent = 'CONSENT'
class plaid2.model.PaymentConsentPeriodicAmount(*, amount: PaymentAmount, interval: str, alignment: str)[source]

Bases: BaseModel

alignment: str

Where the payment consent period should start.

CALENDAR: line up with a calendar.

CONSENT: on the date of consent creation.

amount: PaymentAmount

Maximum cumulative amount for all payments in the specified interval.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

interval: str

Payment consent periodic interval.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentConsentPeriodicAmount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentConsentPeriodicAmount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentConsentPeriodicInterval(value)[source]

Bases: str, Enum

An enumeration.

day = 'DAY'
month = 'MONTH'
week = 'WEEK'
year = 'YEAR'
class plaid2.model.PaymentConsentValidDateTime(*, to: Optional[str] = None, from_: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

from_: Optional[str]

//wikipedia.org/wiki/ISO_8601) format.

Type

The date and time from which the consent should be active, in [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentConsentValidDateTime[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentConsentValidDateTime[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

to: Optional[str]

//wikipedia.org/wiki/ISO_8601) format.

Type

The date and time at which the consent expires, in [ISO 8601](https

class plaid2.model.PaymentInitiationAddress(*, city: str, country: str, postal_code: str, street: List[str])[source]

Bases: BaseModel

city: str

The city where the recipient is located. Maximum of 35 characters.

country: str

The ISO 3166-1 alpha-2 country code where the recipient is located.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: str

The postal code where the recipient is located. Maximum of 16 characters.

street: List[str]

An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.

class plaid2.model.PaymentInitiationConsent(*, created_at: str, recipient_id: str, consent_id: str, status: str, reference: str, constraints: PaymentInitiationConsentConstraints, scopes: List[str])[source]

Bases: BaseModel

consent_id: str

The consent ID.

constraints: PaymentInitiationConsentConstraints

Limitations that will be applied to payments initiated using the payment consent.

created_at: str

//wikipedia.org/wiki/ISO_8601) format.

Type

Consent creation timestamp, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsent[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsent[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipient_id: str

The ID of the recipient the payment consent is for.

reference: str

A reference for the payment consent.

scopes: List[str]

An array of payment consent scopes.

status: str

The status of the payment consent.

UNAUTHORISED: Consent created, but requires user authorisation.

REJECTED: Consent authorisation was rejected by the user and/or the bank.

AUTHORISED: Consent is active and ready to be used.

REVOKED: Consent has been revoked and can no longer be used.

EXPIRED: Consent is no longer valid.

class plaid2.model.PaymentInitiationConsentConstraints(*, max_payment_amount: PaymentAmount, valid_date_time: Optional[PaymentConsentValidDateTime] = None, periodic_amounts: List[PaymentConsentPeriodicAmount])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

max_payment_amount: PaymentAmount

Maximum amount of a single payment initiated using the payment consent.

classmethod parse_obj(data: Any) → PaymentInitiationConsentConstraints[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentConstraints[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

periodic_amounts: List[PaymentConsentPeriodicAmount]

A list of amount limitations per period of time.

valid_date_time: Optional[PaymentConsentValidDateTime]

Life span for the payment consent. After the to date the payment consent expires and can no longer be used for payment initiation.

class plaid2.model.PaymentInitiationConsentCreateRequest(*, constraints: PaymentInitiationConsentConstraints, recipient_id: str, reference: str, scopes: List[str], options: Optional[ExternalPaymentInitiationConsentOptions] = None)[source]

Bases: BaseModel

constraints: PaymentInitiationConsentConstraints

Limitations that will be applied to payments initiated using the payment consent.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[ExternalPaymentInitiationConsentOptions]

Additional payment consent options

classmethod parse_obj(data: Any) → PaymentInitiationConsentCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipient_id: str

The ID of the recipient the payment consent is for. The created consent can be used to transfer funds to this recipient only.

reference: str

A reference for the payment consent. This must be an alphanumeric string with at most 18 characters and must not contain any special characters.

scopes: List[str]

An array of payment consent scopes.

class plaid2.model.PaymentInitiationConsentCreateResponse(*, status: str, request_id: str, consent_id: str)[source]

Bases: BaseModel

consent_id: str

A unique ID identifying the payment consent.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsentCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

status: str

The status of the payment consent.

UNAUTHORISED: Consent created, but requires user authorisation.

REJECTED: Consent authorisation was rejected by the user and/or the bank.

AUTHORISED: Consent is active and ready to be used.

REVOKED: Consent has been revoked and can no longer be used.

EXPIRED: Consent is no longer valid.

class plaid2.model.PaymentInitiationConsentGetResponse[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsentGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationConsentPaymentExecuteRequest(*, idempotency_key: str, consent_id: str, amount: PaymentAmount)[source]

Bases: BaseModel

amount: PaymentAmount

The amount and currency of a payment

consent_id: str

The consent ID.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique consent payment. Maximum of 128 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a consent payment fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single payment is created. If the request was successfully processed, it will prevent any payment that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsentPaymentExecuteRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentPaymentExecuteRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationConsentPaymentExecuteResponse(*, request_id: str, payment_id: str, status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsentPaymentExecuteResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentPaymentExecuteResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

A unique ID identifying the payment

request_id: str

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

status: str

The status of the payment.

PAYMENT_STATUS_INPUT_NEEDED: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

PAYMENT_STATUS_INITIATED: The payment has been successfully authorised and accepted by the financial institution but has not been executed.

PAYMENT_STATUS_INSUFFICIENT_FUNDS: The payment has failed due to insufficient funds.

PAYMENT_STATUS_FAILED: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

PAYMENT_STATUS_BLOCKED: The payment has been blocked. This is a retryable error.

PAYMENT_STATUS_AUTHORISING: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.

PAYMENT_STATUS_CANCELLED: The payment was cancelled during authorisation.

PAYMENT_STATUS_EXECUTED: The payment has been successfully initiated and is considered complete.

PAYMENT_STATUS_ESTABLISHED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

PAYMENT_STATUS_REJECTED: The payment was rejected by the financial institution.

Deprecated: These statuses will be removed in a future release.

PAYMENT_STATUS_UNKNOWN: The payment status is unknown.

PAYMENT_STATUS_PROCESSING: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

PAYMENT_STATUS_COMPLETED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

class plaid2.model.PaymentInitiationConsentRevokeResponse(*, request_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationConsentRevokeResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationConsentRevokeResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: Optional[str]

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

class plaid2.model.PaymentInitiationConsentScope(value)[source]

Bases: str, Enum

An enumeration.

external = 'EXTERNAL'
me_to_me = 'ME_TO_ME'
class plaid2.model.PaymentInitiationConsentStatus(value)[source]

Bases: str, Enum

An enumeration.

authorised = 'AUTHORISED'
expired = 'EXPIRED'
rejected = 'REJECTED'
revoked = 'REVOKED'
unauthorised = 'UNAUTHORISED'
class plaid2.model.PaymentInitiationMaximumPaymentAmount[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationMaximumPaymentAmount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationMaximumPaymentAmount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationMetadata(*, maximum_payment_amount: PaymentInitiationMaximumPaymentAmount, supports_refund_details: bool, supports_international_payments: bool, supports_sepa_instant: bool, standing_order_metadata: Optional[PaymentInitiationStandingOrderMetadata] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

maximum_payment_amount: PaymentInitiationMaximumPaymentAmount

A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution.

Example: {“GBP”: “10000”}

classmethod parse_obj(data: Any) → PaymentInitiationMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

standing_order_metadata: Optional[PaymentInitiationStandingOrderMetadata]

Metadata specifically related to valid Payment Initiation standing order configurations for the institution.

supports_international_payments: bool

Indicates whether the institution supports payments from a different country.

supports_refund_details: bool

Indicates whether the institution supports returning refund details when initiating a payment.

supports_sepa_instant: bool

Indicates whether the institution supports SEPA Instant payments.

class plaid2.model.PaymentInitiationPayment(*, iban: Optional[str] = None, status: str, bacs: Optional[RecipientBacs] = None, adjusted_scheme: Optional[str] = None, last_status_update: str, schedule: Optional[ExternalPaymentScheduleBase] = None, recipient_id: str, payment_id: str, consent_id: Optional[str] = None, adjusted_reference: Optional[str] = None, amount: PaymentAmount, refund_ids: Optional[List[str]] = None, refund_details: Optional[ExternalPaymentRefundDetails] = None, wallet_id: Optional[str] = None, scheme: Optional[str] = None, reference: str)[source]

Bases: BaseModel

adjusted_reference: Optional[str]

The value of the reference sent to the bank after adjustment to pass bank validation rules.

adjusted_scheme: Optional[str]

Payment scheme. If not specified - the default in the region will be used (e.g. SEPA_CREDIT_TRANSFER for EU). Using unsupported values will result in a failed payment.

FASTER_PAYMENTS: Enables payments to move quickly between UK bank accounts. Default value in the UK.

SEPA_CREDIT_TRANSFER: The standard payment to a beneficiary within the SEPA area.

SEPA_CREDIT_TRANSFER_INSTANT: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.

amount: PaymentAmount

The amount and currency of a payment

bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.

consent_id: Optional[str]

The payment consent ID that this payment was initiated with. Is present only when payment was initiated using the payment consent.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the sender, if specified in the /payment_initiation/payment/create call.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_status_update: str

The date and time of the last time the status was updated, in IS0 8601 format

classmethod parse_obj(data: Any) → PaymentInitiationPayment[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPayment[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

The ID of the payment. Like all Plaid identifiers, the payment_id is case sensitive.

recipient_id: str

The ID of the recipient

reference: str

A reference for the payment.

refund_details: Optional[ExternalPaymentRefundDetails]

Details about external payment refund

refund_ids: Optional[List[str]]

Refund IDs associated with the payment.

schedule: Optional[ExternalPaymentScheduleBase]

The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.

scheme: Optional[str]

Payment scheme. If not specified - the default in the region will be used (e.g. SEPA_CREDIT_TRANSFER for EU). Using unsupported values will result in a failed payment.

FASTER_PAYMENTS: Enables payments to move quickly between UK bank accounts. Default value in the UK.

SEPA_CREDIT_TRANSFER: The standard payment to a beneficiary within the SEPA area.

SEPA_CREDIT_TRANSFER_INSTANT: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.

status: str

The status of the payment.

PAYMENT_STATUS_INPUT_NEEDED: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

PAYMENT_STATUS_INITIATED: The payment has been successfully authorised and accepted by the financial institution but has not been executed.

PAYMENT_STATUS_INSUFFICIENT_FUNDS: The payment has failed due to insufficient funds.

PAYMENT_STATUS_FAILED: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

PAYMENT_STATUS_BLOCKED: The payment has been blocked. This is a retryable error.

PAYMENT_STATUS_AUTHORISING: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.

PAYMENT_STATUS_CANCELLED: The payment was cancelled during authorisation.

PAYMENT_STATUS_EXECUTED: The payment has been successfully initiated and is considered complete.

PAYMENT_STATUS_ESTABLISHED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

PAYMENT_STATUS_REJECTED: The payment was rejected by the financial institution.

Deprecated: These statuses will be removed in a future release.

PAYMENT_STATUS_UNKNOWN: The payment status is unknown.

PAYMENT_STATUS_PROCESSING: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

PAYMENT_STATUS_COMPLETED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

wallet_id: Optional[str]

The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.

class plaid2.model.PaymentInitiationPaymentCreateRequest(*, amount: PaymentAmount, recipient_id: str, reference: str, schedule: Optional[ExternalPaymentScheduleBase] = None, options: Optional[ExternalPaymentOptions] = None)[source]

Bases: BaseModel

amount: PaymentAmount

The amount and currency of a payment

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[ExternalPaymentOptions]

Additional payment options

classmethod parse_obj(data: Any) → PaymentInitiationPaymentCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipient_id: str

The ID of the recipient the payment is for.

reference: str

A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them).

schedule: Optional[ExternalPaymentScheduleBase]

The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.

class plaid2.model.PaymentInitiationPaymentCreateResponse(*, request_id: str, payment_id: str, status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

A unique ID identifying the payment

request_id: str

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

status: str

For a payment returned by this endpoint, there is only one possible value:

PAYMENT_STATUS_INPUT_NEEDED: The initial phase of the payment

class plaid2.model.PaymentInitiationPaymentCreateStatus(value)[source]

Bases: str, Enum

An enumeration.

payment_status_input_needed = 'PAYMENT_STATUS_INPUT_NEEDED'
class plaid2.model.PaymentInitiationPaymentGetResponse(*, payment_initiation_payment: PaymentInitiationPayment)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation_payment: PaymentInitiationPayment

PaymentInitiationPayment defines a payment initiation payment

class plaid2.model.PaymentInitiationPaymentListRequest(*, cursor: Optional[str] = None, count: Optional[int] = None, consent_id: Optional[str] = None)[source]

Bases: BaseModel

consent_id: Optional[str]

The consent ID. If specified, only payments, executed using this consent, will be returned.

count: Optional[int]

The maximum number of payments to return. If count is not specified, a maximum of 10 payments will be returned, beginning with the most recent payment before the cursor (if specified).

cursor: Optional[str]

49Z”). Only payments created before the cursor will be returned.

Type

A string in RFC 3339 format (i.e. “2019-12-06T22

Type

35

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationPaymentListResponse(*, request_id: str, next_cursor: Optional[str] = None, payments: List[PaymentInitiationPayment])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

The value that, when used as the optional cursor parameter to /payment_initiation/payment/list, will return the next unreturned payment as its first payment.

classmethod parse_obj(data: Any) → PaymentInitiationPaymentListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payments: List[PaymentInitiationPayment]

An array of payments that have been created, associated with the given client_id.

request_id: str

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

class plaid2.model.PaymentInitiationPaymentReverseRequest(*, reference: str, payment_id: str, idempotency_key: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique wallet transaction. Maximum of 128 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentReverseRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentReverseRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

The ID of the payment to reverse

reference: str

A reference for the refund. This must be an alphanumeric string with at most 18 characters and must not contain any special characters or spaces.

class plaid2.model.PaymentInitiationPaymentReverseResponse(*, request_id: str, refund_id: str, status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentReverseResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentReverseResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

refund_id: str

A unique ID identifying the refund

request_id: str

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

status: str

The status of the refund.

PROCESSING: The refund is currently being processed. The refund will automatically exit this state when processing is complete.

INITIATED: The refund has been successfully initiated.

EXECUTED: Indicates that the refund has been successfully executed.

FAILED: The refund has failed to be executed. This error is retryable once the root cause is resolved.

class plaid2.model.PaymentInitiationPaymentStatus(value)[source]

Bases: str, Enum

An enumeration.

payment_status_authorising = 'PAYMENT_STATUS_AUTHORISING'
payment_status_blocked = 'PAYMENT_STATUS_BLOCKED'
payment_status_cancelled = 'PAYMENT_STATUS_CANCELLED'
payment_status_completed = 'PAYMENT_STATUS_COMPLETED'
payment_status_established = 'PAYMENT_STATUS_ESTABLISHED'
payment_status_executed = 'PAYMENT_STATUS_EXECUTED'
payment_status_failed = 'PAYMENT_STATUS_FAILED'
payment_status_initiated = 'PAYMENT_STATUS_INITIATED'
payment_status_input_needed = 'PAYMENT_STATUS_INPUT_NEEDED'
payment_status_insufficient_funds = 'PAYMENT_STATUS_INSUFFICIENT_FUNDS'
payment_status_processing = 'PAYMENT_STATUS_PROCESSING'
payment_status_rejected = 'PAYMENT_STATUS_REJECTED'
payment_status_unknown = 'PAYMENT_STATUS_UNKNOWN'
class plaid2.model.PaymentInitiationPaymentTokenCreateResponse(*, payment_token_expiration_time: str, payment_token: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationPaymentTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationPaymentTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_token: str

A payment_token that can be provided to Link initialization to enter the payment initiation flow

payment_token_expiration_time: str

//wikipedia.org/wiki/ISO_8601) format. A payment_token expires after 15 minutes.

Type

The date and time at which the token will expire, in [ISO 8601](https

request_id: str

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

class plaid2.model.PaymentInitiationRecipient(*, bacs: Optional[RecipientBacs] = None, address: Optional[PaymentInitiationAddress] = None, name: str, iban: Optional[str] = None, recipient_id: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[PaymentInitiationAddress]

The optional address of the payment recipient.

bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the recipient.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the recipient.

classmethod parse_obj(data: Any) → PaymentInitiationRecipient[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipient[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipient_id: str

The ID of the recipient.

class plaid2.model.PaymentInitiationRecipientCreateRequest(*, iban: Optional[str] = None, bacs: Optional[RecipientBacs] = None, name: str, address: Optional[PaymentInitiationAddress] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[PaymentInitiationAddress]

The optional address of the payment recipient.

bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]

The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the recipient. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions.

classmethod parse_obj(data: Any) → PaymentInitiationRecipientCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipientCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationRecipientCreateResponse(*, recipient_id: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationRecipientCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipientCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipient_id: str

A unique ID identifying the recipient

request_id: str

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

class plaid2.model.PaymentInitiationRecipientGetResponse(*, payment_initiation_recipient: PaymentInitiationRecipient)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationRecipientGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipientGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation_recipient: PaymentInitiationRecipient

PaymentInitiationRecipient defines a payment initiation recipient

class plaid2.model.PaymentInitiationRecipientListRequest[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationRecipientListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipientListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentInitiationRecipientListResponse(*, recipients: List[PaymentInitiationRecipient], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationRecipientListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipientListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recipients: List[PaymentInitiationRecipient]

An array of payment recipients created for Payment Initiation

request_id: str

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

class plaid2.model.PaymentInitiationRefundStatus(value)[source]

Bases: str, Enum

An enumeration.

executed = 'EXECUTED'
failed = 'FAILED'
initiated = 'INITIATED'
processing = 'PROCESSING'
class plaid2.model.PaymentInitiationStandingOrderMetadata(*, supports_standing_order_end_date: bool, supports_standing_order_negative_execution_days: bool, valid_standing_order_intervals: List[str])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentInitiationStandingOrderMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationStandingOrderMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

supports_standing_order_end_date: bool

Indicates whether the institution supports closed-ended standing orders by providing an end date.

supports_standing_order_negative_execution_days: bool

This is only applicable to MONTHLY standing orders. Indicates whether the institution supports negative integers (-1 to -5) for setting up a MONTHLY standing order relative to the end of the month.

valid_standing_order_intervals: List[str]

A list of the valid standing order intervals supported by the institution.

class plaid2.model.PaymentMeta(*, payment_method: Optional[str] = None, reason: Optional[str] = None, payer: Optional[str] = None, by_order_of: Optional[str] = None, payee: Optional[str] = None, ppd_id: Optional[str] = None, payment_processor: Optional[str] = None, reference_number: Optional[str] = None)[source]

Bases: BaseModel

by_order_of: Optional[str]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentMeta[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentMeta[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payee: Optional[str]

For transfers, the party that is receiving the transaction.

payer: Optional[str]

For transfers, the party that is paying the transaction.

payment_method: Optional[str]

The type of transfer, e.g. ‘ACH’

payment_processor: Optional[str]

The name of the payment processor

ppd_id: Optional[str]

The ACH PPD ID for the payer.

reason: Optional[str]

The payer-supplied description of the transfer.

reference_number: Optional[str]

The transaction reference number supplied by the financial institution.

class plaid2.model.PaymentProfileCreateRequest[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentProfileCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentProfileCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaymentProfileCreateResponse(*, request_id: str, payment_profile_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentProfileCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentProfileCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_profile_id: str

Plaid’s unique identifier for a payment profile.

request_id: str

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

class plaid2.model.PaymentProfileGetResponse(*, created_at: str, status: str, updated_at: str, request_id: str)[source]

Bases: BaseModel

created_at: str

mm:ssZ`) indicating the time the given Payment Profile was created at

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentProfileGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentProfileGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

status: str

The status of the given Payment Profile.

READY: This Payment Profile is ready to be used to create transfers using /transfer/authorization/create and /transfer/create`.

PENDING: This Payment Profile is not ready to be used. You’ll need to call /link/token/create and provide the Payment Profile ID in the transfer.payment_profile_id field and go through the account linking flow to activate it.

REMOVED: This Payment Profile has been removed.

updated_at: str

mm:ssZ`) indicating the last time the given Payment Profile was updated at

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH

class plaid2.model.PaymentProfileRemoveResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaymentProfileRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentProfileRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.PaymentProfileStatus(value)[source]

Bases: str, Enum

An enumeration.

pending = 'PENDING'
ready = 'READY'
removed = 'REMOVED'
class plaid2.model.PaymentScheduleInterval(value)[source]

Bases: str, Enum

An enumeration.

monthly = 'MONTHLY'
weekly = 'WEEKLY'
class plaid2.model.PaymentScheme(value)[source]

Bases: str, Enum

An enumeration.

faster_payments = 'FASTER_PAYMENTS'
sepa_credit_transfer = 'SEPA_CREDIT_TRANSFER'
sepa_credit_transfer_instant = 'SEPA_CREDIT_TRANSFER_INSTANT'
class plaid2.model.PaymentStatusUpdateWebhook(*, original_reference: Optional[str] = None, adjusted_reference: Optional[str] = None, original_start_date: Optional[str] = None, adjusted_start_date: Optional[str] = None, webhook_type: str, webhook_code: str, payment_id: str, timestamp: str, error: Optional[Error] = None, new_payment_status: str, old_payment_status: str)[source]

Bases: BaseModel

adjusted_reference: Optional[str]

The value of the reference sent to the bank after adjustment to pass bank validation rules.

adjusted_start_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be null.

Type

The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_payment_status: str

The status of the payment.

PAYMENT_STATUS_INPUT_NEEDED: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

PAYMENT_STATUS_INITIATED: The payment has been successfully authorised and accepted by the financial institution but has not been executed.

PAYMENT_STATUS_INSUFFICIENT_FUNDS: The payment has failed due to insufficient funds.

PAYMENT_STATUS_FAILED: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

PAYMENT_STATUS_BLOCKED: The payment has been blocked. This is a retryable error.

PAYMENT_STATUS_AUTHORISING: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.

PAYMENT_STATUS_CANCELLED: The payment was cancelled during authorisation.

PAYMENT_STATUS_EXECUTED: The payment has been successfully initiated and is considered complete.

PAYMENT_STATUS_ESTABLISHED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

PAYMENT_STATUS_REJECTED: The payment was rejected by the financial institution.

Deprecated: These statuses will be removed in a future release.

PAYMENT_STATUS_UNKNOWN: The payment status is unknown.

PAYMENT_STATUS_PROCESSING: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

PAYMENT_STATUS_COMPLETED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

old_payment_status: str

The status of the payment.

PAYMENT_STATUS_INPUT_NEEDED: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

PAYMENT_STATUS_INITIATED: The payment has been successfully authorised and accepted by the financial institution but has not been executed.

PAYMENT_STATUS_INSUFFICIENT_FUNDS: The payment has failed due to insufficient funds.

PAYMENT_STATUS_FAILED: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

PAYMENT_STATUS_BLOCKED: The payment has been blocked. This is a retryable error.

PAYMENT_STATUS_AUTHORISING: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.

PAYMENT_STATUS_CANCELLED: The payment was cancelled during authorisation.

PAYMENT_STATUS_EXECUTED: The payment has been successfully initiated and is considered complete.

PAYMENT_STATUS_ESTABLISHED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

PAYMENT_STATUS_REJECTED: The payment was rejected by the financial institution.

Deprecated: These statuses will be removed in a future release.

PAYMENT_STATUS_UNKNOWN: The payment status is unknown.

PAYMENT_STATUS_PROCESSING: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

PAYMENT_STATUS_COMPLETED: Indicates that the standing order has been successfully established. This state is only used for standing orders.

original_reference: Optional[str]

The original value of the reference when creating the payment.

original_start_date: Optional[str]

The original value of the start_date provided during the creation of a standing order. If the payment is not a standing order, this field will be null.

classmethod parse_obj(data: Any) → PaymentStatusUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentStatusUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_id: str

The payment_id for the payment being updated

timestamp: str

42:19.350Z”`

Type

The timestamp of the update, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format, e.g. `”2017-09-14T14

webhook_code: str

PAYMENT_STATUS_UPDATE

webhook_type: str

PAYMENT_INITIATION

class plaid2.model.PayrollIncomeAccountData(*, rate_of_pay: PayrollIncomeRateOfPay, pay_frequency: Optional[str] = None, account_id: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayrollIncomeAccountData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayrollIncomeAccountData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_frequency: Optional[str]

The frequency at which an individual is paid.

rate_of_pay: PayrollIncomeRateOfPay

An object representing the rate at which an individual is paid.

class plaid2.model.PayrollIncomeObject(*, w_2_s: List[CreditW2], form_1099_s: List[Credit1099], pay_stubs: List[CreditPayStub], account_id: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

form_1099_s: List[Credit1099]

Array of tax form 1099s.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayrollIncomeObject[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayrollIncomeObject[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_stubs: List[CreditPayStub]

Array of pay stubs for the user.

w_2_s: List[CreditW2]

Array of tax form W-2s.

class plaid2.model.PayrollIncomeRateOfPay(*, pay_rate: Optional[str] = None, pay_amount: Optional[float] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayrollIncomeRateOfPay[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayrollIncomeRateOfPay[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_amount: Optional[float]

The amount at which an employee is paid.

pay_rate: Optional[str]

The rate at which an employee is paid.

class plaid2.model.PayrollItem(*, pull_id: str, item_id: str, accounts: List[PayrollIncomeAccountData], payroll_income: List[PayrollIncomeObject], status: Optional[str] = None)[source]

Bases: BaseModel

accounts: List[PayrollIncomeAccountData]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayrollItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayrollItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payroll_income: List[PayrollIncomeObject]
pull_id: str

A reference id to reference what payroll data was returned from this endpoint

status: Optional[str]

Details about the status of the payroll item.

class plaid2.model.PayrollRiskSignalsItem(*, item_id: str, verification_risk_signals: List[DocumentRiskSignalsObject])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayrollRiskSignalsItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PayrollRiskSignalsItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

verification_risk_signals: List[DocumentRiskSignalsObject]

Array of payroll income document authenticity data retrieved for each of the user’s accounts

class plaid2.model.Paystub(*, earnings: Earnings, employment_details: Optional[EmploymentDetails] = None, employer: PaystubEmployer, pay_period_details: PayPeriodDetails, net_pay: NetPay, paystub_details: Optional[PaystubDetails] = None, deductions: Deductions, income_breakdown: Optional[List[IncomeBreakdown]] = None, employee: Employee, doc_id: str, ytd_earnings: Optional[PaystubYtdDetails] = None, verification: Optional[PaystubVerification] = None)[source]

Bases: BaseModel

deductions: Deductions

An object with the deduction information found on a paystub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

doc_id: str

An identifier of the document referenced by the document metadata.

earnings: Earnings

An object representing both a breakdown of earnings on a paystub and the total earnings.

employee: Employee

Data about the employee.

employer: PaystubEmployer

Information about the employer on the paystub

employment_details: Optional[EmploymentDetails]

An object representing employment details found on a paystub.

income_breakdown: Optional[List[IncomeBreakdown]]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

net_pay: NetPay

An object representing information about the net pay amount on the paystub.

classmethod parse_obj(data: Any) → Paystub[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Paystub[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_period_details: PayPeriodDetails

Details about the pay period.

paystub_details: Optional[PaystubDetails]

An object representing details that can be found on the paystub.

verification: Optional[PaystubVerification]

An object containing details on the paystub’s verification status. This object will only be populated if the [income_verification.access_tokens](/docs/api/tokens/#link-token-create-request-income-verification-access-tokens) parameter was provided during the /link/token/create call or if a problem was detected with the information supplied by the user; otherwise it will be null.

ytd_earnings: Optional[PaystubYtdDetails]

The amount of income earned year to date, as based on paystub data.

class plaid2.model.PaystubAddress(*, line_2: Optional[str] = None, region: Optional[str] = None, postal_code: Optional[str] = None, city: Optional[str] = None, street: Optional[str] = None, line_1: Optional[str] = None, country: Optional[str] = None, state_code: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name.

country: Optional[str]

The ISO 3166-1 alpha-2 country code.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

line_1: Optional[str]

Street address line 1.

line_2: Optional[str]

Street address line 2.

classmethod parse_obj(data: Any) → PaystubAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code of the address.

region: Optional[str]

The region or state Example: “NC”

state_code: Optional[str]

The region or state Example: “NC”

street: Optional[str]

The full street address.

class plaid2.model.PaystubDeduction(*, total: Optional[float] = None, type: Optional[str] = None, is_pretax: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

is_pretax: Optional[bool]

true if the deduction is pre-tax; false otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaystubDeduction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubDeduction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

total: Optional[float]

The amount of the deduction.

type: Optional[str]

“401(k)”, “FICA MED TAX”.

Type

The description of the deduction, as provided on the paystub. For example

class plaid2.model.PaystubDetails(*, paystub_provider: Optional[str] = None, pay_date: Optional[str] = None, pay_period_end_date: Optional[str] = None, pay_period_start_date: Optional[str] = None, pay_frequency: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaystubDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_date: Optional[str]

Pay date on the paystub in the ‘YYYY-MM-DD’ format.

pay_frequency: Optional[str]

MONTHLY, BI-WEEKLY, WEEKLY, SEMI-MONTHLY.

Type

The frequency at which the employee is paid. Possible values

pay_period_end_date: Optional[str]

Ending date of the pay period on the paystub in the ‘YYYY-MM-DD’ format.

pay_period_start_date: Optional[str]

Beginning date of the pay period on the paystub in the ‘YYYY-MM-DD’ format.

paystub_provider: Optional[str]

The name of the payroll provider that generated the paystub, e.g. ADP

class plaid2.model.PaystubEmployer(*, address: Optional[PaystubAddress] = None, name: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[PaystubAddress]

Address on the paystub

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The name of the employer on the paystub.

classmethod parse_obj(data: Any) → PaystubEmployer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubEmployer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaystubOverride(*, income_breakdown: Optional[List[IncomeBreakdown]] = None, pay_period_details: Optional[PayPeriodDetails] = None, employer: Optional[str] = None, employee: Optional[PaystubOverrideEmployee] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee: Optional[PaystubOverrideEmployee]

The employee on the paystub.

employer: Optional[str]

The employer on the paystub.

income_breakdown: Optional[List[IncomeBreakdown]]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaystubOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_period_details: Optional[PayPeriodDetails]

Details about the pay period.

class plaid2.model.PaystubOverrideEmployee(*, name: Optional[str] = None, address: Optional[PaystubOverrideEmployeeAddress] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[PaystubOverrideEmployeeAddress]

The address of the employee.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

The name of the employee.

classmethod parse_obj(data: Any) → PaystubOverrideEmployee[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubOverrideEmployee[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PaystubOverrideEmployeeAddress(*, street: Optional[str] = None, country: Optional[str] = None, postal_code: Optional[str] = None, region: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name.

country: Optional[str]

The country of the address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaystubOverrideEmployeeAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubOverrideEmployeeAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

5 digit postal code.

region: Optional[str]

The region or state Example: “NC”

street: Optional[str]

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

class plaid2.model.PaystubPayFrequency(value)[source]

Bases: str, Enum

An enumeration.

bi_weekly = 'BI-WEEKLY'
monthly = 'MONTHLY'
semi_monthly = 'SEMI-MONTHLY'
weekly = 'WEEKLY'
class plaid2.model.PaystubVerification(*, verification_attributes: List[VerificationAttribute], verification_status: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PaystubVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

verification_attributes: List[VerificationAttribute]
verification_status: Optional[str]

Derived verification status.

class plaid2.model.PaystubVerificationStatus(value)[source]

Bases: str, Enum

An enumeration.

paystub_verification_status_fraudulent = 'PAYSTUB_VERIFICATION_STATUS_FRAUDULENT'
paystub_verification_status_unknown = 'PAYSTUB_VERIFICATION_STATUS_UNKNOWN'
paystub_verification_status_verified = 'PAYSTUB_VERIFICATION_STATUS_VERIFIED'
class plaid2.model.PaystubYtdDetails(*, gross_earnings: Optional[float] = None, net_earnings: Optional[float] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

gross_earnings: Optional[float]

Year-to-date gross earnings.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

net_earnings: Optional[float]

Year-to-date net (take home) earnings.

classmethod parse_obj(data: Any) → PaystubYtdDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaystubYtdDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PendingExpirationWebhook(*, consent_expiration_time: str, webhook_type: str, webhook_code: str, item_id: str)[source]

Bases: BaseModel

consent_expiration_time: str

//wikipedia.org/wiki/ISO_8601) format

Type

The date and time at which the Item’s access consent will expire, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PendingExpirationWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PendingExpirationWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

PENDING_EXPIRATION

webhook_type: str

ITEM

class plaid2.model.PersonalFinanceCategory(*, primary: str, detailed: str)[source]

Bases: BaseModel

detailed: str

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PersonalFinanceCategory[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PersonalFinanceCategory[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

primary: str

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

class plaid2.model.PhoneNumber(*, data: str, primary: bool, type: str)[source]

Bases: BaseModel

data: str

The phone number.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PhoneNumber[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PhoneNumber[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

primary: bool

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

type: str

The type of phone number.

class plaid2.model.PhoneType(value)[source]

Bases: str, Enum

An enumeration.

fax = 'fax'
phone = 'phone'
class plaid2.model.PhysicalDocumentCategory(value)[source]

Bases: str, Enum

An enumeration.

drivers_license = 'drivers_license'
id_card = 'id_card'
passport = 'passport'
residence_permit_card = 'residence_permit_card'
resident_card = 'resident_card'
class plaid2.model.PhysicalDocumentExtractedData(*, expiration_date: Optional[str] = None, category: str, id_number: Optional[str] = None, issuing_country: str)[source]

Bases: BaseModel

category: str

The type of identity document detected in the images provided. Will always be one of the following values:

drivers_license - A driver’s license for the associated country

id_card - A general national identification card, distinct from driver’s licenses

passport - A passport for the associated country

residence_permit_card - An identity document permitting a foreign citizen to <em>temporarily</em> reside in the associated country

resident_card - An identity document permitting a foreign citizen to <em>permanently</em> reside in the associated country

Note: This value may be different from the ID type that the user selects within Link. For example, if they select “Driver’s License” but then submit a picture of a passport, this field will say passport

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expiration_date: Optional[str]
id_number: Optional[str]

Alpha-numeric ID number extracted via OCR from the user’s document image.

issuing_country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PhysicalDocumentExtractedData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PhysicalDocumentExtractedData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PhysicalDocumentExtractedDataAnalysis(*, date_of_birth: str, expiration_date: str, issuing_country: str, name: str)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
date_of_birth: str

A match summary describing the cross comparison between the subject’s date of birth, extracted from the document image, and the date of birth they separately provided to the identity verification attempt.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

expiration_date: str

A description of whether the associated document was expired when the verification was performed.

Note: In the case where an expiration date is not present on the document or failed to be extracted, this value will be no_data.

issuing_country: str

A binary match indicator specifying whether the country that issued the provided document matches the country that the user separately provided to Plaid.

Note: You can configure whether a no_match on issuing_country fails the documentary_verification by editing your Plaid Template.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

A match summary describing the cross comparison between the subject’s name, extracted from the document image, and the name they separately provided to identity verification attempt.

classmethod parse_obj(data: Any) → PhysicalDocumentExtractedDataAnalysis[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PhysicalDocumentExtractedDataAnalysis[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PhysicalDocumentImages(*, original_back: Optional[str] = None, original_front: str, cropped_back: Optional[str] = None, face: Optional[str] = None, cropped_front: Optional[str] = None)[source]

Bases: BaseModel

cropped_back: Optional[str]

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document was not collected.

cropped_front: Optional[str]

Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

face: Optional[str]

Temporary URL that expires after 60 seconds for downloading a crop of just the user’s face from the document image. Might be null if the document does not contain a face photo.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

original_back: Optional[str]

Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not collected.

original_front: str

Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.

classmethod parse_obj(data: Any) → PhysicalDocumentImages[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PhysicalDocumentImages[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.PlatformIds(*, position_id: Optional[str] = None, employee_id: Optional[str] = None, payroll_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee_id: Optional[str]

The ID of an employee as given by their employer

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PlatformIds[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PlatformIds[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payroll_id: Optional[str]

The ID of an employee as given by their payroll

position_id: Optional[str]

The ID of the position of the employee

class plaid2.model.PoBoxStatus(value)[source]

Bases: str, Enum

An enumeration.

no = 'no'
no_data = 'no_data'
yes = 'yes'
class plaid2.model.ProcessorApexProcessorTokenCreateRequest(*, account_id: str, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id value obtained from the onSuccess callback in Link

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorApexProcessorTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorApexProcessorTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ProcessorAuthGetResponse(*, request_id: str, account: AccountBase, numbers: ProcessorNumber)[source]

Bases: BaseModel

account: AccountBase

A single account at a financial institution.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

numbers: ProcessorNumber

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.

classmethod parse_obj(data: Any) → ProcessorAuthGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorAuthGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ProcessorBalanceGetRequest(*, processor_token: str, options: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[str]

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

classmethod parse_obj(data: Any) → ProcessorBalanceGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorBalanceGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

processor_token: str

processor-<environment>-<identifier>

Type

The processor token obtained from the Plaid integration partner. Processor tokens are in the format

class plaid2.model.ProcessorBalanceGetResponse(*, account: AccountBase, request_id: str)[source]

Bases: BaseModel

account: AccountBase

A single account at a financial institution.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorBalanceGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorBalanceGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ProcessorBankTransferCreateRequest(*, processor_token: str, metadata: Optional[BankTransferMetadata] = None, amount: str, iso_currency_code: str, origination_account_id: Optional[str] = None, description: str, idempotency_key: str, user: BankTransferUser, network: str, ach_class: Optional[str] = None, type: str, custom_tag: Optional[str] = None)[source]

Bases: BaseModel

ach_class: Optional[str]

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).

custom_tag: Optional[str]

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

description: str

The transfer description. Maximum of 10 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique bank transfer. Maximum of 50 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

iso_currency_code: str

The currency of the transfer amount – should be set to “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[BankTransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str

The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

origination_account_id: Optional[str]

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.

classmethod parse_obj(data: Any) → ProcessorBankTransferCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorBankTransferCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

processor_token: str

processor-<environment>-<identifier>

Type

The processor token obtained from the Plaid integration partner. Processor tokens are in the format

type: str

The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: BankTransferUser

The legal name and other information for the account holder.

class plaid2.model.ProcessorBankTransferCreateResponse(*, request_id: str, bank_transfer: BankTransfer)[source]

Bases: BaseModel

bank_transfer: BankTransfer

Represents a bank transfer within the Bank Transfers API.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorBankTransferCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorBankTransferCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ProcessorIdentityGetResponse(*, request_id: str, account: AccountBase)[source]

Bases: BaseModel

account: AccountBase

Identity information about an account

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorIdentityGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorIdentityGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.ProcessorNumber(*, international: Optional[NumbersInternational] = None, eft: Optional[NumbersEft] = None, ach: Optional[NumbersAch] = None, bacs: Optional[NumbersBacs] = None)[source]

Bases: BaseModel

ach: Optional[NumbersAch]

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

bacs: Optional[NumbersBacs]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

eft: Optional[NumbersEft]

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

international: Optional[NumbersInternational]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorNumber[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorNumber[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ProcessorStripeBankAccountTokenCreateRequest(*, account_id: str, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id value obtained from the onSuccess callback in Link

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorStripeBankAccountTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorStripeBankAccountTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ProcessorStripeBankAccountTokenCreateResponse(*, stripe_bank_account_token: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorStripeBankAccountTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorStripeBankAccountTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

stripe_bank_account_token: str

A token that can be sent to Stripe for use in making API calls to Plaid

class plaid2.model.ProcessorTokenCreateRequest(*, access_token: str, processor: str, account_id: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id value obtained from the onSuccess callback in Link

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

processor: str

The processor you are integrating with.

class plaid2.model.ProcessorTokenCreateResponse(*, processor_token: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProcessorTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProcessorTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

processor_token: str

The processor_token that can then be used by the Plaid partner to make API requests

request_id: str

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

class plaid2.model.ProductAccess(*, accounts_statements: Optional[bool] = None, accounts_tax_statements: Optional[bool] = None, customers_profiles: Optional[bool] = None, auth: Optional[bool] = None, transactions: Optional[bool] = None, identity: Optional[bool] = None, accounts_details_transactions: Optional[bool] = None, accounts_routing_number: Optional[bool] = None, statements: Optional[bool] = None)[source]

Bases: BaseModel

accounts_details_transactions: Optional[bool]

Allow access to “accounts_details_transactions”. Only used by certain partners. If relevant to the partner and unset, defaults to true.

accounts_routing_number: Optional[bool]

Allow access to “accounts_routing_number”. Only used by certain partners. If relevant to the partner and unset, defaults to true.

accounts_statements: Optional[bool]

Allow access to “accounts_statements”. Only used by certain partners. If relevant to the partner and unset, defaults to true.

accounts_tax_statements: Optional[bool]

Allow access to “accounts_tax_statements”. Only used by certain partners. If relevant to the partner and unset, defaults to true.

auth: Optional[bool]

Allow access to account number details. Only used by certain partners. If relevant to the partner and unset, defaults to true.

customers_profiles: Optional[bool]

Allow access to “customers_profiles”. Only used by certain partners. If relevant to the partner and unset, defaults to true.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

identity: Optional[bool]

Allow access to the Identity product (name, email, phone, address). Only used by certain partners. If relevant to the partner and unset, defaults to true.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProductAccess[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProductAccess[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

statements: Optional[bool]

Allow access to statements. Only used by certain partners. If relevant to the partner and unset, defaults to true.

transactions: Optional[bool]

Allow access to transaction details. Only used by certain partners. If relevant to the partner and unset, defaults to true.

class plaid2.model.ProductStatus(*, last_status_change: str, status: str, breakdown: ProductStatusBreakdown)[source]

Bases: BaseModel

breakdown: ProductStatusBreakdown

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_status_change: str

//wikipedia.org/wiki/ISO_8601) formatted timestamp of the last status change for the institution.

Type

[ISO 8601](https

classmethod parse_obj(data: Any) → ProductStatus[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProductStatus[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

This field is deprecated in favor of the breakdown object, which provides more granular institution health data.

HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

class plaid2.model.ProductStatusBreakdown(*, error_institution: float, error_plaid: float, success: float, refresh_interval: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error_institution: float

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

error_plaid: float

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ProductStatusBreakdown[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ProductStatusBreakdown[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

refresh_interval: Optional[str]

The refresh_interval may be DELAYED or STOPPED even when the success rate is high. This value is only returned for Transactions status breakdowns.

success: float

The percentage of login attempts that are successful, expressed as a decimal.

class plaid2.model.Products(value)[source]

Bases: str, Enum

An enumeration.

assets = 'assets'
auth = 'auth'
balance = 'balance'
credit_details = 'credit_details'
deposit_switch = 'deposit_switch'
employment = 'employment'
identity = 'identity'
identity_verification = 'identity_verification'
income = 'income'
income_verification = 'income_verification'
investments = 'investments'
liabilities = 'liabilities'
payment_initiation = 'payment_initiation'
recurring_transactions = 'recurring_transactions'
standing_orders = 'standing_orders'
transactions = 'transactions'
transfer = 'transfer'
class plaid2.model.ProgramNameSensitivity(value)[source]

Bases: str, Enum

An enumeration.

balanced = 'balanced'
coarse = 'coarse'
exact = 'exact'
strict = 'strict'
class plaid2.model.PslfStatus(*, payments_remaining: Optional[float] = None, payments_made: Optional[float] = None, estimated_eligibility_date: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

estimated_eligibility_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The estimated date borrower will have completed 120 qualifying monthly payments. Returned in [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PslfStatus[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PslfStatus[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payments_made: Optional[float]

The number of qualifying payments that have been made.

payments_remaining: Optional[float]

The number of qualifying payments remaining.

class plaid2.model.RecaptchaRequiredError(*, error_type: str, link_user_experience: str, common_causes: str, http_code: str, error_code: str, display_message: str, troubleshooting_steps: str)[source]

Bases: BaseModel

common_causes: str

Plaid’s fraud system detects abusive traffic and considers a variety of parameters throughout Item creation requests. When a request is considered risky or possibly fraudulent, Link presents a reCAPTCHA for the user to solve.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

display_message: str
error_code: str

RECAPTCHA_REQUIRED

error_type: str

RECAPTCHA_ERROR

http_code: str

400

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

Your user will be prompted to solve a Google reCAPTCHA challenge in the Link Recaptcha pane. If they solve the challenge successfully, the user’s request is resubmitted and they are directed to the next Item creation step.

classmethod parse_obj(data: Any) → RecaptchaRequiredError[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → RecaptchaRequiredError[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

troubleshooting_steps: str

Link will automatically guide your user through reCAPTCHA verification. As a general rule, we recommend instrumenting basic fraud monitoring to detect and protect your website from spam and abuse.

If your user cannot verify their session, please submit a Support ticket with the following identifiers: link_session_id or request_id

class plaid2.model.RecipientBacs(*, sort_code: Optional[str] = None, account: Optional[str] = None)[source]

Bases: BaseModel

account: Optional[str]

The account number of the account. Maximum of 10 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → RecipientBacs[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → RecipientBacs[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sort_code: Optional[str]

The 6-character sort code of the account.

class plaid2.model.RecurringTransactionFrequency(value)[source]

Bases: str, Enum

An enumeration.

biweekly = 'BIWEEKLY'
monthly = 'MONTHLY'
semi_monthly = 'SEMI_MONTHLY'
unknown = 'UNKNOWN'
weekly = 'WEEKLY'
class plaid2.model.RecurringTransactionsUpdateWebhook(*, item_id: str, webhook_type: str, webhook_code: str, account_ids: List[str])[source]

Bases: BaseModel

account_ids: List[str]

A list of account_ids for accounts that have new or updated recurring transactions data.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → RecurringTransactionsUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → RecurringTransactionsUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

RECURRING_TRANSACTIONS_UPDATE

webhook_type: str

TRANSACTIONS

class plaid2.model.RelayEvent(value)[source]

Bases: str, Enum

An enumeration.

audit_copy_create_called = 'AUDIT_COPY_CREATE_CALLED'
get_called = 'GET_CALLED'
refresh_called = 'REFRESH_CALLED'
class plaid2.model.ReportToken(*, report_type: Optional[str] = None, token: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ReportToken[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ReportToken[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

report_type: Optional[str]

The report type. It can be assets or income.

token: Optional[str]

The report token. It can be an asset report token or an income report token.

class plaid2.model.ReportType(value)[source]

Bases: str, Enum

An enumeration.

assets = 'assets'
income = 'income'
class plaid2.model.RiskSignalDocumentReference(*, document_name: Optional[str] = None, document_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_id: Optional[str]

An identifier of the document referenced by the document metadata.

document_name: Optional[str]

The name of the document

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → RiskSignalDocumentReference[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → RiskSignalDocumentReference[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxBankTransferFireWebhookResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxBankTransferFireWebhookResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxBankTransferFireWebhookResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxBankTransferSimulateRequest(*, event_type: str, failure_reason: Optional[BankTransferFailure] = None, bank_transfer_id: str)[source]

Bases: BaseModel

bank_transfer_id: str

Plaid’s unique identifier for a bank transfer.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

event_type: str

posted, failed, or reversed.

An error will be returned if the event type is incompatible with the current transfer status. Compatible status –> event type transitions include:

pending –> failed

pending –> posted

posted –> reversed

Type

The asynchronous event to be simulated. May be

failure_reason: Optional[BankTransferFailure]

The failure reason if the type of this transfer is “failed” or “reversed”. Null value otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxBankTransferSimulateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxBankTransferSimulateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxBankTransferSimulateResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxBankTransferSimulateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxBankTransferSimulateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxIncomeFireWebhookRequest(*, item_id: str, user_id: Optional[str] = None, webhook: str, verification_status: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The Item ID associated with the verification.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxIncomeFireWebhookRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxIncomeFireWebhookRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_id: Optional[str]

The Plaid user_id of the User associated with this webhook, warning, or error.

verification_status: str

The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /income/verification/paystubs/get endpoint and check the document metadata to see which documents were successfully parsed.

VERIFICATION_STATUS_PROCESSING_FAILED: A failure occurred when attempting to process the verification documentation.

VERIFICATION_STATUS_PENDING_APPROVAL: The income verification has been sent to the user for review.

Type

VERIFICATION_STATUS_PROCESSING_COMPLETE

webhook: str

The URL to which the webhook should be sent.

class plaid2.model.SandboxIncomeFireWebhookResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxIncomeFireWebhookResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxIncomeFireWebhookResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxItemFireWebhookRequest(*, webhook_code: str, webhook_type: Optional[str] = None, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxItemFireWebhookRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxItemFireWebhookRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

The webhook codes that can be fired by this test endpoint.

webhook_type: Optional[str]

The webhook types that can be fired by this test endpoint.

class plaid2.model.SandboxItemFireWebhookResponse(*, webhook_fired: bool, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxItemFireWebhookResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxItemFireWebhookResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

webhook_fired: bool

Value is true if the test` webhook_code` was successfully fired.

class plaid2.model.SandboxItemResetLoginResponse(*, reset_login: bool, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxItemResetLoginResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxItemResetLoginResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

reset_login: bool

true if the call succeeded

class plaid2.model.SandboxItemSetVerificationStatusRequest(*, access_token: str, account_id: str, verification_status: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id of the account whose verification status is to be modified

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxItemSetVerificationStatusRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxItemSetVerificationStatusRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

verification_status: str

The verification status to set the account to.

class plaid2.model.SandboxItemSetVerificationStatusResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxItemSetVerificationStatusResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxItemSetVerificationStatusResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxOauthSelectAccountsRequest(*, oauth_state_id: str, accounts: List[str])[source]

Bases: BaseModel

accounts: List[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

oauth_state_id: str
classmethod parse_obj(data: Any) → SandboxOauthSelectAccountsRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxOauthSelectAccountsRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxOauthSelectAccountsResponse[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxOauthSelectAccountsResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxOauthSelectAccountsResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxProcessorTokenCreateRequest(*, institution_id: str, options: Optional[SandboxProcessorTokenCreateRequestOptions] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: str

The ID of the institution the Item will be associated with

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[SandboxProcessorTokenCreateRequestOptions]

An optional set of options to be used when configuring the Item. If specified, must not be null.

classmethod parse_obj(data: Any) → SandboxProcessorTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxProcessorTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxProcessorTokenCreateRequestOptions(*, override_password: Optional[str] = None, override_username: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

override_password: Optional[str]

Test password to use for the creation of the Sandbox Item. Default value is pass_good.

override_username: Optional[str]

Test username to use for the creation of the Sandbox Item. Default value is user_good.

classmethod parse_obj(data: Any) → SandboxProcessorTokenCreateRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxProcessorTokenCreateRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxProcessorTokenCreateResponse(*, request_id: str, processor_token: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxProcessorTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxProcessorTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

processor_token: str

A processor token that can be used to call the /processor/ endpoints.

request_id: str

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

class plaid2.model.SandboxPublicTokenCreateRequest(*, options: Optional[SandboxPublicTokenCreateRequestOptions] = None, user_token: Optional[str] = None, institution_id: str, initial_products: List[str])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

initial_products: List[str]

The products to initially pull for the Item. May be any products that the specified institution_id supports. This array may not be empty.

institution_id: str

The ID of the institution the Item will be associated with

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[SandboxPublicTokenCreateRequestOptions]

An optional set of options to be used when configuring the Item. If specified, must not be null.

classmethod parse_obj(data: Any) → SandboxPublicTokenCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxPublicTokenCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_token: Optional[str]

The user token associated with the User data is being requested for.

class plaid2.model.SandboxPublicTokenCreateRequestOptions(*, webhook: Optional[str] = None, override_username: Optional[str] = None, override_password: Optional[str] = None, transactions: Optional[SandboxPublicTokenCreateRequestOptionsTransactions] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

override_password: Optional[str]

Test password to use for the creation of the Sandbox Item. Default value is pass_good.

override_username: Optional[str]

Test username to use for the creation of the Sandbox Item. Default value is user_good.

classmethod parse_obj(data: Any) → SandboxPublicTokenCreateRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxPublicTokenCreateRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactions: Optional[SandboxPublicTokenCreateRequestOptionsTransactions]

An optional set of parameters corresponding to transactions options.

webhook: Optional[str]

Specify a webhook to associate with the new Item.

class plaid2.model.SandboxPublicTokenCreateRequestOptionsTransactions(*, end_date: Optional[str] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxPublicTokenCreateRequestOptionsTransactions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxPublicTokenCreateRequestOptionsTransactions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.

class plaid2.model.SandboxPublicTokenCreateResponse(*, public_token: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxPublicTokenCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxPublicTokenCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

public_token: str

A public token that can be exchanged for an access token using /item/public_token/exchange

request_id: str

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

class plaid2.model.SandboxTransferFireWebhookResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferFireWebhookResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferFireWebhookResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxTransferRepaymentSimulateRequest[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferRepaymentSimulateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferRepaymentSimulateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxTransferRepaymentSimulateResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferRepaymentSimulateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferRepaymentSimulateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxTransferSimulateRequest(*, failure_reason: Optional[TransferFailure] = None, transfer_id: str, event_type: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

event_type: str

posted, failed, or returned.

An error will be returned if the event type is incompatible with the current transfer status. Compatible status –> event type transitions include:

pending –> failed

pending –> posted

posted –> returned

Type

The asynchronous event to be simulated. May be

failure_reason: Optional[TransferFailure]

The failure reason if the event type for a transfer is “failed” or “returned”. Null value otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferSimulateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferSimulateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transfer_id: str

Plaid’s unique identifier for a transfer.

class plaid2.model.SandboxTransferSimulateResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferSimulateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferSimulateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SandboxTransferSweepSimulateRequest[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferSweepSimulateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferSweepSimulateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SandboxTransferSweepSimulateResponse(*, sweep: Optional[SimulatedTransferSweep] = None, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SandboxTransferSweepSimulateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SandboxTransferSweepSimulateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

sweep: Optional[SimulatedTransferSweep]

A sweep returned from the /sandbox/transfer/sweep/simulate endpoint. Can be null if there are no transfers to include in a sweep.

class plaid2.model.Scopes(*, product_access: Optional[ProductAccess] = None, accounts: Optional[List[AccountAccess]] = None, new_accounts: Optional[bool] = None)[source]

Bases: BaseModel

accounts: Optional[List[AccountAccess]]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_accounts: Optional[bool]

Allow access to newly opened accounts as they are opened. If unset, defaults to true.

classmethod parse_obj(data: Any) → Scopes[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Scopes[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

product_access: Optional[ProductAccess]

The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed.

class plaid2.model.ScopesContext(value)[source]

Bases: str, Enum

An enumeration.

enrollment = 'ENROLLMENT'
portal = 'PORTAL'
class plaid2.model.ScreeningHitAnalysis(*, documents: Optional[str] = None, dates_of_birth: Optional[str] = None, locations: Optional[str] = None, names: Optional[str] = None, search_terms_version: float)[source]

Bases: BaseModel

dates_of_birth: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documents: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

locations: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

names: Optional[str]

An enum indicating the match type between data provided by user and data checked against an external data source.

match indicates that the provided input data was a strong match against external data.

partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name.

no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.

no_data indicates that Plaid was unable to find external data to compare against the provided input data.

no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

classmethod parse_obj(data: Any) → ScreeningHitAnalysis[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningHitAnalysis[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

search_terms_version: float

The version of the screening’s search_terms that were compared when the screening hit was added. screening hits are immutable once they have been reviewed. If changes are detected due to updates to the screening’s search_terms, the associated program, or the list’s source data prior to review, the screening hit will be updated to reflect those changes.

class plaid2.model.ScreeningHitData(*, dates_of_birth: Optional[List[ScreeningHitDateOfBirthItem]] = None, names: Optional[List[ScreeningHitNamesItems]] = None, documents: Optional[List[ScreeningHitDocumentsItems]] = None, locations: Optional[List[GenericScreeningHitLocationItems]] = None)[source]

Bases: BaseModel

dates_of_birth: Optional[List[ScreeningHitDateOfBirthItem]]

Dates of birth associated with the watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

documents: Optional[List[ScreeningHitDocumentsItems]]

Documents associated with the watchlist hit

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

locations: Optional[List[GenericScreeningHitLocationItems]]

Locations associated with the watchlist hit

names: Optional[List[ScreeningHitNamesItems]]

Names associated with the watchlist hit

classmethod parse_obj(data: Any) → ScreeningHitData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningHitData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ScreeningHitDateOfBirthItem(*, data: Optional[DateRange] = None, analysis: Optional[str] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[DateRange]

A date range with a start and end date

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ScreeningHitDateOfBirthItem[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningHitDateOfBirthItem[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ScreeningHitDocumentsItems(*, analysis: Optional[str] = None, data: Optional[WatchlistScreeningDocument] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[WatchlistScreeningDocument]

An official document, usually issued by a governing body or institution, with an associated identifier.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ScreeningHitDocumentsItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningHitDocumentsItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ScreeningHitNamesItems(*, data: Optional[IndividualScreeningHitNames] = None, analysis: Optional[str] = None)[source]

Bases: BaseModel

analysis: Optional[str]

Summary object reflecting the match result of the associated data

data: Optional[IndividualScreeningHitNames]

Name information for the associated individual watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ScreeningHitNamesItems[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningHitNamesItems[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.ScreeningStatusUpdatedWebhook(*, webhook_code: str, webhook_type: str, screening_id: Any = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ScreeningStatusUpdatedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ScreeningStatusUpdatedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

screening_id: Any

The ID of the associated screening.

webhook_code: str

STATUS_UPDATED

webhook_type: str

SCREENING

class plaid2.model.Security(*, cusip: Optional[str] = None, name: Optional[str] = None, institution_security_id: Optional[str] = None, type: Optional[str] = None, close_price_as_of: Optional[str] = None, unofficial_currency_code: Optional[str] = None, sedol: Optional[str] = None, institution_id: Optional[str] = None, security_id: str, ticker_symbol: Optional[str] = None, close_price: Optional[float] = None, proxy_security_id: Optional[str] = None, update_datetime: Optional[str] = None, isin: Optional[str] = None, iso_currency_code: Optional[str] = None, is_cash_equivalent: Optional[bool] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
close_price: Optional[float]

Price of the security at the close of the previous trading session. Null for non-public securities.

If the security is a foreign currency this field will be updated daily and will be priced in USD.

If the security is a cryptocurrency, this field will be updated multiple times a day. As crypto prices can fluctuate quickly and data may become stale sooner than other asset classes, please refer to update_datetime with the time when the price was last updated.

close_price_as_of: Optional[str]

Date for which close_price is accurate. Always null if close_price is null.

cusip: Optional[str]

9-character CUSIP, an identifier assigned to North American securities.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_id: Optional[str]

If institution_security_id is present, this field indicates the Plaid institution_id of the institution to whom the identifier belongs.

institution_security_id: Optional[str]

An identifier given to the security by the institution

is_cash_equivalent: Optional[bool]

Indicates that a security is a highly liquid asset and can be treated like cash.

isin: Optional[str]

12-character ISIN, a globally unique securities identifier.

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

A descriptive name for the security, suitable for display.

classmethod parse_obj(data: Any) → Security[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Security[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

proxy_security_id: Optional[str]

In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.

security_id: str

A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id is case sensitive.

sedol: Optional[str]

7-character SEDOL, an identifier assigned to securities in the UK.

ticker_symbol: Optional[str]

The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.

type: Optional[str]

The security type of the holding. Valid security types are:

cash: Cash, currency, and money market funds

cryptocurrency: Digital or virtual currencies

derivative: Options, warrants, and other derivative instruments

equity: Domestic and foreign equities

etf: Multi-asset exchange-traded investment funds

fixed income: Bonds and certificates of deposit (CDs)

loan: Loans and loan receivables

mutual fund: Open- and closed-end vehicles pooling funds of multiple investors

other: Unknown or other investment types

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the security. 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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

update_datetime: Optional[str]

ssZ). Always null if close_price is null.

Type

Date and time at which close_price is accurate, in ISO 8601 format (YYYY-MM-DDTHH

Type

mm

class plaid2.model.SecurityOverride(*, isin: Optional[str] = None, cusip: Optional[str] = None, name: Optional[str] = None, currency: Optional[str] = None, sedol: Optional[str] = None, ticker_symbol: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
currency: Optional[str]

Either a valid iso_currency_code or unofficial_currency_code

cusip: Optional[str]

9-character CUSIP, an identifier assigned to North American securities.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

isin: Optional[str]

12-character ISIN, a globally unique securities identifier.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[str]

A descriptive name for the security, suitable for display.

classmethod parse_obj(data: Any) → SecurityOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SecurityOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sedol: Optional[str]

7-character SEDOL, an identifier assigned to securities in the UK.

ticker_symbol: Optional[str]

The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.

class plaid2.model.ServicerAddressData(*, street: Optional[str] = None, country: Optional[str] = None, city: Optional[str] = None, region: Optional[str] = None, postal_code: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name

country: Optional[str]

The ISO 3166-1 alpha-2 country code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ServicerAddressData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ServicerAddressData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code

region: Optional[str]

The region or state Example: “NC”

street: Optional[str]

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

class plaid2.model.SignalAddressData(*, country: Optional[str] = None, street: Optional[str] = None, region: Optional[str] = None, postal_code: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name

country: Optional[str]

The ISO 3166-1 alpha-2 country code

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalAddressData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalAddressData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code

region: Optional[str]

The region or state Example: “NC”

street: Optional[str]

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

class plaid2.model.SignalDecisionReportRequest(*, days_funds_on_hold: Optional[int] = None, initiated: bool, client_transaction_id: str)[source]

Bases: BaseModel

client_transaction_id: str

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

days_funds_on_hold: Optional[int]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

initiated: bool

true if the ACH transaction was initiated, false otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalDecisionReportRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalDecisionReportRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SignalDecisionReportResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalDecisionReportResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalDecisionReportResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SignalDevice(*, ip_address: Optional[str] = None, user_agent: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

ip_address: Optional[str]

The IP address of the device that initiated the transaction

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalDevice[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalDevice[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_agent: Optional[str]

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

class plaid2.model.SignalEvaluateCoreAttributes(*, p_50_credit_transactions_amount_28_d: Optional[float] = None, plaid_non_oauth_authentication_attempts_count_30_d: Optional[int] = None, phone_change_count_90_d: Optional[int] = None, current_balance: Optional[float] = None, total_debit_transactions_amount_10_d: Optional[float] = None, address_change_count_90_d: Optional[int] = None, days_with_negative_balance_count_90_d: Optional[int] = None, p_90_eod_balance_60_d: Optional[float] = None, p_90_eod_balance_90_d: Optional[float] = None, nsf_overdraft_transactions_count_30_d: Optional[int] = None, plaid_connections_count_30_d: Optional[int] = None, available_balance: Optional[float] = None, balance_last_updated: Optional[str] = None, failed_plaid_non_oauth_authentication_attempts_count_30_d: Optional[int] = None, total_debit_transactions_amount_60_d: Optional[float] = None, total_credit_transactions_amount_90_d: Optional[float] = None, p_50_eod_balance_30_d: Optional[float] = None, p_10_eod_balance_31_d_to_60_d: Optional[float] = None, credit_transactions_count_60_d: Optional[int] = None, nsf_overdraft_transactions_count_90_d: Optional[int] = None, days_since_first_plaid_connection: Optional[int] = None, unauthorized_transactions_count_60_d: Optional[int] = None, email_change_count_90_d: Optional[int] = None, address_change_count_28_d: Optional[int] = None, p_95_credit_transactions_amount_28_d: Optional[float] = None, p_50_eod_balance_31_d_to_60_d: Optional[float] = None, debit_transactions_count_60_d: Optional[int] = None, email_change_count_28_d: Optional[int] = None, unauthorized_transactions_count_90_d: Optional[int] = None, is_savings_or_money_market_account: Optional[bool] = None, total_debit_transactions_amount_90_d: Optional[float] = None, total_credit_transactions_amount_10_d: Optional[float] = None, debit_transactions_count_10_d: Optional[int] = None, total_debit_transactions_amount_30_d: Optional[float] = None, unauthorized_transactions_count_7_d: Optional[int] = None, p_50_debit_transactions_amount_28_d: Optional[float] = None, p_10_eod_balance_90_d: Optional[float] = None, p_50_eod_balance_61_d_to_90_d: Optional[float] = None, unauthorized_transactions_count_30_d: Optional[int] = None, plaid_non_oauth_authentication_attempts_count_7_d: Optional[int] = None, p_10_eod_balance_61_d_to_90_d: Optional[float] = None, debit_transactions_count_30_d: Optional[int] = None, p_90_eod_balance_31_d_to_60_d: Optional[float] = None, p_95_debit_transactions_amount_28_d: Optional[float] = None, p_90_eod_balance_30_d: Optional[float] = None, phone_change_count_28_d: Optional[int] = None, p_10_eod_balance_60_d: Optional[float] = None, plaid_connections_count_7_d: Optional[int] = None, credit_transactions_count_90_d: Optional[int] = None, nsf_overdraft_transactions_count_7_d: Optional[int] = None, failed_plaid_non_oauth_authentication_attempts_count_3_d: Optional[int] = None, p_50_eod_balance_60_d: Optional[float] = None, total_plaid_connections_count: Optional[int] = None, failed_plaid_non_oauth_authentication_attempts_count_7_d: Optional[int] = None, debit_transactions_count_90_d: Optional[int] = None, p_10_eod_balance_30_d: Optional[float] = None, total_credit_transactions_amount_60_d: Optional[float] = None, credit_transactions_count_10_d: Optional[int] = None, total_credit_transactions_amount_30_d: Optional[float] = None, nsf_overdraft_transactions_count_60_d: Optional[int] = None, credit_transactions_count_30_d: Optional[int] = None, p_50_eod_balance_90_d: Optional[float] = None, p_90_eod_balance_61_d_to_90_d: Optional[float] = None, plaid_non_oauth_authentication_attempts_count_3_d: Optional[int] = None)[source]

Bases: BaseModel

address_change_count_28_d: Optional[int]

The number of times the account’s addresses on file have changed over the past 28 days

address_change_count_90_d: Optional[int]

The number of times the account’s addresses on file have changed over the past 90 days

available_balance: Optional[float]

Available balance, as of the balance_last_updated time. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.

balance_last_updated: Optional[str]

mm:ssZ) indicating the last time that the balance for the given account has been updated.

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DDTHH

credit_transactions_count_10_d: Optional[int]

The total number of credit (inflow) transactions over the past 10 days from the account that will be debited

credit_transactions_count_30_d: Optional[int]

The total number of credit (inflow) transactions over the past 30 days from the account that will be debited

credit_transactions_count_60_d: Optional[int]

The total number of credit (inflow) transactions over the past 60 days from the account that will be debited

credit_transactions_count_90_d: Optional[int]

The total number of credit (inflow) transactions over the past 90 days from the account that will be debited

current_balance: Optional[float]

Current balance, as of the balance_last_updated time. The current balance is the total amount of funds in the account.

days_since_first_plaid_connection: Optional[int]

The number of days since the first time the Item was connected to an application via Plaid

days_with_negative_balance_count_90_d: Optional[int]

The number of days within the past 90 days when the account that will be debited had a negative end-of-day available balance

debit_transactions_count_10_d: Optional[int]

The total number of debit (outflow) transactions over the past 10 days from the account that will be debited

debit_transactions_count_30_d: Optional[int]

The total number of debit (outflow) transactions over the past 30 days from the account that will be debited

debit_transactions_count_60_d: Optional[int]

The total number of debit (outflow) transactions over the past 60 days from the account that will be debited

debit_transactions_count_90_d: Optional[int]

The total number of debit (outflow) transactions over the past 90 days from the account that will be debited

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_change_count_28_d: Optional[int]

The number of times the account’s email addresses on file have changed over the past 28 days

email_change_count_90_d: Optional[int]

The number of times the account’s email addresses on file have changed over the past 90 days

failed_plaid_non_oauth_authentication_attempts_count_30_d: Optional[int]

The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 30 days

failed_plaid_non_oauth_authentication_attempts_count_3_d: Optional[int]

The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 3 days

failed_plaid_non_oauth_authentication_attempts_count_7_d: Optional[int]

The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 7 days

is_savings_or_money_market_account: Optional[bool]

Indicates if the ACH transaction funding account is a savings/money market account

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

nsf_overdraft_transactions_count_30_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 30 days from the account that will be debited.

nsf_overdraft_transactions_count_60_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 60 days from the account that will be debited.

nsf_overdraft_transactions_count_7_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 7 days from the account that will be debited.

nsf_overdraft_transactions_count_90_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 90 days from the account that will be debited.

p_10_eod_balance_30_d: Optional[float]

The 10th percentile of the end-of-day available balance over the past 30 days of the account that will be debited

p_10_eod_balance_31_d_to_60_d: Optional[float]

The 10th percentile of the end-of-day available balance between day 31 and day 60 over the past 60 days of the account that will be debited

p_10_eod_balance_60_d: Optional[float]

The 10th percentile of the end-of-day available balance over the past 60 days of the account that will be debited

p_10_eod_balance_61_d_to_90_d: Optional[float]

The 10th percentile of the end-of-day available balance between day 61 and day 90 over the past 60 days of the account that will be debited

p_10_eod_balance_90_d: Optional[float]

The 10th percentile of the end-of-day available balance over the past 90 days of the account that will be debited

p_50_credit_transactions_amount_28_d: Optional[float]

The 50th percentile of all credit (inflow) transaction amounts over the past 28 days from the account that will be debited

p_50_debit_transactions_amount_28_d: Optional[float]

The 50th percentile of all debit (outflow) transaction amounts over the past 28 days from the account that will be debited

p_50_eod_balance_30_d: Optional[float]

The 50th percentile of the end-of-day available balance over the past 30 days of the account that will be debited

p_50_eod_balance_31_d_to_60_d: Optional[float]

The 50th percentile of the end-of-day available balance between day 31 and day 60 over the past 60 days of the account that will be debited

p_50_eod_balance_60_d: Optional[float]

The 50th percentile of the end-of-day available balance over the past 60 days of the account that will be debited

p_50_eod_balance_61_d_to_90_d: Optional[float]

The 50th percentile of the end-of-day available balance between day 61 and day 90 over the past 60 days of the account that will be debited

p_50_eod_balance_90_d: Optional[float]

The 50th percentile of the end-of-day available balance over the past 90 days of the account that will be debited

p_90_eod_balance_30_d: Optional[float]

The 90th percentile of the end-of-day available balance over the past 30 days of the account that will be debited

p_90_eod_balance_31_d_to_60_d: Optional[float]

The 90th percentile of the end-of-day available balance between day 31 and day 60 over the past 60 days of the account that will be debited

p_90_eod_balance_60_d: Optional[float]

The 90th percentile of the end-of-day available balance over the past 60 days of the account that will be debited

p_90_eod_balance_61_d_to_90_d: Optional[float]

The 90th percentile of the end-of-day available balance between day 61 and day 90 over the past 60 days of the account that will be debited

p_90_eod_balance_90_d: Optional[float]

The 90th percentile of the end-of-day available balance over the past 90 days of the account that will be debited

p_95_credit_transactions_amount_28_d: Optional[float]

The 95th percentile of all credit (inflow) transaction amounts over the past 28 days from the account that will be debited

p_95_debit_transactions_amount_28_d: Optional[float]

The 95th percentile of all debit (outflow) transaction amounts over the past 28 days from the account that will be debited

classmethod parse_obj(data: Any) → SignalEvaluateCoreAttributes[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalEvaluateCoreAttributes[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_change_count_28_d: Optional[int]

The number of times the account’s phone numbers on file have changed over the past 28 days

phone_change_count_90_d: Optional[int]

The number of times the account’s phone numbers on file have changed over the past 90 days

plaid_connections_count_30_d: Optional[int]

The number of times the Item has been connected to applications via Plaid over the past 30 days

plaid_connections_count_7_d: Optional[int]

The number of times the Item has been connected to applications via Plaid over the past 7 days

plaid_non_oauth_authentication_attempts_count_30_d: Optional[int]

The number of non-OAuth authentication attempts via Plaid for this bank account over the past 30 days

plaid_non_oauth_authentication_attempts_count_3_d: Optional[int]

The number of non-OAuth authentication attempts via Plaid for this bank account over the past 3 days

plaid_non_oauth_authentication_attempts_count_7_d: Optional[int]

The number of non-OAuth authentication attempts via Plaid for this bank account over the past 7 days

total_credit_transactions_amount_10_d: Optional[float]

The total credit (inflow) transaction amount over the past 10 days from the account that will be debited

total_credit_transactions_amount_30_d: Optional[float]

The total credit (inflow) transaction amount over the past 30 days from the account that will be debited

total_credit_transactions_amount_60_d: Optional[float]

The total credit (inflow) transaction amount over the past 60 days from the account that will be debited

total_credit_transactions_amount_90_d: Optional[float]

The total credit (inflow) transaction amount over the past 90 days from the account that will be debited

total_debit_transactions_amount_10_d: Optional[float]

The total debit (outflow) transaction amount over the past 10 days from the account that will be debited

total_debit_transactions_amount_30_d: Optional[float]

The total debit (outflow) transaction amount over the past 30 days from the account that will be debited

total_debit_transactions_amount_60_d: Optional[float]

The total debit (outflow) transaction amount over the past 60 days from the account that will be debited

total_debit_transactions_amount_90_d: Optional[float]

The total debit (outflow) transaction amount over the past 90 days from the account that will be debited

total_plaid_connections_count: Optional[int]

The total number of times the Item has been connected to applications via Plaid

unauthorized_transactions_count_30_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 30 days from the account that will be debited.

unauthorized_transactions_count_60_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 60 days from the account that will be debited.

unauthorized_transactions_count_7_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 7 days from the account that will be debited.

unauthorized_transactions_count_90_d: Optional[int]

We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 90 days from the account that will be debited.

class plaid2.model.SignalEvaluateRequest(*, access_token: str, device: Optional[SignalDevice] = None, amount: float, client_user_id: Optional[str] = None, account_id: str, user_present: Optional[bool] = None, client_transaction_id: str, user: Optional[SignalUser] = None)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_id: str

The account_id of the account whose verification status is to be modified

amount: float

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

client_transaction_id: str

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.

client_user_id: Optional[str]

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. The max length for this field is 36 characters.

device: Optional[SignalDevice]

Details about the end user’s device

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalEvaluateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalEvaluateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user: Optional[SignalUser]

Details about the end user initiating the transaction (i.e., the account holder).

user_present: Optional[bool]

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).

class plaid2.model.SignalEvaluateResponse(*, request_id: str, scores: SignalScores, core_attributes: Optional[SignalEvaluateCoreAttributes] = None)[source]

Bases: BaseModel

core_attributes: Optional[SignalEvaluateCoreAttributes]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalEvaluateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalEvaluateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

scores: SignalScores

Risk scoring details broken down by risk category.

class plaid2.model.SignalPersonName(*, suffix: Optional[str] = None, family_name: Optional[str] = None, prefix: Optional[str] = None, given_name: Optional[str] = None, middle_name: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

family_name: Optional[str]

The user’s family name / surname

given_name: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

middle_name: Optional[str]

The user’s middle name

classmethod parse_obj(data: Any) → SignalPersonName[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalPersonName[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

prefix: Optional[str]

The user’s name prefix (e.g. “Mr.”)

suffix: Optional[str]

The user’s name suffix (e.g. “II”)

class plaid2.model.SignalPrepareResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalPrepareResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalPrepareResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SignalReturnReportRequest(*, client_transaction_id: str, return_code: str)[source]

Bases: BaseModel

client_transaction_id: str

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalReturnReportRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalReturnReportRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

return_code: str

Must be a valid ACH return code (e.g. “R01”)

class plaid2.model.SignalReturnReportResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalReturnReportResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalReturnReportResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.SignalScores(*, bank_initiated_return_risk: Optional[BankInitiatedReturnRisk] = None, customer_initiated_return_risk: Optional[CustomerInitiatedReturnRisk] = None)[source]

Bases: BaseModel

bank_initiated_return_risk: Optional[BankInitiatedReturnRisk]

“R01”, “R02”, “R03”, “R04”, “R06”, “R08”, “R09”, “R13”, “R16”, “R17”, “R20”, “R23”. These returns have a turnaround time of 2 banking days.

Type

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

customer_initiated_return_risk: Optional[CustomerInitiatedReturnRisk]

“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.

Type

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SignalScores[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalScores[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SignalUser(*, address: Optional[SignalAddressData] = None, name: Optional[SignalPersonName] = None, email_address: Optional[str] = None, phone_number: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
address: Optional[SignalAddressData]

Data about the components comprising an address.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: Optional[SignalPersonName]

The user’s legal name

classmethod parse_obj(data: Any) → SignalUser[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SignalUser[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

“+14151234567”

Type

The user’s phone number, in E.164 format

Type

+{countrycode}{number}. For example

class plaid2.model.SimulatedTransferSweep[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SimulatedTransferSweep[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SimulatedTransferSweep[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.SingleDocumentRiskSignal(*, document_reference: RiskSignalDocumentReference, risk_signals: List[DocumentRiskSignal])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_reference: RiskSignalDocumentReference

Object containing metadata for the document

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SingleDocumentRiskSignal[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SingleDocumentRiskSignal[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

risk_signals: List[DocumentRiskSignal]

Array of attributes that indicate whether or not there is fraud risk with a document

class plaid2.model.Source(value)[source]

Bases: str, Enum

An enumeration.

api = 'api'
dashboard = 'dashboard'
system = 'system'
class plaid2.model.StandaloneAccountType(*, depository: str, investment: str, loan: str, credit: str, other: str)[source]

Bases: BaseModel

credit: str

Balance, Transactions, Identity, and Liabilities.

Type

A credit card type account. Supported products for credit accounts are

depository: str

Auth (checking and savings types only), Balance, Transactions, Identity, Payment Initiation, and Assets.

Type

An account type holding cash, in which funds are deposited. Supported products for depository accounts are

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

investment: str

Balance and Investments. In API versions 2018-05-22 and earlier, this type is called brokerage.

Type

An investment account. Supported products for investment accounts are

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

loan: str

Balance, Liabilities, and Transactions.

Type

A loan type account. Supported products for loan accounts are

other: str

Balance, Transactions, Identity, and Assets.

Type

Other or unknown account type. Supported products for other accounts are

classmethod parse_obj(data: Any) → StandaloneAccountType[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StandaloneAccountType[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.StandaloneCurrencyCodeList(*, iso_currency_code: str, unofficial_currency_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

Plaid supports all ISO 4217 currency codes.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → StandaloneCurrencyCodeList[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StandaloneCurrencyCodeList[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: str

List of unofficial currency codes

class plaid2.model.StandaloneInvestmentTransactionType(*, buy: str, cancel: str, fee: str, cash: str, sell: str, transfer: str)[source]

Bases: BaseModel

buy: str

Buying an investment

cancel: str

A cancellation of a pending transaction

cash: str

Activity that modifies a cash position

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

fee: str

Fees on the account, e.g. commission, bookkeeping, options-related.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → StandaloneInvestmentTransactionType[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StandaloneInvestmentTransactionType[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sell: str

Selling an investment

transfer: str

Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer

class plaid2.model.Strategy(value)[source]

Bases: str, Enum

An enumeration.

custom = 'custom'
incomplete = 'incomplete'
infer = 'infer'
reset = 'reset'
class plaid2.model.StudentLoan(*, origination_date: Optional[str] = None, last_payment_amount: Optional[float] = None, outstanding_interest_amount: Optional[float] = None, sequence_number: Optional[str] = None, loan_name: Optional[str] = None, minimum_payment_amount: Optional[float] = None, disbursement_dates: Optional[List[str]] = None, expected_payoff_date: Optional[str] = None, account_number: Optional[str] = None, interest_rate_percentage: float, origination_principal_amount: Optional[float] = None, payment_reference_number: Optional[str] = None, pslf_status: PslfStatus, servicer_address: ServicerAddressData, ytd_principal_paid: Optional[float] = None, ytd_interest_paid: Optional[float] = None, last_statement_issue_date: Optional[str] = None, account_id: Optional[str] = None, is_overdue: Optional[bool] = None, repayment_plan: StudentRepaymentPlan, guarantor: Optional[str] = None, last_payment_date: Optional[str] = None, loan_status: StudentLoanStatus, next_payment_due_date: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

The ID of the account that this liability belongs to.

account_number: Optional[str]

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).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

disbursement_dates: Optional[List[str]]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

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](https

expected_payoff_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

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](https

guarantor: Optional[str]

The guarantor of the student loan.

interest_rate_percentage: float

The interest rate on the loan as a percentage.

is_overdue: Optional[bool]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: Optional[float]

The amount of the last payment.

last_payment_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date of the last payment. Dates are returned in an [ISO 8601](https

last_statement_issue_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date of the last statement. Dates are returned in an [ISO 8601](https

loan_name: Optional[str]

The type of loan, e.g., “Consolidation Loans”.

loan_status: StudentLoanStatus

An object representing the status of the student loan

minimum_payment_amount: Optional[float]

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.

next_payment_due_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

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](https

origination_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https

origination_principal_amount: Optional[float]

The original principal balance of the loan.

outstanding_interest_amount: Optional[float]

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.

classmethod parse_obj(data: Any) → StudentLoan[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StudentLoan[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_reference_number: Optional[str]

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

pslf_status: PslfStatus

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

repayment_plan: StudentRepaymentPlan

An object representing the repayment plan for the student loan

sequence_number: Optional[str]

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

servicer_address: ServicerAddressData

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

ytd_interest_paid: Optional[float]

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

ytd_principal_paid: Optional[float]

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

class plaid2.model.StudentLoanRepaymentModel(*, non_repayment_months: float, type: str, repayment_months: float)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

non_repayment_months: float

Configures the number of months before repayment starts.

classmethod parse_obj(data: Any) → StudentLoanRepaymentModel[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StudentLoanRepaymentModel[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

repayment_months: float

Configures the number of months of repayments before the loan is paid off.

type: str

The only currently supported value for this field is standard.

class plaid2.model.StudentLoanStatus(*, end_date: Optional[str] = None, type: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type

The date until which the loan will be in its current status. Dates are returned in an [ISO 8601](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → StudentLoanStatus[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StudentLoanStatus[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: Optional[str]

The status type of the student loan

class plaid2.model.StudentRepaymentPlan(*, type: Optional[str] = None, description: Optional[str] = None)[source]

Bases: BaseModel

description: Optional[str]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → StudentRepaymentPlan[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StudentRepaymentPlan[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: Optional[str]

The type of the repayment plan.

class plaid2.model.SyncUpdatesAvailableWebhook(*, initial_update_complete: bool, webhook_type: str, item_id: str, historical_update_complete: bool, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

historical_update_complete: bool

Indicates if historical pull information is available.

initial_update_complete: bool

Indicates if initial pull information is available.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → SyncUpdatesAvailableWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → SyncUpdatesAvailableWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

SYNC_UPDATES_AVAILABLE

webhook_type: str

TRANSACTIONS

class plaid2.model.Taxform(*, document_type: str, w_2: Optional[W2] = None, doc_id: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

doc_id: Optional[str]

An identifier of the document referenced by the document metadata.

document_type: str

The type of tax document. Currently, the only supported value is w2.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Taxform[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Taxform[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

w_2: Optional[W2]

W2 is an object that represents income data taken from a W2 tax document.

class plaid2.model.TaxpayerId(*, id_type: Optional[str] = None, id_mask: Optional[str] = None, last_4_digits: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id_mask: Optional[str]

ID mask; i.e. last 4 digits of the taxpayer ID

id_type: Optional[str]

Type of ID, e.g. ‘SSN’

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_4_digits: Optional[str]

Last 4 digits of unique number of ID.

classmethod parse_obj(data: Any) → TaxpayerId[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TaxpayerId[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.Total(*, description: Optional[str] = None, current_pay: Optional[Pay] = None, canonical_description: Optional[str] = None, ytd_pay: Optional[Pay] = None)[source]

Bases: BaseModel

canonical_description: Optional[str]

Commonly used term to describe the line item.

current_pay: Optional[Pay]

An object representing a monetary amount.

description: Optional[str]

Text of the line item as printed on the paystub.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Total[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Total[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

ytd_pay: Optional[Pay]

An object representing a monetary amount.

class plaid2.model.TotalCanonicalDescription(value)[source]

Bases: str, Enum

An enumeration.

bonus = 'BONUS'
commission = 'COMMISSION'
dental = 'DENTAL'
employee_medicare = 'EMPLOYEE MEDICARE'
fica = 'FICA'
medical = 'MEDICAL'
net_pay = 'NET PAY'
not_found = 'NOT_FOUND'
other = 'OTHER'
overtime = 'OVERTIME'
paid_time_off = 'PAID TIME OFF'
regular_pay = 'REGULAR PAY'
social_security_employee_tax = 'SOCIAL SECURITY EMPLOYEE TAX'
taxes = 'TAXES'
vacation = 'VACATION'
vision = 'VISION'
class plaid2.model.TransactionBase(*, pending_transaction_id: Optional[str] = None, account_owner: Optional[str] = None, name: Optional[str] = None, amount: float, check_number: Optional[str] = None, original_description: Optional[str] = None, payment_meta: Optional[PaymentMeta] = None, transaction_type: Optional[str] = None, pending: bool, merchant_name: Optional[str] = None, category_id: Optional[str] = None, account_id: str, date: str, unofficial_currency_code: Optional[str] = None, category: Optional[List[str]] = None, location: Optional[Location] = None, transaction_id: str, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
account_id: str

The ID of the account in which this transaction occurred.

account_owner: Optional[str]

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

amount: float

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.

category: Optional[List[str]]

//plaid.com/docs/api/products/transactions/#categoriesget).

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.

Type

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [/categories/get](https

category_id: Optional[str]

//plaid.com/docs/api/products/transactions/#categoriesget).

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.

Type

The ID of the category to which this transaction belongs. For a full list of categories, see [/categories/get](https

check_number: Optional[str]

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

date: str

//wikipedia.org/wiki/ISO_8601) format ( YYYY-MM-DD ).

Type

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](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

location: Optional[Location]

A representation of where a transaction took place

merchant_name: Optional[str]

The merchant name, as extracted by Plaid from the name field.

name_: Optional[str]

The merchant name or transaction description.

If the transactions object was returned by a Transactions endpoint such as /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.

original_description: Optional[str]

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/get, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set options.include_original_description to true.

classmethod parse_obj(data: Any) → TransactionBase[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionBase[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_meta: Optional[PaymentMeta]

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/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.

pending: bool

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: Optional[str]

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

transaction_id: str

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

transaction_type: Optional[str]

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.

unofficial_currency_code: Optional[str]

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](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

class plaid2.model.TransactionCode(value)[source]

Bases: str, Enum

An enumeration.

adjustment = 'adjustment'
atm = 'atm'
bank_charge = 'bank charge'
bill_payment = 'bill payment'
cash = 'cash'
cashback = 'cashback'
cheque = 'cheque'
direct_debit = 'direct debit'
interest = 'interest'
purchase = 'purchase'
standing_order = 'standing order'
transfer = 'transfer'
class plaid2.model.TransactionData(*, date: str, account_id: str, transaction_id: str, amount: float, description: str)[source]

Bases: BaseModel

account_id: str

A unique identifier for the end user’s account.

amount: float

The amount of the transaction.

date: str

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type

The date of the transaction, in [ISO 8601](https

description: str

The description of the transaction.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionData[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionData[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transaction_id: str

A unique identifier for the transaction.

class plaid2.model.TransactionOverride(*, amount: float, description: str, date_transacted: str, date_posted: str, currency: Optional[str] = None)[source]

Bases: BaseModel

amount: float

The transaction amount. Can be negative.

currency: Optional[str]

The ISO-4217 format currency code for the transaction.

date_posted: str

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Posted dates in the past or present will result in posted transactions; posted dates in the future will result in pending transactions.

Type

The date the transaction posted, in [ISO 8601](https

date_transacted: str

//plaid.com/docs/api/products/transactions/#transactions-get-response-transactions-authorized-date) field.

Type

The date of the transaction, in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. If a date_transacted is not provided by the institution, a transaction date may be available in the [authorized_date](https

description: str

The transaction description.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionOverride[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionOverride[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionStream(*, frequency: str, stream_id: str, is_active: bool, first_date: str, account_id: str, average_amount: TransactionStreamAmount, description: str, category: List[str], transaction_ids: List[str], last_date: str, merchant_name: Optional[str] = None, last_amount: TransactionStreamAmount, status: str, category_id: str, personal_finance_category: Optional[PersonalFinanceCategory] = None)[source]

Bases: BaseModel

account_id: str

The ID of the account to which the stream belongs

average_amount: TransactionStreamAmount

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

category: List[str]

//plaid.com/docs/#category-overview).

Type

A hierarchical array of the categories to which this transaction belongs. See [Categories](https

category_id: str

//plaid.com/docs/#category-overview).

Type

The ID of the category to which this transaction belongs. See [Categories](https

description: str

A description of the transaction stream.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

first_date: str

The posted date of the earliest transaction in the stream.

frequency: str

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.

UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

is_active: bool

Indicates whether the transaction stream is still live.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_amount: TransactionStreamAmount

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

last_date: str

The posted date of the latest transaction in the stream.

merchant_name: Optional[str]

The merchant associated with the transaction stream.

classmethod parse_obj(data: Any) → TransactionStream[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionStream[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

personal_finance_category: Optional[PersonalFinanceCategory]

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](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

status: str

The current status of the transaction stream.

MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence.

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.

stream_id: str

A unique id for the stream

transaction_ids: List[str]

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

class plaid2.model.TransactionStreamAmount(*, unofficial_currency_code: Optional[str] = None, amount: Optional[float] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

amount: Optional[float]

Represents the numerical value of an amount.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

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

See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionStreamAmount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionStreamAmount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

unofficial_currency_code: Optional[str]

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.

class plaid2.model.TransactionStreamStatus(value)[source]

Bases: str, Enum

An enumeration.

early_detection = 'EARLY_DETECTION'
mature = 'MATURE'
tombstoned = 'TOMBSTONED'
unknown = 'UNKNOWN'
class plaid2.model.TransactionsCategoryRule(*, item_id: Optional[str] = None, created_at: Optional[str] = None, personal_finance_category: Optional[str] = None, id: Optional[str] = None, rule_details: Optional[TransactionsRuleDetails] = None)[source]

Bases: BaseModel

created_at: Optional[str]

mm:ssZ` ).

Type

Date and time when a rule was created in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: Optional[str]

A unique identifier of the rule created

item_id: Optional[str]

A unique identifier of the item the rule was created for

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsCategoryRule[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsCategoryRule[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

personal_finance_category: Optional[str]

Personal finance category unique identifier.

In the personal finance category taxonomy, this field is represented by the detailed category field.

rule_details: Optional[TransactionsRuleDetails]

A representation of transactions rule details.

class plaid2.model.TransactionsEnhanceGetRequest(*, account_type: str, transactions: List[ClientProvidedRawTransaction])[source]

Bases: BaseModel

account_type: str

The type of account for the requested transactions (depository or credit).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsEnhanceGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsEnhanceGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transactions: List[ClientProvidedRawTransaction]

An array of raw transactions to be enhanced.

class plaid2.model.TransactionsEnhanceGetResponse(*, enhanced_transactions: List[ClientProvidedEnhancedTransaction])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

enhanced_transactions: List[ClientProvidedEnhancedTransaction]

An array of enhanced transactions.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsEnhanceGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsEnhanceGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionsGetRequest(*, start_date: str, options: Optional[TransactionsGetRequestOptions] = None, access_token: str, end_date: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: str

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

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[TransactionsGetRequestOptions]

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

classmethod parse_obj(data: Any) → TransactionsGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: str

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

class plaid2.model.TransactionsGetRequestOptions(*, include_personal_finance_category: Optional[bool] = None, account_ids: Optional[List[str]] = None, include_personal_finance_category_beta: Optional[bool] = None, offset: Optional[int] = None, include_original_description: Optional[bool] = None, count: Optional[int] = None)[source]

Bases: BaseModel

account_ids: Optional[List[str]]

A list of account_ids to retrieve for the Item

Note: An error will be returned if a provided account_id is not associated with the Item.

count: Optional[int]

The number of transactions to fetch.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_original_description: Optional[bool]

Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.

include_personal_finance_category: Optional[bool]

//plaid.com/docs/api/products/transactions/#transactions-get-response-transactions-personal-finance-category) object in the response.

See the [taxonomy csv file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

We’re introducing Category Rules - a new beta endpoint that will enable you to change the personal_finance_category for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.

Type

Include the [personal_finance_category](https

include_personal_finance_category_beta: Optional[bool]

//plaid.com/docs/api/products/transactions/#transactions-get-request-options-include-personal-finance-category) instead.

Type

Please use [include_personal_finance_category](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

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

classmethod parse_obj(data: Any) → TransactionsGetRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsGetRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionsGetResponse(*, item: Item, total_transactions: int, transactions: List[Transaction], accounts: List[AccountBase], request_id: str)[source]

Bases: BaseModel

accounts: List[AccountBase]

An array containing the accounts associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the account_id field.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item: Item

Metadata about the Item.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

total_transactions: int

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.

transactions: List[Transaction]

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.

class plaid2.model.TransactionsRecurringGetRequest(*, account_ids: List[str], options: Optional[bool] = None, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

account_ids: List[str]

A list of account_ids to retrieve for the Item

Note: An error will be returned if a provided account_id is not associated with the Item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[bool]

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

classmethod parse_obj(data: Any) → TransactionsRecurringGetRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRecurringGetRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionsRecurringGetResponse(*, inflow_streams: List[TransactionStream], outflow_streams: List[TransactionStream], updated_datetime: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

inflow_streams: List[TransactionStream]

An array of depository transaction streams.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

outflow_streams: List[TransactionStream]

An array of expense transaction streams.

classmethod parse_obj(data: Any) → TransactionsRecurringGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRecurringGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

updated_datetime: str

mm:ssZ`) indicating the last time transaction streams for the given account were updated on

Type

Timestamp in [ISO 8601](https

Type

//wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH

class plaid2.model.TransactionsRefreshResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRefreshResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRefreshResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.TransactionsRemovedWebhook(*, error: Optional[Error] = None, removed_transactions: List[str], webhook_type: str, webhook_code: str, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRemovedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRemovedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed_transactions: List[str]

An array of transaction_ids corresponding to the removed transactions

webhook_code: str

TRANSACTIONS_REMOVED

webhook_type: str

TRANSACTIONS

class plaid2.model.TransactionsRuleDetails(*, field: str, type: str, query: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

field: str

Transaction field for which the rule is defined.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRuleDetails[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRuleDetails[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

query: str

For TRANSACTION_ID field, provide transaction_id. For NAME field, provide a string pattern.

type: str

Transaction rule’s match type. For TRANSACTION_ID field, EXACT_MATCH is available. Matches are case sensitive.

class plaid2.model.TransactionsRuleField(value)[source]

Bases: str, Enum

An enumeration.

name_ = 'NAME'
transaction_id = 'TRANSACTION_ID'
class plaid2.model.TransactionsRuleType(value)[source]

Bases: str, Enum

An enumeration.

exact_match = 'EXACT_MATCH'
substring_match = 'SUBSTRING_MATCH'
class plaid2.model.TransactionsRulesCreateRequest(*, personal_finance_category: str, access_token: str, rule_details: TransactionsRuleDetails)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRulesCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRulesCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

personal_finance_category: str

Personal finance detailed category.

See the [taxonomy csv file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

rule_details: TransactionsRuleDetails

A representation of transactions rule details.

class plaid2.model.TransactionsRulesCreateResponse(*, request_id: str, rule: TransactionsCategoryRule)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRulesCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRulesCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

rule: TransactionsCategoryRule

A representation of a transactions category rule.

class plaid2.model.TransactionsRulesListResponse(*, rules: List[TransactionsCategoryRule], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRulesListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRulesListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

rules: List[TransactionsCategoryRule]

A list of the Item’s transaction rules

class plaid2.model.TransactionsRulesRemoveRequest(*, access_token: str, rule_id: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRulesRemoveRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRulesRemoveRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

rule_id: str

A rule’s unique identifier

class plaid2.model.TransactionsRulesRemoveResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsRulesRemoveResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsRulesRemoveResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.TransactionsSyncRequest(*, options: Optional[TransactionsSyncRequestOptions] = None, cursor: Optional[str] = None, count: Optional[int] = None, access_token: str)[source]

Bases: BaseModel

access_token: str

The access token associated with the Item data is being requested for.

count: Optional[int]

The number of transaction updates to fetch.

cursor: Optional[str]

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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

options: Optional[TransactionsSyncRequestOptions]

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

classmethod parse_obj(data: Any) → TransactionsSyncRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsSyncRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionsSyncRequestOptions(*, include_original_description: Optional[bool] = None, include_personal_finance_category: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_original_description: Optional[bool]

Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.

include_personal_finance_category: Optional[bool]

//plaid.com/docs/api/products/transactions/#transactions-sync-response-added-personal-finance-category) object in the response.

See the [taxonomy csv file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

We’re introducing Category Rules - a new beta endpoint that will enable you to change the personal_finance_category for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.

Type

Include the [personal_finance_category](https

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransactionsSyncRequestOptions[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsSyncRequestOptions[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransactionsSyncResponse(*, has_more: bool, removed: List[RemovedTransaction], modified: List[Transaction], added: List[Transaction], next_cursor: str, request_id: str)[source]

Bases: BaseModel

added: List[Transaction]

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

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

has_more: bool

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.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

modified: List[Transaction]

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

next_cursor: str

Cursor used for fetching any future updates after the latest update provided in this response.

classmethod parse_obj(data: Any) → TransactionsSyncResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransactionsSyncResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

removed: List[RemovedTransaction]

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

request_id: str

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

class plaid2.model.Transfer(*, cancellable: bool, guarantee_decision: Optional[str] = None, failure_reason: Optional[TransferFailure] = None, iso_currency_code: str, network: str, ach_class: str, status: str, account_id: str, description: str, id: str, origination_account_id: str, created: str, amount: str, guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale] = None, user: TransferUserInResponse, sweep_status: Optional[str] = None, metadata: Optional[TransferMetadata] = None, type: str)[source]

Bases: BaseModel

account_id: str

The account ID that should be credited/debited for this transfer.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

cancellable: bool

When true, you can still cancel this transfer.

created: str

05Z`

Type

The datetime when this transfer was created. This will be of the form `2006-01-02T15

Type

04

description: str

The description of the transfer.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

failure_reason: Optional[TransferFailure]

The failure reason if the event type for a transfer is “failed” or “returned”. Null value otherwise.

guarantee_decision: Optional[str]

Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale]

The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

id: str

Plaid’s unique identifier for a transfer.

iso_currency_code: str

The currency of the transfer amount, e.g. “USD”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[TransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str

45 PM Pacific Time. It is recommended to submit a transfer at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any transfer that is indicated as same-day-ach and that misses the same-day cutoff, but is submitted in time for the next-day cutoff, will be sent over next-day rails and will not incur same-day charges. Note that both legs of the transfer will be downgraded if applicable.

Type

The network or rails used for the transfer. Valid options are ach or same-day-ach. The cutoff for same-day transfers is 7

Type

45 AM Pacific Time and the cutoff for next-day transfers is 5

origination_account_id: str

Plaid’s unique identifier for the origination account that was used for this transfer.

classmethod parse_obj(data: Any) → Transfer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Transfer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

status: str

The status of the transfer.

sweep_status: Optional[str]

The status of the sweep for the transfer. unswept: The transfer hasn’t been swept yet. swept: The transfer was swept to the sweep account. return_swept: The transfer was returned, funds were pulled back or pushed back to the sweep account. null: The transfer will never be swept (e.g. if the transfer is cancelled or returned before being swept)

type: str

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: TransferUserInResponse

The legal name and other information for the account holder.

class plaid2.model.TransferAuthorization(*, decision_rationale: Optional[TransferAuthorizationDecisionRationale] = None, guarantee_decision: Optional[str] = None, id: str, guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale] = None, decision: str, proposed_transfer: TransferAuthorizationProposedTransfer, created: str)[source]

Bases: BaseModel

created: str

05Z`.

Type

The datetime representing when the authorization was created, in the format `2006-01-02T15

Type

04

decision: str

A decision regarding the proposed transfer.

approved – The proposed transfer has received the end user’s consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended (i.e., use Link in update to re-authenticate your user when decision_rationale.code is LOGIN_REQUIRED). Refer to the code field in the decision_rationale object for details.

declined – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.

decision_rationale: Optional[TransferAuthorizationDecisionRationale]

The rationale for Plaid’s decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

guarantee_decision: Optional[str]

Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale]

The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

id: str

Plaid’s unique identifier for a transfer authorization.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferAuthorization[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorization[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

proposed_transfer: TransferAuthorizationProposedTransfer

Details regarding the proposed transfer.

class plaid2.model.TransferAuthorizationCreateRequest(*, user_present: Optional[bool] = None, type: str, access_token: Optional[str] = None, network: str, user: TransferAuthorizationUserInRequest, payment_profile_id: Optional[str] = None, amount: str, ach_class: str, account_id: Optional[str] = None, device: Optional[TransferAuthorizationDevice] = None, origination_account_id: Optional[str] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The Plaid access_token for the account that will be debited or credited.

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

device: Optional[TransferAuthorizationDevice]

Information about the device being used to initiate the authorization.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

The currency of the transfer amount. The default value is “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

network: str

45 PM Pacific Time. It is recommended to submit a transfer at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any transfer that is indicated as same-day-ach and that misses the same-day cutoff, but is submitted in time for the next-day cutoff, will be sent over next-day rails and will not incur same-day charges. Note that both legs of the transfer will be downgraded if applicable.

Type

The network or rails used for the transfer. Valid options are ach or same-day-ach. The cutoff for same-day transfers is 7

Type

45 AM Pacific Time and the cutoff for next-day transfers is 5

origination_account_id: Optional[str]

Plaid’s unique identifier for the origination account for this authorization. If not specified, the default account will be used.

classmethod parse_obj(data: Any) → TransferAuthorizationCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_profile_id: Optional[str]

Plaid’s unique identifier for a payment profile.

type: str

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: TransferAuthorizationUserInRequest

The legal name and other information for the account holder.

user_present: Optional[bool]

Required for guaranteed ACH customers. If the end user is initiating the specific transfer themselves via an interactive UI, this should be true; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false.

class plaid2.model.TransferAuthorizationCreateResponse(*, request_id: str, authorization: TransferAuthorization)[source]

Bases: BaseModel

authorization: TransferAuthorization

Contains the authorization decision for a proposed transfer

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferAuthorizationCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.TransferAuthorizationDecision(value)[source]

Bases: str, Enum

An enumeration.

approved = 'approved'
declined = 'declined'
class plaid2.model.TransferAuthorizationDecisionRationale(*, description: str, code: str)[source]

Bases: BaseModel

code: str

A code representing the rationale for approving or declining the proposed transfer. Possible values are:

MANUALLY_VERIFIED_ITEM – Item created via same-day micro deposits, limited information available. Plaid will offer approved as a transaction decision.

LOGIN_REQUIRED – Unable to collect the account information due to Item staleness. Can be rectified using Link in update mode. Plaid will offer approved as a transaction decision.

ERROR – Unable to collect the account information due to an error. Plaid will offer approved as a transaction decision.

NSF – Transaction likely to result in a return due to insufficient funds. Plaid will offer declined as a transaction decision.

RISK - Transaction is high-risk. Plaid will offer declined as a transaction decision.

TRANSFER_LIMIT_REACHED - One or several transfer limits are reached, e.g. monthly transfer limit. Plaid will offer declined as a transaction decision.

description: str

A human-readable description of the code associated with a transfer approval or transfer decline.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferAuthorizationDecisionRationale[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationDecisionRationale[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferAuthorizationDecisionRationaleCode(value)[source]

Bases: str, Enum

An enumeration.

error = 'ERROR'
login_required = 'LOGIN_REQUIRED'
manually_verified_item = 'MANUALLY_VERIFIED_ITEM'
nsf = 'NSF'
risk = 'RISK'
transfer_limit_reached = 'TRANSFER_LIMIT_REACHED'
class plaid2.model.TransferAuthorizationDevice(*, ip_address: Optional[str] = None, user_agent: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

ip_address: Optional[str]

The IP address of the device being used to initiate the authorization. Required for guaranteed ACH customers.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferAuthorizationDevice[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationDevice[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

user_agent: Optional[str]

The user agent of the device being used to initiate the authorization. Required for guaranteed ACH customers.

class plaid2.model.TransferAuthorizationGuaranteeDecision(value)[source]

Bases: str, Enum

An enumeration.

guaranteed = 'GUARANTEED'
not_guaranteed = 'NOT_GUARANTEED'
class plaid2.model.TransferAuthorizationGuaranteeDecisionRationale(*, code: str, description: str)[source]

Bases: BaseModel

code: str

A code representing the reason Plaid declined to guarantee this transfer:

RETURN_BANK: The risk of a bank-initiated return (for example, an R01/NSF) is too high to guarantee this transfer.

RETURN_CUSTOMER: The risk of a customer-initiated return (for example, a R10/Unauthorized) is too high to guarantee this transfer.

GUARANTEE_LIMIT_REACHED: This transfer is low-risk, but Guaranteed ACH has exhausted an internal limit on the number or rate of guarantees that applies to this transfer.

RISK_ESTIMATE_UNAVAILABLE: A risk estimate is unavailable for this Item.

REQUIRED_PARAM_MISSING: Required fields are missing.

description: str

A human-readable description of why the transfer cannot be guaranteed.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferAuthorizationGuaranteeDecisionRationale[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationGuaranteeDecisionRationale[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferAuthorizationGuaranteeDecisionRationaleCode(value)[source]

Bases: str, Enum

An enumeration.

guarantee_limit_reached = 'GUARANTEE_LIMIT_REACHED'
required_param_missing = 'REQUIRED_PARAM_MISSING'
return_bank = 'RETURN_BANK'
return_customer = 'RETURN_CUSTOMER'
risk_estimate_unavailable = 'RISK_ESTIMATE_UNAVAILABLE'
class plaid2.model.TransferAuthorizationProposedTransfer(*, user: TransferUserInResponse, network: str, iso_currency_code: str, ach_class: str, account_id: str, type: str, amount: str, origination_account_id: str)[source]

Bases: BaseModel

account_id: str

The Plaid account_id for the account that will be debited or credited.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

The currency of the transfer amount. The default value is “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

network: str

The network or rails used for the transfer.

origination_account_id: str

Plaid’s unique identifier for the origination account that was used for this transfer.

classmethod parse_obj(data: Any) → TransferAuthorizationProposedTransfer[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationProposedTransfer[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: str

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: TransferUserInResponse

The legal name and other information for the account holder.

class plaid2.model.TransferAuthorizationUserInRequest(*, address: Optional[TransferUserAddressInRequest] = None, legal_name: str, email_address: Optional[str] = None, phone_number: Optional[str] = None)[source]

Bases: BaseModel

address: Optional[TransferUserAddressInRequest]

The address associated with the account holder. Providing this data will improve the likelihood that Plaid will be able to guarantee the transfer, if applicable.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address. In order to qualify for a guaranteed transfer, at least one of phone_number or email_address must be provided.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The user’s legal name.

classmethod parse_obj(data: Any) → TransferAuthorizationUserInRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferAuthorizationUserInRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

The user’s phone number. In order to qualify for a guaranteed transfer, at least one of phone_number or email_address must be provided.

class plaid2.model.TransferCancelResponse(*, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferCancelResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferCancelResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.TransferCreateRequest(*, origination_account_id: Optional[str] = None, ach_class: str, network: str, authorization_id: str, metadata: Optional[TransferMetadata] = None, type: str, access_token: Optional[str] = None, description: str, idempotency_key: Optional[str] = None, account_id: Optional[str] = None, user: TransferUserInRequest, iso_currency_code: Optional[str] = None, amount: str, payment_profile_id: Optional[str] = None)[source]

Bases: BaseModel

access_token: Optional[str]

The Plaid access_token for the account that will be debited or credited.

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

authorization_id: str

Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.

description: str

The transfer description. Maximum of 10 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: Optional[str]

Deprecated. authorization_id is now used as idempotency instead.

A random key provided by the client, per unique transfer. Maximum of 50 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.

iso_currency_code: Optional[str]

The currency of the transfer amount. The default value is “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[TransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

network: str

45 PM Pacific Time. It is recommended to submit a transfer at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any transfer that is indicated as same-day-ach and that misses the same-day cutoff, but is submitted in time for the next-day cutoff, will be sent over next-day rails and will not incur same-day charges. Note that both legs of the transfer will be downgraded if applicable.

Type

The network or rails used for the transfer. Valid options are ach or same-day-ach. The cutoff for same-day transfers is 7

Type

45 AM Pacific Time and the cutoff for next-day transfers is 5

origination_account_id: Optional[str]

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.

classmethod parse_obj(data: Any) → TransferCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_profile_id: Optional[str]

Plaid’s unique identifier for a payment profile.

type: str

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

user: TransferUserInRequest

The legal name and other information for the account holder.

class plaid2.model.TransferCreateResponse(*, transfer: Transfer, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer: Transfer

Represents a transfer within the Transfers API.

class plaid2.model.TransferEvent(*, transfer_amount: str, event_id: int, transfer_type: str, event_type: str, timestamp: str, failure_reason: Optional[TransferFailure] = None, account_id: str, sweep_amount: Optional[str] = None, sweep_id: Optional[str] = None, transfer_id: str, origination_account_id: Optional[str] = None)[source]

Bases: BaseModel

account_id: str

The account ID associated with the transfer.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

event_id: int

Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.

event_type: str

The type of event that this transfer represents.

pending: A new transfer was created; it is in the pending state.

cancelled: The transfer was cancelled by the client.

failed: The transfer failed, no funds were moved.

posted: The transfer has been successfully submitted to the payment network.

returned: A posted transfer was returned.

swept: The transfer was swept to / from the sweep account.

return_swept: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account.

failure_reason: Optional[TransferFailure]

The failure reason if the event type for a transfer is “failed” or “returned”. Null value otherwise.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

origination_account_id: Optional[str]

The ID of the origination account that this balance belongs to.

classmethod parse_obj(data: Any) → TransferEvent[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEvent[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

sweep_amount: Optional[str]

A signed amount of how much was swept or return_swept (decimal string with two digits of precision e.g. “-5.50”).

sweep_id: Optional[str]

Plaid’s unique identifier for a sweep.

timestamp: str

05Z`.

Type

The datetime when this event occurred. This will be of the form `2006-01-02T15

Type

04

transfer_amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

transfer_id: str

Plaid’s unique identifier for a transfer.

transfer_type: str

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.

class plaid2.model.TransferEventListRequest(*, end_date: Optional[str] = None, sweep_id: Optional[str] = None, count: Optional[int] = None, event_types: Optional[List[str]] = None, origination_account_id: Optional[str] = None, start_date: Optional[str] = None, transfer_id: Optional[str] = None, offset: Optional[int] = None, account_id: Optional[str] = None, transfer_type: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

The account ID to get events for all transactions to/from an account.

count: Optional[int]

The maximum number of transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

49Z`)

Type

The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

event_types: Optional[List[str]]

Filter events by event type.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The offset into the list of transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned.

origination_account_id: Optional[str]

The origination account ID to get events for transfers from a specific origination account.

classmethod parse_obj(data: Any) → TransferEventListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEventListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

49Z`)

Type

The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

sweep_id: Optional[str]

Plaid’s unique identifier for a sweep.

transfer_id: Optional[str]

Plaid’s unique identifier for a transfer.

transfer_type: Optional[str]

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.

class plaid2.model.TransferEventListResponse(*, request_id: str, transfer_events: List[TransferEvent])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferEventListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEventListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer_events: List[TransferEvent]
class plaid2.model.TransferEventListTransferType(value)[source]

Bases: str, Enum

An enumeration.

credit = 'credit'
debit = 'debit'
class plaid2.model.TransferEventSyncRequest(*, after_id: int, count: Optional[int] = None)[source]

Bases: BaseModel

after_id: int

The latest (largest) event_id fetched via the sync endpoint, or 0 initially.

count: Optional[int]

The maximum number of transfer events to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferEventSyncRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEventSyncRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferEventSyncResponse(*, transfer_events: List[TransferEvent], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferEventSyncResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEventSyncResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer_events: List[TransferEvent]
class plaid2.model.TransferEventType(value)[source]

Bases: str, Enum

An enumeration.

cancelled = 'cancelled'
failed = 'failed'
pending = 'pending'
posted = 'posted'
return_swept = 'return_swept'
returned = 'returned'
reverse_swept = 'reverse_swept'
swept = 'swept'
class plaid2.model.TransferEventsUpdateWebhook(*, webhook_type: str, webhook_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferEventsUpdateWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferEventsUpdateWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

TRANSFER_EVENTS_UPDATE

webhook_type: str

TRANSFER

class plaid2.model.TransferFailure(*, ach_return_code: Optional[str] = None, description: Optional[str] = None)[source]

Bases: BaseModel

ach_return_code: Optional[str]

//plaid.com/docs/errors/transfer/#ach-return-codes).

Type

The ACH return code, e.g. R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see [Transfer errors](https

description: Optional[str]

A human-readable description of the reason for the failure or reversal.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferFailure[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferFailure[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferGetResponse(*, transfer: Transfer, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer: Transfer

Represents a transfer within the Transfers API.

class plaid2.model.TransferIntentAuthorizationDecision(value)[source]

Bases: str, Enum

An enumeration.

approved = 'APPROVED'
declined = 'DECLINED'
class plaid2.model.TransferIntentCreate(*, id: str, ach_class: str, account_id: Optional[str] = None, created: str, description: str, status: str, amount: str, origination_account_id: str, user: TransferUserInResponse, metadata: Optional[TransferMetadata] = None, require_guarantee: Optional[bool] = None, iso_currency_code: str, mode: str)[source]

Bases: BaseModel

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

created: str

05Z`.

Type

The datetime the transfer was created. This will be of the form `2006-01-02T15

Type

04

description: str

A description for the underlying transfer. Maximum of 8 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

Plaid’s unique identifier for the transfer intent object.

iso_currency_code: str

The currency of the transfer amount, e.g. “USD”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[TransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

mode: str

The direction of the flow of transfer funds.

  • PAYMENT – Transfers funds from an end user’s account to your business account.

  • DISBURSEMENT – Transfers funds from your business account to an end user’s account.

origination_account_id: str

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.

classmethod parse_obj(data: Any) → TransferIntentCreate[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentCreate[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

require_guarantee: Optional[bool]

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guaranteed ACH customers only).

status: str

The status of the transfer intent.

  • PENDING – The transfer intent is pending.

  • SUCCEEDED – The transfer intent was successfully created.

  • FAILED – The transfer intent was unable to be created.

user: TransferUserInResponse

The legal name and other information for the account holder.

class plaid2.model.TransferIntentCreateMode(value)[source]

Bases: str, Enum

An enumeration.

disbursement = 'DISBURSEMENT'
payment = 'PAYMENT'
class plaid2.model.TransferIntentCreateRequest(*, account_id: Optional[str] = None, require_guarantee: Optional[bool] = None, mode: str, description: str, origination_account_id: Optional[str] = None, amount: str, metadata: Optional[TransferMetadata] = None, iso_currency_code: Optional[str] = None, user: TransferUserInRequest, ach_class: str)[source]

Bases: BaseModel

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

description: str

A description for the underlying transfer. Maximum of 8 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

The currency of the transfer amount, e.g. “USD”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[TransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

mode: str

The direction of the flow of transfer funds.

  • PAYMENT – Transfers funds from an end user’s account to your business account.

  • DISBURSEMENT – Transfers funds from your business account to an end user’s account.

origination_account_id: Optional[str]

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.

classmethod parse_obj(data: Any) → TransferIntentCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

require_guarantee: Optional[bool]

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guaranteed ACH customers only).

user: TransferUserInRequest

The legal name and other information for the account holder.

class plaid2.model.TransferIntentCreateResponse(*, transfer_intent: TransferIntentCreate, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferIntentCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer_intent: TransferIntentCreate

Represents a transfer intent within Transfer UI.

class plaid2.model.TransferIntentGet(*, failure_reason: Optional[TransferIntentGetFailureReason] = None, amount: str, user: TransferUserInResponse, iso_currency_code: str, require_guarantee: Optional[bool] = None, guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale] = None, origination_account_id: str, guarantee_decision: Optional[str] = None, created: str, authorization_decision: Optional[str] = None, mode: str, status: str, authorization_decision_rationale: Optional[TransferAuthorizationDecisionRationale] = None, description: str, metadata: Optional[TransferMetadata] = None, transfer_id: Optional[str] = None, account_id: Optional[str] = None, id: str, ach_class: str)[source]

Bases: BaseModel

account_id: Optional[str]

The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.

ach_class: str

Specifies the use case of the transfer. Required for transfers on an ACH network.

“ccd” - Corporate Credit or Debit - fund transfer between two corporate bank accounts

“ppd” - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

“tel” - Telephone-Initiated Entry

“web” - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

amount: str

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).

authorization_decision: Optional[str]

A decision regarding the proposed transfer.

APPROVED – The proposed transfer has received the end user’s consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended (i.e., use Link in update to re-authenticate your user when decision_rationale.code is LOGIN_REQUIRED). Refer to the code field in the decision_rationale object for details.

DECLINED – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.

authorization_decision_rationale: Optional[TransferAuthorizationDecisionRationale]

The rationale for Plaid’s decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.

created: str

05Z`.

Type

The datetime the transfer was created. This will be of the form `2006-01-02T15

Type

04

description: str

A description for the underlying transfer. Maximum of 8 characters.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

failure_reason: Optional[TransferIntentGetFailureReason]

The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.

guarantee_decision: Optional[str]

Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

guarantee_decision_rationale: Optional[TransferAuthorizationGuaranteeDecisionRationale]

The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

id: str

Plaid’s unique identifier for a transfer intent object.

iso_currency_code: str

The currency of the transfer amount, e.g. “USD”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

metadata: Optional[TransferMetadata]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters

mode: str

The direction of the flow of transfer funds.

  • PAYMENT – Transfers funds from an end user’s account to your business account.

  • DISBURSEMENT – Transfers funds from your business account to an end user’s account.

origination_account_id: str

Plaid’s unique identifier for the origination account used for the transfer.

classmethod parse_obj(data: Any) → TransferIntentGet[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentGet[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

require_guarantee: Optional[bool]

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guaranteed ACH customers only).

status: str

The status of the transfer intent.

  • PENDING – The transfer intent is pending.

  • SUCCEEDED – The transfer intent was successfully created.

  • FAILED – The transfer intent was unable to be created.

transfer_id: Optional[str]

Plaid’s unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.

user: TransferUserInResponse

The legal name and other information for the account holder.

class plaid2.model.TransferIntentGetFailureReason(*, error_message: Optional[str] = None, error_type: Optional[str] = None, error_code: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error_code: Optional[str]

A code representing the reason for a failed transfer intent (i.e., an API error or the authorization being declined).

For a full listing of bank transfer errors, see [Bank Transfers errors](https://plaid.com/docs/errors/bank-transfers/).

error_message: Optional[str]

A human-readable description of the code associated with a failed transfer intent.

error_type: Optional[str]

A broad categorization of the error.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferIntentGetFailureReason[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentGetFailureReason[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferIntentGetResponse(*, request_id: str, transfer_intent: TransferIntentGet)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferIntentGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferIntentGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfer_intent: TransferIntentGet

Represents a transfer intent within Transfer UI.

class plaid2.model.TransferIntentStatus(value)[source]

Bases: str, Enum

An enumeration.

failed = 'FAILED'
pending = 'PENDING'
succeeded = 'SUCCEEDED'
class plaid2.model.TransferListRequest(*, origination_account_id: Optional[str] = None, end_date: Optional[str] = None, start_date: Optional[str] = None, count: Optional[int] = None, offset: Optional[int] = None)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of transfers to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

49Z`)

Type

The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of transfers to skip before returning results.

origination_account_id: Optional[str]

Filter transfers to only those originated through the specified origination account.

classmethod parse_obj(data: Any) → TransferListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

49Z`)

Type

The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22

Type

35

class plaid2.model.TransferListResponse(*, transfers: List[Transfer], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transfers: List[Transfer]
class plaid2.model.TransferMetadata[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferMetadata[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferMetadata[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferMigrateAccountRequest(*, account_number: str, wire_routing_number: Optional[str] = None, account_type: str, routing_number: str)[source]

Bases: BaseModel

account_number: str

The user’s account number.

account_type: str

The type of the bank account (checking or savings).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferMigrateAccountRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferMigrateAccountRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

routing_number: str

The user’s routing number.

wire_routing_number: Optional[str]

The user’s wire transfer routing number. This is the ABA number; for some institutions, this may differ from the ACH number used in routing_number.

class plaid2.model.TransferMigrateAccountResponse(*, access_token: str, account_id: str, request_id: str)[source]

Bases: BaseModel

access_token: str

The Plaid access_token for the newly created Item.

account_id: str

The Plaid account_id for the newly created Item.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferMigrateAccountResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferMigrateAccountResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.TransferNetwork(value)[source]

Bases: str, Enum

An enumeration.

ach = 'ach'
same_day_ach = 'same-day-ach'
class plaid2.model.TransferRepayment(*, repayment_id: str, created: str, iso_currency_code: str, amount: str)[source]

Bases: BaseModel

amount: str

Decimal amount of the repayment as it appears on your account ledger.

created: str

The datetime when the repayment occurred, in RFC 3339 format.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

The currency of the repayment, e.g. “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferRepayment[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepayment[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

repayment_id: str

Identifier of the repayment.

class plaid2.model.TransferRepaymentListRequest(*, count: Optional[int] = None, end_date: Optional[str] = None, offset: Optional[int] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of repayments to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

The end datetime of repayments to return (RFC 3339 format).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of repayments to skip before returning results.

classmethod parse_obj(data: Any) → TransferRepaymentListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepaymentListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

The start datetime of repayments to return (RFC 3339 format).

class plaid2.model.TransferRepaymentListResponse(*, request_id: str, repayments: List[TransferRepayment])[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferRepaymentListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepaymentListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

repayments: List[TransferRepayment]
request_id: str

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

class plaid2.model.TransferRepaymentReturn(*, iso_currency_code: str, transfer_id: str, event_id: int, amount: str)[source]

Bases: BaseModel

amount: str

The value of the returned transfer.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

event_id: int

The unique identifier of the corresponding returned transfer event.

iso_currency_code: str

The currency of the repayment, e.g. “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferRepaymentReturn[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepaymentReturn[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

transfer_id: str

The unique identifier of the guaranteed transfer that was returned.

class plaid2.model.TransferRepaymentReturnListRequest(*, offset: Optional[int] = None, count: Optional[int] = None, repayment_id: str)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of repayments to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of repayments to skip before returning results.

classmethod parse_obj(data: Any) → TransferRepaymentReturnListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepaymentReturnListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

repayment_id: str

Identifier of the repayment to query.

class plaid2.model.TransferRepaymentReturnListResponse(*, repayment_returns: List[TransferRepaymentReturn], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferRepaymentReturnListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferRepaymentReturnListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

repayment_returns: List[TransferRepaymentReturn]
request_id: str

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

class plaid2.model.TransferStatus(value)[source]

Bases: str, Enum

An enumeration.

cancelled = 'cancelled'
failed = 'failed'
pending = 'pending'
posted = 'posted'
returned = 'returned'
class plaid2.model.TransferSweep(*, created: str, amount: str, id: str, iso_currency_code: str)[source]

Bases: BaseModel

amount: str

Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. “-10.00”)

If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.

created: str

The datetime when the sweep occurred, in RFC 3339 format.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

Identifier of the sweep.

iso_currency_code: str

The currency of the sweep, e.g. “USD”.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferSweep[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferSweep[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.TransferSweepGetResponse(*, sweep: TransferSweep, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferSweepGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferSweepGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

sweep: TransferSweep

Describes a sweep of funds to / from the sweep account.

A sweep is associated with many sweep events (events of type swept or return_swept) which can be retrieved by invoking the /transfer/event/list endpoint with the corresponding sweep_id.

swept events occur when the transfer amount is credited or debited from your sweep account, depending on the type of the transfer. return_swept events occur when a transfer is returned and Plaid undoes the credit or debit.

The total sum of the swept and return_swept events is equal to the amount of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.

class plaid2.model.TransferSweepListRequest(*, end_date: Optional[str] = None, offset: Optional[int] = None, start_date: Optional[str] = None, count: Optional[int] = None)[source]

Bases: BaseModel

count: Optional[int]

The maximum number of sweeps to return.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

end_date: Optional[str]

The end datetime of sweeps to return (RFC 3339 format).

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

offset: Optional[int]

The number of sweeps to skip before returning results.

classmethod parse_obj(data: Any) → TransferSweepListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferSweepListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

start_date: Optional[str]

The start datetime of sweeps to return (RFC 3339 format).

class plaid2.model.TransferSweepListResponse(*, sweeps: List[TransferSweep], request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferSweepListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferSweepListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

sweeps: List[TransferSweep]
class plaid2.model.TransferSweepStatus(value)[source]

Bases: str, Enum

An enumeration.

return_swept = 'return_swept'
reverse_swept = 'reverse_swept'
swept = 'swept'
unswept = 'unswept'
class plaid2.model.TransferType(value)[source]

Bases: str, Enum

An enumeration.

credit = 'credit'
debit = 'debit'
class plaid2.model.TransferUserAddressInRequest(*, postal_code: Optional[str] = None, region: Optional[str] = None, country: Optional[str] = None, street: Optional[str] = None, city: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

Ex. “San Francisco”

country: Optional[str]

A two-letter country code (e.g., “US”).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferUserAddressInRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferUserAddressInRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code (e.g., “94103”).

region: Optional[str]

The state or province (e.g., “CA”).

street: Optional[str]

The street number and name (i.e., “100 Market St.”).

class plaid2.model.TransferUserAddressInResponse(*, country: Optional[str] = None, city: Optional[str] = None, postal_code: Optional[str] = None, region: Optional[str] = None, street: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

Ex. “San Francisco”

country: Optional[str]

A two-letter country code (e.g., “US”).

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → TransferUserAddressInResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferUserAddressInResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code (e.g., “94103”).

region: Optional[str]

The state or province (e.g., “CA”).

street: Optional[str]

The street number and name (i.e., “100 Market St.”).

class plaid2.model.TransferUserInRequest(*, legal_name: str, address: Optional[TransferUserAddressInRequest] = None, email_address: Optional[str] = None, phone_number: Optional[str] = None)[source]

Bases: BaseModel

address: Optional[TransferUserAddressInRequest]

The address associated with the account holder. Providing this data will improve the likelihood that Plaid will be able to guarantee the transfer, if applicable.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The user’s legal name.

classmethod parse_obj(data: Any) → TransferUserInRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferUserInRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

The user’s phone number.

class plaid2.model.TransferUserInResponse(*, address: Optional[TransferUserAddressInResponse] = None, email_address: Optional[str] = None, phone_number: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

address: Optional[TransferUserAddressInResponse]

The address associated with the account holder.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

email_address: Optional[str]

The user’s email address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The user’s legal name.

classmethod parse_obj(data: Any) → TransferUserInResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → TransferUserInResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]

The user’s phone number.

class plaid2.model.UpdateEntityScreeningRequest(*, status: Optional[str] = None, entity_watchlist_screening_id: str, assignee: Optional[str] = None, search_terms: Optional[UpdateEntityScreeningRequestSearchTerms] = None, client_user_id: Optional[str] = None, reset_fields: Optional[List[str]] = None)[source]

Bases: BaseModel

assignee: Optional[str]
client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

entity_watchlist_screening_id: str

ID of the associated entity screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UpdateEntityScreeningRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UpdateEntityScreeningRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

reset_fields: Optional[List[str]]

A list of fields to reset back to null

search_terms: Optional[UpdateEntityScreeningRequestSearchTerms]

Search terms for editing an entity watchlist screening

status: Optional[str]
class plaid2.model.UpdateEntityScreeningRequestResettableField(value)[source]

Bases: str, Enum

An enumeration.

assignee = 'assignee'
class plaid2.model.UpdateEntityScreeningRequestSearchTerms(*, url: Optional[str] = None, phone_number: Optional[str] = None, entity_watchlist_program_id: str, legal_name: Optional[str] = None, document_number: Optional[str] = None, email_address: Optional[str] = None, country: Optional[str] = None)[source]

Bases: BaseModel

country: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
email_address: Optional[str]
entity_watchlist_program_id: str

ID of the associated entity program.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: Optional[str]
classmethod parse_obj(data: Any) → UpdateEntityScreeningRequestSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UpdateEntityScreeningRequestSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

phone_number: Optional[str]
url: Optional[str]
class plaid2.model.UpdateIndividualScreeningRequest(*, watchlist_screening_id: str, search_terms: Optional[UpdateIndividualScreeningRequestSearchTerms] = None, assignee: Optional[str] = None, status: Optional[str] = None, reset_fields: Optional[List[str]] = None, client_user_id: Optional[str] = None)[source]

Bases: BaseModel

assignee: Optional[str]
client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UpdateIndividualScreeningRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UpdateIndividualScreeningRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

reset_fields: Optional[List[str]]

A list of fields to reset back to null

search_terms: Optional[UpdateIndividualScreeningRequestSearchTerms]

Search terms for editing an individual watchlist screening

status: Optional[str]
watchlist_screening_id: str

ID of the associated screening.

class plaid2.model.UpdateIndividualScreeningRequestResettableField(value)[source]

Bases: str, Enum

An enumeration.

assignee = 'assignee'
class plaid2.model.UpdateIndividualScreeningRequestSearchTerms(*, date_of_birth: Optional[str] = None, legal_name: Optional[str] = None, document_number: Optional[str] = None, watchlist_program_id: Optional[str] = None, country: Optional[str] = None)[source]

Bases: BaseModel

country: Optional[str]
date_of_birth: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: Optional[str]
classmethod parse_obj(data: Any) → UpdateIndividualScreeningRequestSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UpdateIndividualScreeningRequestSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_program_id: Optional[str]
class plaid2.model.UserAddress(*, street: str, city: str, country: str, region: str, street_2: Optional[str] = None, postal_code: str)[source]

Bases: BaseModel

city: str

City from the end user’s address

country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UserAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: str

The postal code for the associated address. Between 2 and 10 alphanumeric characters.

region: str

An ISO 3166-2 subdivision code. Related terms would be “state”, “province”, “prefecture”, “zone”, “subdivision”, etc.

street: str

The primary street portion of an address. If the user has submitted their address, this field will always be filled.

street_2: Optional[str]

Extra street information, like an apartment or suite number.

class plaid2.model.UserCreateResponse(*, request_id: str, user_token: str, user_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UserCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

user_id: str

The Plaid user_id of the User associated with this webhook, warning, or error.

user_token: str

The user token associated with the User data is being requested for.

class plaid2.model.UserCustomPassword(*, mfa: Mfa, override_accounts: List[OverrideAccounts], force_error: str, version: Optional[str] = None, recaptcha: str, seed: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

force_error: str

An error code to force on Item creation. Possible values are:

“INSTITUTION_NOT_RESPONDING” “INSTITUTION_NO_LONGER_SUPPORTED” “INVALID_CREDENTIALS” “INVALID_MFA” “ITEM_LOCKED” “ITEM_LOGIN_REQUIRED” “ITEM_NOT_SUPPORTED” “INVALID_LINK_TOKEN” “MFA_NOT_SUPPORTED” “NO_ACCOUNTS” “PLAID_ERROR” “USER_SETUP_REQUIRED”

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

mfa: Mfa

Specifies the multi-factor authentication settings to use with this test account

override_accounts: List[OverrideAccounts]

An array of account overrides to configure the accounts for the Item. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data.

classmethod parse_obj(data: Any) → UserCustomPassword[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserCustomPassword[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

recaptcha: str

You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field. Possible values are good or bad. A value of good will result in successful Item creation and bad will result in a RECAPTCHA_BAD error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link.

seed: str

A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the override_accounts argument. If no seed is specified, the randomly generated data will be different each time.

Note that transactions data is generated relative to the Item’s creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19.

version: Optional[str]

The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite.

class plaid2.model.UserIdNumber(*, type: str, value: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UserIdNumber[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserIdNumber[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: str

//cognitohq.com/docs/flow/flow-hybrid-input-validation)

Type

A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Hybrid Input Validation](https

value: str

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.

class plaid2.model.UserName(*, family_name: str, given_name: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

family_name: str

A string with at least one non-whitespace character, with a max length of 100 characters.

given_name: str

A string with at least one non-whitespace character, with a max length of 100 characters.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UserName[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserName[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.UserPermissionRevokedWebhook(*, error: Optional[Error] = None, webhook_code: str, webhook_type: str, item_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → UserPermissionRevokedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → UserPermissionRevokedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

USER_PERMISSION_REVOKED

webhook_type: str

ITEM

class plaid2.model.UserStatedIncomeSourceCategory(value)[source]

Bases: str, Enum

An enumeration.

bank_interest = 'BANK_INTEREST'
cash = 'CASH'
child_support = 'CHILD_SUPPORT'
gig_economy = 'GIG_ECONOMY'
long_term_disability = 'LONG_TERM_DISABILITY'
military = 'MILITARY'
other = 'OTHER'
rental = 'RENTAL'
retirement = 'RETIREMENT'
salary = 'SALARY'
unemployment = 'UNEMPLOYMENT'
class plaid2.model.UserStatedIncomeSourceFrequency(value)[source]

Bases: str, Enum

An enumeration.

biweekly = 'BIWEEKLY'
monthly = 'MONTHLY'
semi_monthly = 'SEMI_MONTHLY'
unknown = 'UNKNOWN'
weekly = 'WEEKLY'
class plaid2.model.UserStatedIncomeSourcePayType(value)[source]

Bases: str, Enum

An enumeration.

gross = 'GROSS'
net = 'NET'
unknown = 'UNKNOWN'
class plaid2.model.VerificationExpiredWebhook(*, webhook_code: str, webhook_type: str, item_id: str, account_id: str)[source]

Bases: BaseModel

account_id: str

The account_id of the account associated with the webhook

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → VerificationExpiredWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → VerificationExpiredWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

VERIFICATION_EXPIRED

webhook_type: str

AUTH

class plaid2.model.VerificationRefreshStatus(value)[source]

Bases: str, Enum

An enumeration.

verification_refresh_not_found = 'VERIFICATION_REFRESH_NOT_FOUND'
verification_refresh_status_user_presence_required = 'VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED'
verification_refresh_successful = 'VERIFICATION_REFRESH_SUCCESSFUL'
class plaid2.model.VerificationStatus(value)[source]

Bases: str, Enum

An enumeration.

needs_info = 'NEEDS_INFO'
unable_to_verify = 'UNABLE_TO_VERIFY'
unknown = 'UNKNOWN'
unverified = 'UNVERIFIED'
verified = 'VERIFIED'
class plaid2.model.W2(*, state_and_local_wages: Optional[List[W2StateAndLocalWages]] = None, social_security_tips: Optional[str] = None, box_12: Optional[List[W2Box12]] = None, tax_year: Optional[str] = None, nonqualified_plans: Optional[str] = None, social_security_wages: Optional[str] = None, social_security_tax_withheld: Optional[str] = None, statutory_employee: Optional[str] = None, employer_id_number: Optional[str] = None, medicare_wages_and_tips: Optional[str] = None, employee: Optional[Employee] = None, allocated_tips: Optional[str] = None, retirement_plan: Optional[str] = None, medicare_tax_withheld: Optional[str] = None, box_9: Optional[str] = None, dependent_care_benefits: Optional[str] = None, wages_tips_other_comp: Optional[str] = None, third_party_sick_pay: Optional[str] = None, employer: Optional[PaystubEmployer] = None, federal_income_tax_withheld: Optional[str] = None, other: Optional[str] = None)[source]

Bases: BaseModel

allocated_tips: Optional[str]

Allocated tips.

box_12: Optional[List[W2Box12]]
box_9: Optional[str]

Contents from box 9 on the W2.

dependent_care_benefits: Optional[str]

Dependent care benefits.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee: Optional[Employee]

Data about the employee.

employer: Optional[PaystubEmployer]

Information about the employer on the paystub

employer_id_number: Optional[str]

An employee identification number or EIN.

federal_income_tax_withheld: Optional[str]

Federal income tax withheld for the tax year.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

medicare_tax_withheld: Optional[str]

Medicare tax withheld for the tax year.

medicare_wages_and_tips: Optional[str]

Wages and tips from medicare.

nonqualified_plans: Optional[str]

Nonqualified plans.

other: Optional[str]

Other.

classmethod parse_obj(data: Any) → W2[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → W2[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

retirement_plan: Optional[str]

Retirement plan.

social_security_tax_withheld: Optional[str]

Social security tax withheld for the tax year.

social_security_tips: Optional[str]

Tips from social security.

social_security_wages: Optional[str]

Wages from social security.

state_and_local_wages: Optional[List[W2StateAndLocalWages]]
statutory_employee: Optional[str]

Statutory employee.

tax_year: Optional[str]

The tax year of the W2 document.

third_party_sick_pay: Optional[str]

Third party sick pay.

wages_tips_other_comp: Optional[str]

Wages from tips and other compensation.

class plaid2.model.W2Box12(*, code: Optional[str] = None, amount: Optional[str] = None)[source]

Bases: BaseModel

amount: Optional[str]

W2 Box 12 amount.

code: Optional[str]

W2 Box 12 code.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → W2Box12[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → W2Box12[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.W2StateAndLocalWages(*, employer_state_id_number: Optional[str] = None, state: Optional[str] = None, locality_name: Optional[str] = None, local_income_tax: Optional[str] = None, local_wages_tips: Optional[str] = None, state_wages_tips: Optional[str] = None, state_income_tax: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employer_state_id_number: Optional[str]

State identification number of the employer.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

local_income_tax: Optional[str]

Income tax from the locality.

local_wages_tips: Optional[str]

Wages and tips from the locality.

locality_name: Optional[str]

Name of the locality.

classmethod parse_obj(data: Any) → W2StateAndLocalWages[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → W2StateAndLocalWages[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

state: Optional[str]

State associated with the wage.

state_income_tax: Optional[str]

Income tax from the specified state.

state_wages_tips: Optional[str]

Wages and tips from the specified state.

class plaid2.model.Wallet(*, wallet_id: str, balance: WalletBalance, numbers: WalletNumbers)[source]

Bases: BaseModel

balance: WalletBalance

An object representing the e-wallet balance

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

numbers: WalletNumbers

An object representing the e-wallet account numbers

classmethod parse_obj(data: Any) → Wallet[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Wallet[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

wallet_id: str

A unique ID identifying the e-wallet

class plaid2.model.WalletBalance(*, current: float, iso_currency_code: str)[source]

Bases: BaseModel

current: float

The total amount of funds in the account

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

The ISO-4217 currency code of the balance

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletBalance[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletBalance[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletCreateResponse[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletCreateResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletCreateResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletGetResponse[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletIsoCurrencyCode(value)[source]

Bases: str, Enum

An enumeration.

eur = 'EUR'
gbp = 'GBP'
class plaid2.model.WalletListRequest(*, cursor: Optional[str] = None, count: Optional[int] = None, iso_currency_code: Optional[str] = None)[source]

Bases: BaseModel

count: Optional[int]

The number of e-wallets to fetch

cursor: Optional[str]

A base64 value representing the latest e-wallet that has already been requested. Set this to next_cursor received from the previous /wallet/list request. If provided, the response will only contain e-wallets created before that e-wallet. If omitted, the response will contain e-wallets starting from the most recent, and in descending order.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: Optional[str]

An ISO-4217 currency code, used with e-wallets and transactions.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletListResponse(*, request_id: str, wallets: List[Wallet], next_cursor: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

Cursor used for fetching e-wallets created before the latest e-wallet provided in this response

classmethod parse_obj(data: Any) → WalletListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

wallets: List[Wallet]

An array of e-wallets

class plaid2.model.WalletNumbers(*, bacs: Optional[RecipientBacs] = None, international: Optional[NumbersInternationalIban] = None)[source]

Bases: BaseModel

bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if you need to accept domestic GBP-denominated payments, BACS data is required.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

international: Optional[NumbersInternationalIban]

Account numbers using the International Bank Account Number and BIC/SWIFT code format.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletNumbers[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletNumbers[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletTransaction(*, status: str, created_at: str, transaction_id: str, type: str, reference: str, counterparty: WalletTransactionCounterparty, amount: WalletTransactionAmount)[source]

Bases: BaseModel

amount: WalletTransactionAmount

The amount and currency of a transaction

counterparty: WalletTransactionCounterparty

An object representing the e-wallet transaction’s counterparty

created_at: str

//wikipedia.org/wiki/ISO_8601) format.

Type

Timestamp when the transaction was created, in [ISO 8601](https

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransaction[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransaction[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

reference: str

A reference for the transaction

status: str

The status of the transaction.

INITIATED: This is the initial state of all transactions. It indicates that the transaction has been initiated and is currently being processed.

EXECUTED: The transaction has been successfully executed.

FAILED: The transaction failed to process successfully. This is a terminal status.

BLOCKED: The transaction has been blocked for violating compliance rules. This is a terminal status.

transaction_id: str

A unique ID identifying the transaction

type: str

The type of the transaction. The supported transaction types that are returned are: BANK_TRANSFER: a transaction which credits an e-wallet through an external bank transfer.

PAYOUT: a transaction which debits an e-wallet by disbursing funds to a counterparty.

PIS_PAY_IN: a payment which credits an e-wallet through Plaid’s Payment Initiation Services (PIS) APIs. For more information see the [Payment Initiation endpoints](https://plaid.com/docs/api/products/payment-initiation/).

REFUND: a transaction which debits an e-wallet by refunding a previously initated payment made through Plaid’s [PIS APIs](https://plaid.com/docs/api/products/payment-initiation/).

class plaid2.model.WalletTransactionAmount(*, value: float, iso_currency_code: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iso_currency_code: str

An ISO-4217 currency code, used with e-wallets and transactions.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionAmount[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionAmount[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

value: float

The amount of the transaction. Must contain at most two digits of precision e.g. 1.23.

class plaid2.model.WalletTransactionCounterparty(*, name: str, numbers: WalletTransactionCounterpartyNumbers)[source]

Bases: BaseModel

class Config[source]

Bases: object

alias_generator()
allow_population_by_field_name = True
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

name_: str

The name of the counterparty

numbers: WalletTransactionCounterpartyNumbers

The counterparty’s bank account numbers. Exactly one of IBAN or BACS data is required.

classmethod parse_obj(data: Any) → WalletTransactionCounterparty[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionCounterparty[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletTransactionCounterpartyNumbers(*, international: Optional[str] = None, bacs: Optional[RecipientBacs] = None)[source]

Bases: BaseModel

bacs: Optional[RecipientBacs]

The account number and sort code of the counterparty’s account

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

international: Optional[str]

International Bank Account Number for a Wallet Transaction

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionCounterpartyNumbers[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionCounterpartyNumbers[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletTransactionExecuteRequest(*, idempotency_key: str, wallet_id: str, counterparty: WalletTransactionCounterparty, amount: WalletTransactionAmount, reference: str)[source]

Bases: BaseModel

amount: WalletTransactionAmount

The amount and currency of a transaction

counterparty: WalletTransactionCounterparty

An object representing the e-wallet transaction’s counterparty

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

idempotency_key: str

A random key provided by the client, per unique wallet transaction. Maximum of 128 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionExecuteRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionExecuteRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

reference: str

A reference for the transaction. This must be an alphanumeric string with at most 18 characters and must not contain any special characters or spaces.

wallet_id: str

The ID of the e-wallet to debit from

class plaid2.model.WalletTransactionExecuteResponse(*, transaction_id: str, status: str, request_id: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionExecuteResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionExecuteResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

status: str

The status of the transaction.

INITIATED: This is the initial state of all transactions. It indicates that the transaction has been initiated and is currently being processed.

EXECUTED: The transaction has been successfully executed.

FAILED: The transaction failed to process successfully. This is a terminal status.

BLOCKED: The transaction has been blocked for violating compliance rules. This is a terminal status.

transaction_id: str

A unique ID identifying the transaction

class plaid2.model.WalletTransactionGetResponse[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WalletTransactionStatus(value)[source]

Bases: str, Enum

An enumeration.

blocked = 'BLOCKED'
executed = 'EXECUTED'
failed = 'FAILED'
initiated = 'INITIATED'
class plaid2.model.WalletTransactionsListRequest(*, cursor: Optional[str] = None, count: Optional[int] = None, wallet_id: str)[source]

Bases: BaseModel

count: Optional[int]

The number of transactions to fetch

cursor: Optional[str]

A base64 value representing the latest transaction that has already been requested. Set this to next_cursor received from the previous /wallet/transactions/list request. If provided, the response will only contain transactions created before that transaction. If omitted, the response will contain transactions starting from the most recent, and in descending order by the created_at time.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WalletTransactionsListRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionsListRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

wallet_id: str

The ID of the e-wallet to fetch transactions from

class plaid2.model.WalletTransactionsListResponse(*, request_id: str, transactions: List[WalletTransaction], next_cursor: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

next_cursor: Optional[str]

Cursor used for fetching transactions created before the latest transaction provided in this response

classmethod parse_obj(data: Any) → WalletTransactionsListResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WalletTransactionsListResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

transactions: List[WalletTransaction]

An array of transactions of an e-wallet, associated with the given wallet_id

class plaid2.model.Warning(*, cause: Cause, warning_code: str, warning_type: str)[source]

Bases: BaseModel

cause: 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.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Warning[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Warning[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

warning_code: str

The warning code identifies a specific kind of warning. Currently, the only possible warning code is OWNERS_UNAVAILABLE, which indicates that account-owner information is not available.

warning_type: str

The warning type, which will always be ASSET_REPORT_WARNING

class plaid2.model.WatchlistScreeningAuditTrail(*, dashboard_user_id: Optional[str] = None, timestamp: str, source: str)[source]

Bases: BaseModel

dashboard_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningAuditTrail[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningAuditTrail[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

source: str

A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

timestamp: str

An ISO8601 formatted timestamp.

class plaid2.model.WatchlistScreeningCreateRequest(*, client_user_id: Optional[str] = None, search_terms: WatchlistScreeningRequestSearchTerms)[source]

Bases: BaseModel

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningCreateRequest[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningCreateRequest[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

search_terms: WatchlistScreeningRequestSearchTerms

Search inputs for creating a watchlist screening

class plaid2.model.WatchlistScreeningDocument(*, type: str, number: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

number: str

The numeric or alphanumeric identifier associated with this document.

classmethod parse_obj(data: Any) → WatchlistScreeningDocument[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningDocument[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

type: str

The kind of official document represented by this object.

birth_certificate - A certificate of birth

drivers_license - A license to operate a motor vehicle

immigration_number - Immigration or residence documents

military_id - Identification issued by a military group

other - Any document not covered by other categories

passport - An official passport issue by a government

personal_identification - Any generic personal identification that is not covered by other categories

ration_card - Identification that entitles the holder to rations

ssn - United States Social Security Number

student_id - Identification issued by an educational institution

tax_id - Identification issued for the purpose of collecting taxes

travel_document - Visas, entry permits, refugee documents, etc.

voter_id - Identification issued for the purpose of voting

class plaid2.model.WatchlistScreeningDocumentType(value)[source]

Bases: str, Enum

An enumeration.

birth_certificate = 'birth_certificate'
drivers_license = 'drivers_license'
immigration_number = 'immigration_number'
military_id = 'military_id'
other = 'other'
passport = 'passport'
personal_identification = 'personal_identification'
ration_card = 'ration_card'
ssn = 'ssn'
student_id = 'student_id'
tax_id = 'tax_id'
travel_document = 'travel_document'
voter_id = 'voter_id'
class plaid2.model.WatchlistScreeningHit(*, list_code: str, data: Optional[ScreeningHitData] = None, inactive_since: Optional[str] = None, review_status: str, historical_since: Optional[str] = None, id: str, first_active: str, analysis: Optional[ScreeningHitAnalysis] = None, source_uid: Optional[str] = None, plaid_uid: str)[source]

Bases: BaseModel

analysis: Optional[ScreeningHitAnalysis]

Analysis information describing why a screening hit matched the provided user information

data: Optional[ScreeningHitData]

Information associated with the watchlist hit

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

first_active: str

An ISO8601 formatted timestamp.

historical_since: Optional[str]

An ISO8601 formatted timestamp.

id: str

ID of the associated screening hit.

inactive_since: Optional[str]

An ISO8601 formatted timestamp.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

list_code: str

Shorthand identifier for a specific screening list for individuals.

classmethod parse_obj(data: Any) → WatchlistScreeningHit[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningHit[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

plaid_uid: str

A universal identifier for a watchlist individual that is stable across searches and updates.

review_status: str

The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.

source_uid: Optional[str]

The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.

class plaid2.model.WatchlistScreeningHitLocations(*, full: str, country: str)[source]

Bases: BaseModel

country: str

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

full: str

The full location string, potentially including elements like street, city, postal codes and country codes. Note that this is not necessarily a complete or well-formatted address.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningHitLocations[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningHitLocations[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WatchlistScreeningHitStatus(value)[source]

Bases: str, Enum

An enumeration.

confirmed = 'confirmed'
dismissed = 'dismissed'
pending_review = 'pending_review'
class plaid2.model.WatchlistScreeningIndividual(*, search_terms: WatchlistScreeningSearchTerms, id: str, assignee: Optional[str] = None, client_user_id: Optional[str] = None, audit_trail: WatchlistScreeningAuditTrail, status: str)[source]

Bases: BaseModel

assignee: Optional[str]
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningIndividual[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningIndividual[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

search_terms: WatchlistScreeningSearchTerms

Search terms for creating an individual watchlist screening

status: str

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

class plaid2.model.WatchlistScreeningIndividualResponse(*, request_id: str, client_user_id: Optional[str] = None, search_terms: WatchlistScreeningSearchTerms, status: str, audit_trail: WatchlistScreeningAuditTrail, id: str, assignee: Optional[str] = None)[source]

Bases: BaseModel

assignee: Optional[str]
audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

client_user_id: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

id: str

ID of the associated screening.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningIndividualResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningIndividualResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

search_terms: WatchlistScreeningSearchTerms

Search terms for creating an individual watchlist screening

status: str

A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.

class plaid2.model.WatchlistScreeningRequestSearchTerms(*, date_of_birth: Optional[str] = None, watchlist_program_id: str, document_number: Optional[str] = None, country: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

country: Optional[str]
date_of_birth: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The legal name of the individual being screened.

classmethod parse_obj(data: Any) → WatchlistScreeningRequestSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningRequestSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

watchlist_program_id: str

ID of the associated program.

class plaid2.model.WatchlistScreeningReview(*, comment: Optional[str] = None, id: str, confirmed_hits: List[str], audit_trail: WatchlistScreeningAuditTrail, dismissed_hits: List[str])[source]

Bases: BaseModel

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

id: str

ID of the associated review.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningReview[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningReview[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

class plaid2.model.WatchlistScreeningReviewResponse(*, id: str, dismissed_hits: List[str], comment: Optional[str] = None, audit_trail: WatchlistScreeningAuditTrail, confirmed_hits: List[str], request_id: str)[source]

Bases: BaseModel

audit_trail: WatchlistScreeningAuditTrail

Information about the last change made to the parent object specifying what caused the change as well as when it occurred.

comment: Optional[str]

A comment submitted by a team member as part of reviewing a watchlist screening.

confirmed_hits: List[str]

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

dismissed_hits: List[str]

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.

id: str

ID of the associated review.

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → WatchlistScreeningReviewResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningReviewResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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

class plaid2.model.WatchlistScreeningSearchTerms(*, watchlist_program_id: str, document_number: Optional[str] = None, version: float, date_of_birth: Optional[str] = None, country: Optional[str] = None, legal_name: str)[source]

Bases: BaseModel

country: Optional[str]
date_of_birth: Optional[str]
dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

document_number: Optional[str]
json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

legal_name: str

The legal name of the individual being screened.

classmethod parse_obj(data: Any) → WatchlistScreeningSearchTerms[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WatchlistScreeningSearchTerms[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

version: float

The current version of the search terms. Starts at 1 and increments with each edit to search_terms.

watchlist_program_id: str

ID of the associated program.

class plaid2.model.WatchlistScreeningStatus(value)[source]

Bases: str, Enum

An enumeration.

cleared = 'cleared'
pending_review = 'pending_review'
rejected = 'rejected'
class plaid2.model.WeakAliasDetermination(value)[source]

Bases: str, Enum

An enumeration.

none = 'none'
plaid = 'plaid'
source = 'source'
class plaid2.model.WebhookType(value)[source]

Bases: str, Enum

An enumeration.

auth = 'AUTH'
holdings = 'HOLDINGS'
investments_transactions = 'INVESTMENTS_TRANSACTIONS'
item = 'ITEM'
liabilities = 'LIABILITIES'
transactions = 'TRANSACTIONS'
class plaid2.model.WebhookUpdateAcknowledgedWebhook(*, webhook_code: str, item_id: str, error: Optional[Error] = None, webhook_type: str, new_webhook_url: str)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

error: Optional[Error]

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. Error fields will be null if no error has occurred.

item_id: str

The item_id of the Item associated with this webhook, warning, or error

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

new_webhook_url: str

The new webhook URL

classmethod parse_obj(data: Any) → WebhookUpdateAcknowledgedWebhook[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WebhookUpdateAcknowledgedWebhook[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

webhook_code: str

WEBHOOK_UPDATE_ACKNOWLEDGED

webhook_type: str

ITEM

class plaid2.model.WebhookVerificationKeyGetResponse(*, request_id: str, key: JwkPublicKey)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) → str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

key: JwkPublicKey

//jwt.io/#libraries-io) to verify Plaid webhooks

Type

A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](https

classmethod parse_obj(data: Any) → WebhookVerificationKeyGetResponse[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → WebhookVerificationKeyGetResponse[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_id: str

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