v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Accounts

List accounts

▶️ Usage

With the List Accounts method, you can:

List accounts related to a specific link.id (using the link query parameter).
Get the details of a specific account.id (using the id query parameter).
[Not Recommended] List all accounts related to your Belvo account (without using any query parameters).

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

🚨 Deprecated Fields

This resource may return deprecated fields. In the response documentation you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.

get/api/accounts/

Query parameters

linkstring uuid

Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The link.id you want to filter by.

ℹ️ We highly recommend adding the link.id filter in order to improve your performance.

page_sizeinteger

Example:100

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 (1000).

pageinteger

Example:1

A page number within the paginated result set.

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

link__instring[]

Return results only for these link.ids.

[
  "5722d0ba-69d7-42dc-8ff5-33767b83c5d6"
]

balance__availablenumber float

Example:4000.02

Return accounts that have a balance.available matching exactly this value.

balance__available__ltnumber float

Example:6000.02

Return accounts that have a balance.available less than this value.

balance__available__ltenumber float

Example:5999.02

Return accounts that have a balance.available less than or equal to this value.

balance__available__gtnumber float

Example:2000.02

Return accounts that have a balance.available greater than this value.

balance__available__gtenumber float

Example:1999.02

Return accounts that have a balance.available greater than or equal to this value.

balance__available__rangenumber[]

Return accounts that have a balance.available within a range of two. The first value indicates the start of the range and the second value indicates the end of the range. values.

balance__currentnumber float

Example:4000.02

Return accounts that have a balance.current matching exactly this value.

balance__current__ltnumber float

Example:6000.02

Return accounts that have a balance.current less than this value.

balance__current__ltenumber float

Example:5999.02

Return accounts that have a balance.available less than or equal to this value.

balance__current__gtnumber float

Example:2000.02

Return accounts that have a balance.current greater than this value.

balance__current__gtenumber float

Example:1999.02

Return accounts that have a balance.available greater than or equal to this value.

balance__current__rangenumber[]

Return accounts that have a balance.current within a range of two. The first value indicates the start of the range and the second value indicates the end of the range. values.

categorystring

Example:CREDIT_ACCOUNT

Return accounts only for the given category (for example, CHECKING_ACCOUNT and SAVINGS_ACCOUNT).

category__instring[]

Return accounts only for the given categories (for example, CHECKING_ACCOUNT and SAVINGS_ACCOUNT).

[
  "SAVINGS_ACCOUNT"
]

created_atstring date

Example:2022-05-05

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

created_at__gtstring date

Example:2022-05-05

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

created_at__gtestring date

Example:2022-05-04

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

created_at__ltstring date

Example:2022-04-01

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

created_at__ltestring date

Example:2022-03-30

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

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

currencystring

Example:BRA

Return results that hold finances or balances in only this three-letter currency code.

currency__instring[]

Return results that have funds or balances in one of these three-letter currency codes.

[
  "BRA"
]

idstring uuid

Example:24ccab1d-3a86-4136-a6eb-e04bf52b356f

Return information only for this resource id.

id__instring[]

Return information for these resource ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]

institutionstring

Example:planet_mx_retail

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

institution__instring[]

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

[
  "planet_mx_retail"
]

namestring

Example:Cuenta Perfiles- M.N. - MXN-666

Return accounts with exactly this internal (specified by the institution) name.

name__icontainsstring

Example:Perfiles

Return accounts partially matching this internal name (specified by the institution).

numberstring

Example:4057068115181

Return information only for this account number (as specified by the institution).

number__instring[]

Return information for these account numbers (as specified by the institution).

[
  "4057068115181"
]

public_identification_namestring

Example:CLABE

Return information only for this type of account ID. For example, CLABE accounts.

public_identification_valuestring

Example:150194683119900273

Return information only for this account ID. For example, the account number for a CLABE account.

typestring

Example:Cuentas de efectivo

Return information only for accounts matching this account type, as designated by the institution.

