v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Links

List links

Returns a paginated list of the links of your organization, in the live or test mode of the API key used. link_token and accounts are always null when listing links.

get/links

Query parameters

status'active' | 'inactive' | 'login_required'

If present, Fintoc returns only links with this status.

pageinteger

Page number to retrieve. Starts at 1.

per_pagestring

Number of links per page. Defaults to 30. The maximum is 300.

Response

Paginated list of links. The Link and X-Total-Count headers carry the pagination information.

idstring required

Unique identifier of the link.

object'link' required

Type of the object. Always link.

activeboolean required

Whether the link is active. Fintoc does not refresh inactive links. Deactivating a link stops refreshes but does not revoke the link_token's access to already-collected data.

created_atstring date-time required

ISO 8601 timestamp of when the link was created.

holder_idstring required

Tax identifier of the account holder, without dots or hyphens (RUT in Chile, RFC in Mexico).

holder_type'individual' | 'business' required

Whether the account holder is an individual or a business.

last_time_refreshedstring date-time nullable required

ISO 8601 timestamp of the link's last refresh. null if Fintoc has never refreshed the link.

link_tokenstring nullable required

Token used to authenticate requests for the link's resources. Only returned when the link is exchanged; null in every other response.

mode'test' | 'live' required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

refresh_status'idle' | 'refreshing' | 'interrupted' | 'partially_refreshing' | 'null' nullable required

Refresh status of the link's accounts. idle means no refresh is in progress, refreshing means every account is refreshing, partially_refreshing means only some accounts are refreshing, and interrupted means no account is currently refreshing.

status'active' | 'inactive' | 'login_required' required

Status of the link. login_required means the institution rejected the stored credentials and you must reconnect the link.

subscription_idstring

Identifier of the subscription associated to the link. Only present when the link is returned from a subscription exchange.

usernamestring required

Username used to log in at the institution, without dots or hyphens.

Example response

[
  {
    "id": "link_nMNejK7BT8oGbvO4",
    "accounts": [
      {
        "id": "acc_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
        "available_balance": 1050000,
        "currency": "MXN",
        "description": "Main collection account",
        "entity": {
          "id": "ent_2eGhTp1rLqWnXkZbYc4JsKmAvD9",
          "holder_id": "000000000",
          "holder_name": "Test Customer 1",
          "is_root": true
        },
        "is_root": true,
        "mode": "test",
        "root_account_number": "646180111800000000",
        "root_account_number_id": "acno_2fJkRm7tBvQxNzYpLc5WsHaDfT3",
        "status": "active"
      }
    ],
    "active": true,
    "created_at": "2020-04-22T21:10:19.254Z",
    "holder_id": "111111111",
    "holder_type": "individual",
    "institution": {
      "id": "cl_banco_de_chile",
      "country": "cl",
      "name": "Banco de Chile"
    },
    "last_time_refreshed": "2020-11-18T18:43:54.591Z",
    "link_token": "link_nMNejK7BT8oGbvO4_token_sjnNsMyXKJEXAMPLETOKENrnNL1tA8",
    "mode": "live",
    "refresh_status": "idle",
    "status": "active",
    "subscription_id": "sub_nMNejK7BT8oGbvO4",
    "username": "111111111"
  }
]