An item represents a connection to a bank account using a set of user credentials.
It contains one or more accounts which contain transactions.
Field | Description |
---|---|
| Item's unique identifier |
| Item status codes are detailed below |
| Detailed on the Items status page |
| Detailed on the Items status page |
| Bank's unique identifier |
LIST OF ITEM STATUS CODES
Status | Code | Description |
---|---|---|
| 0 | |
| -2 | The account was recently added. The account refresh is pending. |
| -3 | The account's credentials were recently changed. The account refresh is pending. |
| 402 | Wrong credentials. |
| 429 | An action from the user is required within the online banking of the user. Examples: |
| 430 | The User needs to log onto his bank's website to change his password. |
| 1003 | Couldn't refresh. Try again. |
| 1005 | Account not supported. |
| 1007 | Refresh temporarily disabled. |
| 1009 | Account balance has changed but no new transactions were found. |
| 1010 | Item wasn't refreshed successfully, it required an MFA / OTP that wasn't provided. |
| 1099 | Item is migrating to another bank. |
| 1100 | Pro accounts have been detected on this Item and it needs validation. Otherwise the data will be obfuscated. |
{
"id": 187741,
"resource_uri": "/v2/items/187741",
"resource_type": "item",
"status": 1003,
"status_code_info": "BANK_IS_DOWN",
"status_code_description": "Your bank's interface is down for now.",
"bank": {
"id": 408,
"resource_uri": "/v2/banks/408",
"resource_type": "bank"
},
"accounts": [
{
"id": 2341488,
"resource_uri": "/v2/accounts/2341488",
"resource_type": "account"
}
],
}
PROCESS OF REFRESHING AN ITEM ON DEMAND
Note that all items except those needing Strong Customer Authentication for each connection will be refreshed automatically twice a day by Bridge. You may want to refresh an item on demand, in which case you can use one of these two following processes:
WITH THE BRIDGE CONNECT
Call the Manage SCA and Sync endpoint
WITHOUT THE BRIDGE CONNECT (only for items without SCA)
Call the Refresh an item endpoint for the given item.
Check periodically (every 5 seconds) the item's status by calling GET /v2/items/:id/status
- If
status
isinfo_required
, this item needs an SCA - If
status
isinvalid_creds
, the user credentials are incorrect. Edit the credentials and start again at step 1. - If
status
isauthenticating
, the item is trying to establish a connection. Keep checking the status. - If
status
isretrieving_data
, the item is retrieving the data and indicates its progression. - If
status
isfinished
, the item retrieved all its data. - If
status
isfinished_error
, something went wrong. Check the item's status by callingGET /v2/items/:id
and check the Items status page.