The Link object
ALink represents a connection between an end user and a financial institution, granting access to the bank accounts the user holds at that institution. It is created when a user completes the Fintoc Widget flow, and it groups the associated Account objects along with their refresh status.
Link Object
{
"id": "link_nMNejK7BT8oGbvO4",
"object": "link",
"accounts": [
{
"id": "acc_Z6AwnGn4idL7DPj4",
"object": "account",
"balance": {
"available": 7010510,
"current": 7010510,
"limit": 7510510
},
"currency": "CLP",
"holder_id": "111111111",
"holder_name": "Jon Snow",
"name": "Cuenta Corriente",
"number": "9530516286",
"official_name": "Cuenta Corriente Moneda Local",
"type": "checking_account"
},
{
"id": "acc_BO381oEATXonG6bj",
"object": "account",
"balance": {
"available": 500000,
"current": 500000,
"limit": 500000
},
"currency": "CLP",
"holder_id": "111111111",
"holder_name": "Jon Snow",
"name": "Línea de Crédito",
"number": "19534121467",
"official_name": "Linea De Credito Personas",
"type": "line_of_credit"
}
],
"active": true,
"created_at": "2020-04-22T21:10:19.254Z",
"holder_id": "555555555",
"holder_type": "individual",
"institution": {
"id": "cl_banco_de_chile",
"country": "cl",
"name": "Banco de Chile"
},
"last_time_refreshed": "2020-04-22T23:10:19.254Z",
"link_token": "link_nMNejK7BT8oGbvO4_token_GLtktZX5SKphRtJFe_yJTDWT",
"mode": "test",
"refresh_status": "refreshing",
"status": "active",
"username": "111111111"
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Link |
object | string | Identifier for the type of object. Its value for Links will always correspond to link |
accounts | array | Accounts associated with the Link. See the Account object for details. Fintoc includes this field when you exchange a link token or get a single Link, and returns null when you list links. |
active | boolean | Indicates if the bank accounts of the Link are being updated or not |
created_at | string | Link’s creation date, using ISO 8601 |
holder_id | string | Identifier of the owner of the accounts held under the Link. In Chile, it corresponds to a RUT. In Mexico, it corresponds to a RFC |
holder_type | string | Indicates whether the account owner is an individual or a business |
institution | object | Financial institution associated to the Link |
last_time_refreshed | string | Last time the link was refreshed considering it’s bank accounts. |
link_token | string | Token to be used to make requests for resources nested under a Link (for example, bank movements). This attribute will only be returned when creating a Link. After that, this field will always be null. |
mode | string | Indicates whether the Link is in live mode or in test mode (for the sandbox) |
refresh_status | string | Refresh status of the Link. It’s values can be: idle, refreshing, partially_refreshing , interrupted |
status | string | Indicates if the Link needs to be reconnected (login_required) or if it is being updated with no problems (active). If the Link has been desactivated, this value will correspond to inactive |
username | string | Name of the user for the bank’s platform. In Chile, it always corresponds to a RUT. |