Plaid Connections
Created Diff never expires
10 removals
| Lines | |
|---|---|
| Total | |
| Removed | |
| Characters | |
| Total | |
| Removed | |
4 additions
| Lines | |
|---|---|
| Total | |
| Added | |
| Characters | |
| Total | |
| Added | |
"""
"""
Plaid Item data.
Plaid Connection data.
"""
"""
type PlaidConnection {
type RemoteDataPlaidItem {
"""
"""
A list of products available for the Item that have not yet been accessed. The
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`.
contents of this array will be mutually exclusive with `billed_products`.
"""
"""
availableProducts: [String!]!
availableProducts: [String!]
"""
"""
A list of products that have been billed for the Item. The contents of this
A list of products that have been billed for the Item. The contents of this
array will be mutually exclusive with `available_products`. Note -
array will be mutually exclusive with `available_products`. Note -
`billed_products` is populated in all environments but only requests in
`billed_products` is populated in all environments but only requests in
Production are billed. Also note that products that are billed on a
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
pay-per-call basis rather than a pay-per-Item basis, such as `balance`, will
not appear here.
not appear here.
"""
"""
billedProducts: [String!]!
billedProducts: [String!]
"""
"""
The RFC 3339 timestamp after which the consent provided by the end user will
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`
expire. Upon consent expiration, the item will enter the `ITEM_LOGIN_REQUIRED`
error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain
error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain
continuous consent, the end user can reauthenticate via Link’s update mode in
continuous consent, the end user can reauthenticate via Link’s update mode in
advance of the consent expiration time.
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.
Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.
"""
"""
consentExpirationTime: DateTime
consentExpirationTime: DateTime
"""
"""
Beta: A list of products that have gone through consent collection for the
Beta: A list of products that have gone through consent collection for the
Item. Only present for those enabled in the beta.
Item. Only present for those enabled in the beta.
"""
"""
consentedProducts: [String!]
consentedProducts: [String!]
"""
"""
We use standard HTTP response codes for success and failure notifications, and
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
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,
correspond to success, 40X codes are for developer- or user-related failures,
and 50X codes are for Plaid-related issues. An Item with a non-`null` error
and 50X codes are for Plaid-related issues. An Item with a non-`null` error
object will only be part of an API response when calling `/item/get` to view
object will only be part of an API response when calling `/item/get` to view
Item status. Otherwise, error fields will be `null` if no error has occurred;
Item status. Otherwise, error fields will be `null` if no error has occurred;
if an error has occurred, an error code will be returned instead.
if an error has occurred, an error code will be returned instead.
"""
"""
error: PlaidError
error: RemoteDataPlaidError
"""
"""
The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits.
The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits.
"""
"""
institutionId: String
institutionId: String
"""
"""
The Plaid Item ID. The `item_id` is always unique; linking the same account at
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`
the same institution twice will result in two Items with different `item_id`
values. Like all Plaid identifiers, the `item_id` is case-sensitive.
values. Like all Plaid identifiers, the `item_id` is case-sensitive.
"""
"""
itemId: String!
itemId: String
"""
"""
A list of authorized products for the Item.
A list of authorized products for the Item.
"""
"""
products: [String!]!
products: [String!]
"""
"""
Indicates whether an Item requires user interaction to be updated, which can
Indicates whether an Item requires user interaction to be updated, which can
be the case for Items with some forms of two-factor authentication.
be the case for Items with some forms of two-factor authentication.
`background` - Item can be updated in the background
`background` - Item can be updated in the background
`user_present_required` - Item requires user interaction to be updated
`user_present_required` - Item requires user interaction to be updated
"""
"""
updateType: String!
updateType: String
"""
"""
The URL registered to receive webhooks for the Item.
The URL registered to receive webhooks for the Item.
"""
"""
webhook: String
webhook: String
}
}
"""
"""
We use standard HTTP response codes for success and failure notifications, and
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
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,
correspond to success, 40X codes are for developer- or user-related failures,
and 50X codes are for Plaid-related issues. An Item with a non-`null` error
and 50X codes are for Plaid-related issues. An Item with a non-`null` error
object will only be part of an API response when calling `/item/get` to view
object will only be part of an API response when calling `/item/get` to view
Item status. Otherwise, error fields will be `null` if no error has occurred; if
Item status. Otherwise, error fields will be `null` if no error has occurred; if
an error has occurred, an error code will be returned instead.
an error has occurred, an error code will be returned instead.
"""
"""
type PlaidError {
type RemoteDataPlaidError {
"""
"""
In the Assets product, a request can pertain to more than one Item. If an
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
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
containing a breakdown of these errors on the individual Item level, if any
can be identified.
can be identified.
`causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`.
`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.
`causes` will also not be populated inside an error nested within a `warning` object.
"""
"""
causes: [String!]
causes: [String!]
"""
"""
A user-friendly representation of the error code. `null` if the error is not related to user action.
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.
This may change over time and is not safe for programmatic use.
"""
"""
displayMessage: String
displayMessage: String
"""
"""
The URL of a Plaid documentation page with more information about the error
The URL of a Plaid documentation page with more information about the error
"""
"""
documentationUrl: String
documentationUrl: String
"""
"""
The particular error code. Safe for programmatic use.
The particular error code. Safe for programmatic use.
"""
"""
errorCode: String!
errorCode: String
"""
"""
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
"""
"""
errorMessage: String!
errorMessage: String
"""
"""
A broad categorization of the error. Safe for programmatic use.
A broad categorization of the error. Safe for programmatic use.
"""
"""
errorType: String!
errorType: String
"""
"""
A unique ID identifying the request, to be used for troubleshooting purposes.
A unique ID identifying the request, to be used for troubleshooting purposes.
This field will be omitted in errors provided by webhooks.
This field will be omitted in errors provided by webhooks.
"""
"""
requestId: String
requestId: String
"""
"""
The HTTP status code associated with the error. This will only be returned in
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.
the response body when the error information is provided via a webhook.
"""
"""
status: Float
status: Float
"""
"""
Suggested steps for resolving the error
Suggested steps for resolving the error
"""
"""
suggestedAction: String
suggestedAction: String
}
}