Response

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
      "institution": {
        "name": "erebor_mx_retail"
      },
      "collected_at": "2022-02-09T08:45:50.406032Z",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "last_accessed_at": "2021-03-09T10:28:40.000Z",
      "category": "CHECKING_ACCOUNT",
      "balance_type": "ASSET",
      "overdraft": {
        "arranged": 5000.5,
        "used": 1000.5,
        "unarranged": 300.1
      },
      "type": "STANDARD_NACIONAL",
      "subtype": "FINANCIAMENTO_HABITACIONAL_SFH",
      "name": "Cuenta Perfiles- M.N. - MXN-666",
      "number": "4057068115181",
      "agency": "6272",
      "check_digit": "7",
      "balance": {
        "current": 5874.13,
        "available": 5621.12,
        "blocked": 60.32,
        "automatically_invested": 131.5
      },
      "currency": "BRL",
      "public_identification_name": "AGENCY/ACCOUNT",
      "public_identification_value": "0444/45722-0",
      "internal_identification": "92792126019929279212650822221989319252576",
      "credit_data": {
        "collected_at": "2022-02-09T08:45:50.406032Z",
        "credit_limit": 192000.9,
        "limits": [
          {
            "identification_number": "4453",
            "credit_limit": 1000.04,
            "used_amount": 400.04,
            "available_amount": 600,
            "type": "TOTAL_LIMIT",
            "consolidation_type": "INDIVIDUAL",
            "line_name": "CREDITO_A_VISTA",
            "line_name_additional_info": "Informações adicionais e complementares"
          }
        ],
        "cutting_date": "2019-12-11",
        "minimum_payment": 2400.3,
        "network": "MASTERCARD",
        "network_additional_info": "It's an orange card.",
        "cards": [
          {
            "identification_number": "4453"
          }
        ]
      },
      "loan_data": {
        "collected_at": "2022-02-09T08:45:50.406032Z",
        "loan_code": "92792126019929279212650822221989319252576",
        "contract_amount": 202000,
        "total_effective_cost": 209000,
        "loan_type": "HOME_EQUITY",
        "outstanding_balance": 182000,
        "interest_rates": [
          {
            "name": "NOMINAL",
            "type": "MONTHLY",
            "value": 7.85,
            "interest_rate_data": {
              "tax_type": "NOMINAL",
              "rate_type": "SIMPLE",
              "type": "MONTHLY",
              "calculation_base": "30/360",
              "reference_index_type": "FLOATING",
              "reference_index_subtype": "TR_TBF",
              "reference_index_info": "Additional information",
              "pre_fixed_rate": 0.062,
              "post_fixed_rate": 0.062,
              "additional_info": "Additional information"
            }
          }
        ],
        "fees": [
          {
            "value": 5.6,
            "name": "Renovação de cadastro",
            "code": "CADASTRO",
            "fee_charge_type": "SINGLE",
            "fee_charge": "FIXED",
            "rate": 0.062
          }
        ],
        "contracted_charges": [
          {
            "type": "LATE_PAYMENT_INTEREST_FEE",
            "info": "Late fee",
            "rate": 0.062
          }
        ],
        "collaterals": [
          {
            "type": "OPERACOES_GARANTIDAS_PELO_GOVERNO",
            "subtype": "CCR_CONVENIO_CREDITOS_RECIPROCOS",
            "currency": "BRL",
            "amount": 45391.89
          }
        ],
        "balloon_payments": [
          {
            "due_date": "2021-09-06",
            "currency": "BRL",
            "amount": 45391.89
          }
        ],
        "installments_contract_term_frequency": "MONTH",
        "installment_frequency": "MONTHLY",
        "installment_frequency_info": "Both the term and requency are the same.",
        "first_installment_due_date": "2020-03-01",
        "number_of_installments_total": 60,
        "number_of_installments_outstanding": 48,
        "number_of_installments_paid": 32,
        "number_of_installments_past_due": 2,
        "disbursement_dates": [
          "2021-09-23"
        ],
        "settlement_date": "2021-09-23",
        "contract_start_date": "2020-03-01",
        "contract_end_date": "2027-10-01",
        "contract_remaining_frequency": "MONTH",
        "contract_remaining_total": 20,
        "amortization_schedule": "SEM_SISTEMA_AMORTIZACAO",
        "amortization_schedule_info": "No need for a schedule.",
        "consignee_id": "60500998000135",
        "contract_number": "1324926521496"
      }
    }
  ]
}