Easily Integrate
Belvo's API using Konfig's TypeScript SDK

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

First, instantiate the SDK

It only takes a few lines of code.

index.ts


import { Belvo } from 'belvo-typescript-sdk';
const belvo = new Belvo({
    /*
     * Belvo employs **basic authentication** using your secret keys. Just use your secretId as the `username` and secretPassword as the `password`. For example:
     * 
     * ```text Authentication example
     * curl \
     *     -u =BASE64-SECRET_ID=:=BASE64-SECRET_PASSWORD=
     *     https://sandbox.belvo.com/api/
     * ```
     * 
     * For information on how to get your API keys, check out our [Get Started in 5 Minutes](https://developers.belvo.com/docs/get-started-in-5-minutes) DevPortal article.
     */
    username: "USERNAME",
    password: "PASSWORD"
})

Then, send your first request

We made it really easy.

index.ts


// List all links
const listAllResponse = belvo.links.listAll({
    page: 1
    pageSize: 100
    omit: "field1,field2"
    fields: "field1,field2,field3"
    id: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"
    idIn: "24ccab1d-3a86-4136-a6eb-e04bf52b356f,beb2b197-3cf7-428d-bef3-f415c0d57509"
    institution: "erebor_mx_retail"
    institutionIn: "erebor_mx_retail,gringotts_mx_retail"
    accessMode: "single"
    createdAt: "2022-05-05"
    createdAtGt: "2022-05-05"
    createdAtGte: "2022-05-04"
    createdAtLt: "2022-04-01"
    createdAtLte: "2022-03-30"
    createdAtRange: "2022-03-03,2022-05-04"
    createdByNotIn: "578947e2-3c9a-4401-bbad-59b2f2d2b91b,d3d941ab-4ca5-43c1-8b23-db329ee4cb7e"
    externalId: "InternalUser4000"
    externalIdIn: "InternalUser4000,InternalUser4001"
    institutionUserId: "ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="
    institutionUserIdIn: "ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=,YwuTM0uEEh1BbVgDZBcNpa_-Tm3l2q8ZkZNrlhp-pNA="
    refreshRate: "24h"
    status: "invalid"
    statusIn: "invalid,unconfirmed"
})

Enjoy a buttery smooth developer experience with 80 SDK methods

Parameter

pageinteger

A page number within the paginated result set.

pageSizeinteger

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (https://developers.belvo.com.

omitstring

Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

idstring

Return information only for this resource id.

idInarray

Return information for these resource ids.

institutionstring

Return results only for this institution (use the Belvo-designated name, such as erebor_mx_retail).

institutionInarray

Return results only for these institutions (use the Belvo-designated names, such as erebor_mx_retail and gringotts_mx_retail).

accessModestring

Return links only with this access mode. Can be either single or recurrent.

createdAtstring

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

createdAtGtstring

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

createdAtGtestring

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

createdAtLtstring

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

createdAtLtestring

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

createdAtRangearray

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format).

createdByNotInarray

Return links that were not created by these Belvo users.

externalIdstring

Return links with this external ID.

externalIdInarray

Return links with these external IDs.

institutionUserIdstring

Return links with this specific institution user ID.

institutionUserIdInarray

Return links with these institution user IDs.

refreshRatestring

Return links with this refresh rate. Choose between 6h, 12h, 24h, 7d, or 30d.

statusstring

Return links with this status. Choose between valid, invalid, unconfirmed, or token_required.

statusInarray

Return links with these statuses. Choose between valid, invalid, unconfirmed, or token_required.

Response

200

401

Endpoint

get

/api/links

Parameter

sessionstringrequired

tokenstring

linkstringrequired

Response

200

400

401

428

500

This error occurs when we (https://developers.belvo.com have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.

Endpoint

patch

/api/links

Parameter

institutionstringrequired

usernamestringrequired

passwordstring

external_idstring

username2string

username3string

password2string

tokenstring

access_modestring

fetch_resourcesarray

credentials_storagestring

stale_instring

username_typestring

Response

201

400

401

428

500

This error occurs when we (https://developers.belvo.com have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.

Endpoint

post

/api/links

Parameter

idstringrequired

The link.id that you want to delete.

Response

204

No content

401

404

You made a request where you:

provided the wrong URL.
used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.

Endpoint

delete

/api/links/{id}

Parameter

idstringrequired

The link.id you want to get detailed information about.

Response

200

401

404

You made a request where you:

provided the wrong URL.
used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.

Endpoint

get

/api/links/{id}

Parameter

idstringrequired

The link.id you want to change the access_mode for.

access_modestringrequired

Response

200

400

401

404

You made a request where you:

provided the wrong URL.
used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.

428

500

This error occurs when we (https://developers.belvo.com have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.

Endpoint

patch

/api/links/{id}

How Konfig Works

Konfig collects APIs and automatically generates SDKs so you can focus on building your application.

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.

Generates AI-Augmented SDKs from openapi-examples

Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.

Publishes to standard package managers

We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.

About Belvo

Belvo es la plataforma líder de datos y pagos de open finance en Latinoamérica. Ayudamos a innovadores financieros a acceder a los datos financieros de tus usuarios, entender mejor su comportamiento y habilitar pagos instantáneos gracias al open finance, con el objetivo de impulsar productos más eficientes, seguros e inclusivos.

Keywords

finance

open_banking

fintech

financial_services

latam

latin_america

open_finance

Easily Integrate
Belvo's API using Konfig's TypeScript SDK

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

First, instantiate the SDK

Then, send your first request

Enjoy a buttery smooth developer experience with 80 SDK methods

List all links

Parameter

Response

Endpoint

Complete a links request

Parameter

Response

Endpoint

Register a new link

Parameter

Response

Endpoint

Delete a link

Parameter

Response

Endpoint

Get a link's details

Parameter

Response

Endpoint

Change a link's access mode

Parameter

Response

Endpoint

How Konfig Works

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

Generates AI-Augmented SDKs from openapi-examples

Publishes to standard package managers

About Belvo

Keywords

Start integrating Belvo's API with Konfig

Easily Integrate Belvo's API using Konfig's TypeScript SDK

Need a TypeScript SDK for Belvo's API?

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

First, instantiate the SDK

Then, send your first request

Enjoy a buttery smooth developer experience with 80 SDK methods

List all links

Parameter

Response

Endpoint

Complete a links request

Parameter

Response

Endpoint

Register a new link

Parameter

Response

Endpoint

Delete a link

Parameter

Response

Endpoint

Get a link's details

Parameter

Response

Endpoint

Change a link's access mode

Parameter

Response

Endpoint

How Konfig Works

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

Generates AI-Augmented SDKs from openapi-examples

Publishes to standard package managers

About Belvo

Keywords

Start integrating Belvo's API with Konfig

Easily Integrate
Belvo's API using Konfig's TypeScript SDK