Plaid Account
23 removals
181 lines
8 additions
167 lines
"""
"""
Plaid Account data.
Plaid Account data.
"""
"""
type PlaidAccount {
type RemoteDataPlaidAccount {
"""
"""
Plaid’s unique identifier for the account. This value will not change unless
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
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
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.
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
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
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
generate a new `access_token` on a later date. In that case, the new
`account_id` will be different from the old `account_id`.
`account_id` will be different from the old `account_id`.
If an account with a specific `account_id` disappears instead of changing, the
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.
account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the `account_id` is case sensitive.
Like all Plaid identifiers, the `account_id` is case sensitive.
"""
"""
accountId: String!
accountId: String
"""
"""
A set of fields describing the balance for an account. Balance information may
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`.
be cached unless the balance object was returned by `/accounts/balance/get`.
"""
"""
balances: PlaidAccountBalance!
balances: RemoteDataPlaidAccountBalance
"""
"""
The last 2-4 alphanumeric characters of an account's official account number.
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
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.
also not match the mask that the bank displays to the user.
"""
"""
mask: String
mask: String
"""
"""
The name of the account, either assigned by the user or by the financial institution itself
The name of the account, either assigned by the user or by the financial institution itself
"""
"""
name: String!
name: String
"""
"""
The official name of the account as given by the financial institution
The official name of the account as given by the financial institution
"""
"""
officialName: String
officialName: String
"""
"""
A unique and persistent identifier for accounts that can be used to trace
A unique and persistent identifier for accounts that can be used to trace
multiple instances of the same account across different Items for depository
multiple instances of the same account across different Items for depository
accounts. This is currently an opt-in field and only supported for Chase Items.
accounts. This is currently an opt-in field and only supported for Chase Items.
"""
"""
persistentAccountId: String
persistentAccountId: String
"""
"""
See the [Account type
See the [Account type
schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full
schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full
listing of account types and corresponding subtypes.
listing of account types and corresponding subtypes.
"""
"""
subtype: String
subtype: String
"""
"""
`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead.
`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead.
`credit:` Credit card
`credit:` Credit card
`depository:` Depository account
`depository:` Depository account
`loan:` Loan account
`loan:` Loan account
`other:` Non-specified account type
`other:` Non-specified account type
See the [Account type
See the [Account type
schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full
schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full
listing of account types and corresponding subtypes.
listing of account types and corresponding subtypes.
"""
"""
type: String!
type: String
"""
"""
The current verification status of an Auth Item initiated through Automated or
The current verification status of an Auth Item initiated through Automated or
Manual micro-deposits. Returned for Auth Items only.
Manual micro-deposits. Returned for Auth Items only.
`pending_automatic_verification`: The Item is pending automatic verification
`pending_automatic_verification`: The Item is pending automatic verification
`pending_manual_verification`: The Item is pending manual micro-deposit
`pending_manual_verification`: The Item is pending manual micro-deposit
verification. Items remain in this state until the user successfully verifies
verification. Items remain in this state until the user successfully verifies
the two amounts.
the two amounts.
`automatically_verified`: The Item has successfully been automatically verified
`automatically_verified`: The Item has successfully been automatically verified
`manually_verified`: The Item has successfully been manually verified
`manually_verified`: The Item has successfully been manually verified
`verification_expired`: Plaid was unable to automatically verify the deposit
`verification_expired`: Plaid was unable to automatically verify the deposit
within 7 calendar days and will no longer attempt to validate the Item. Users
within 7 calendar days and will no longer attempt to validate the Item. Users
may retry by submitting their information again through Link.
may retry by submitting their information again through Link.
`verification_failed`: The Item failed manual micro-deposit verification
`verification_failed`: The Item failed manual micro-deposit verification
because the user exhausted all 3 verification attempts. Users may retry by
because the user exhausted all 3 verification attempts. Users may retry by
submitting their information again through Link.
submitting their information again through Link.
"""
"""
verificationStatus: String
verificationStatus: String
}
}
"""
"""
A set of fields describing the balance for an account. Balance information may
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`.
be cached unless the balance object was returned by `/accounts/balance/get`.
"""
"""
type PlaidAccountBalance {
type RemoteDataPlaidAccountBalance {
"""
"""
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
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
For `credit`-type accounts, the `available` balance typically equals the
`limit` less the `current` balance, less any pending outflows plus any pending inflows.
`limit` less the `current` balance, less any pending outflows plus any pending inflows.
For `depository`-type accounts, the `available` balance typically equals the
For `depository`-type accounts, the `available` balance typically equals the
`current` balance less any pending outflows plus any pending inflows. For
`current` balance less any pending outflows plus any pending inflows. For
`depository`-type accounts, the `available` balance does not include the
`depository`-type accounts, the `available` balance does not include the
overdraft limit.
overdraft limit.
For `investment`-type accounts (or `brokerage`-type accounts for API versions
For `investment`-type accounts (or `brokerage`-type accounts for API versions
2018-05-22 and earlier), the `available` balance is the total cash available
2018-05-22 and earlier), the `available` balance is the total cash available
to withdraw as presented by the institution.
to withdraw as presented by the institution.
Note that not all institutions calculate the `available` balance. In the
Note that not all institutions calculate the `available` balance. In the
event that `available` balance is unavailable, Plaid will return an
event that `available` balance is unavailable, Plaid will return an
`available` balance value of `null`.
`available` balance value of `null`.
Available balance may be cached and is not guaranteed to be up-to-date in
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`.
realtime unless the value was returned by `/accounts/balance/get`.
If `current` is `null` this field is guaranteed not to be `null`.
If `current` is `null` this field is guaranteed not to be `null`.
"""
"""
available: Float
available: Float
"""
"""
The total amount of funds in or owed by the account.
The total amount of funds in or owed by the account.
For `credit`-type accounts, a positive balance indicates the amount owed; a
For `credit`-type accounts, a positive balance indicates the amount owed; a
negative amount indicates the lender owing the account holder.
negative amount indicates the lender owing the account holder.
For `loan`-type accounts, the current balance is the principal remaining on
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
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
(`ins_116944`). For Sallie Mae student loans, the account's balance includes
both principal and any outstanding interest.
both principal and any outstanding interest.
For `investment`-type accounts (or `brokerage`-type accounts for API versions
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
2018-05-22 and earlier), the current balance is the total value of assets as
presented by the institution.
presented by the institution.
Note that balance information may be cached unless the value was returned by
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
`/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
will be at least as recent as the most recent Transaction update. If you
require realtime balance information, use the `available` balance as provided
require realtime balance information, use the `available` balance as provided
by `/accounts/balance/get`.
by `/accounts/balance/get`.
When returned by `/accounts/balance/get`, this field may be `null`. When this
When returned by `/accounts/balance/get`, this field may be `null`. When this
happens, `available` is guaranteed not to be `null`.
happens, `available` is guaranteed not to be `null`.
"""
"""
current: Float
current: Float
"""
"""
The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null.
The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null.
"""
"""
isoCurrencyCode: String
isoCurrencyCode: String
"""
"""
Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
(`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the
(`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the
given account has been updated
given account has been updated
This is currently only provided when the `min_last_updated_datetime` is passed
This is currently only provided when the `min_last_updated_datetime` is passed
when calling `/accounts/balance/get` for `ins_128026` (Capital One).
when calling `/accounts/balance/get` for `ins_128026` (Capital One).
"""
"""
lastUpdatedDatetime: DateTime
lastUpdatedDatetime: DateTime
"""
"""
For `credit`-type accounts, this represents the credit limit.
For `credit`-type accounts, this represents the credit limit.
For `depository`-type accounts, this represents the pre-arranged overdraft
For `depository`-type accounts, this represents the pre-arranged overdraft
limit, which is common for current (checking) accounts in Europe.
limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for `credit`-type accounts.
In North America, this field is typically only available for `credit`-type accounts.
"""
"""
limit: Float
limit: Float
"""
"""
The unofficial currency code associated with the balance. Always null if
The unofficial currency code associated with the balance. Always null if
`iso_currency_code` is non-null. Unofficial currency codes are used for
`iso_currency_code` is non-null. Unofficial currency codes are used for
currencies that do not have official ISO currency codes, such as
currencies that do not have official ISO currency codes, such as
cryptocurrencies and the currencies of certain countries.
cryptocurrencies and the currencies of certain countries.
See the [currency code
See the [currency code
schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full
schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full
listing of supported `unofficial_currency_code`s.
listing of supported `unofficial_currency_code`s.
"""
"""
unofficialCurrencyCode: String
unofficialCurrencyCode: String
}
}