Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Accounts

Complete an accounts request

Used to resume an Account retrieve session that was paused because an MFA token was required by the institution.

{% admonition type="info" %} This resource may return deprecated fields. Please check the response documentation for more information. {% /admonition %}

patch/api/accounts/

Query parameters

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.

Request body

sessionstring required

The session you want to resume. You need to use the session value that is provided in the 428 Token Required response that you receive after you make your POST request.

tokenstring

The MFA token generated by the institution which is required to continue a session.

linkstring uuid required

The link.id you want to resume. Must be the same link.id as the one you receive in the 428 Token Required response that contains the session ID.

save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Example request

{
  "session": "6e7b283c6efa449c9c028a16b5c249fa",
  "token": "1234ab",
  "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
  "save_data": true
}

Response

Ok (when save_data=false)

idstring uuid required

Belvo's unique identifier for the current item.

linkstring uuid nullable required

The link.id the data belongs to.

collected_atstring date-time required

The ISO-8601 timestamp when the data point was collected.

created_atstring date-time required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

last_accessed_atstring date-time nullable required

The ISO-8601 timestamp of Belvo's most recent successful access to the institution for the given link.

category'ADVANCE_DEPOSIT_ACCOUNT' | 'CHECKING_ACCOUNT' | 'CREDIT_CARD' | 'FINANCING_ACCOUNT' | 'INVESTMENT_ACCOUNT' | 'INVOICE_FINANCING_ACCOUNT' | 'LOAN_ACCOUNT' | 'PENSION_FUND_ACCOUNT' | 'SAVINGS_ACCOUNT' | 'UNCATEGORIZED' nullable required

The type of account. We return one of the following enum values:

  • ADVANCE_DEPOSIT_ACCOUNT
  • CHECKING_ACCOUNT
  • CREDIT_CARD
  • FINANCING_ACCOUNT
  • INVESTMENT_ACCOUNT
  • INVOICE_FINANCING_ACCOUNT
  • LOAN_ACCOUNT
  • PENSION_FUND_ACCOUNT
  • SAVINGS_ACCOUNT
  • UNCATEGORIZED
balance_typestring nullable required

Indicates whether this account is either an ASSET or a LIABILITY. You can consider the balance of an ASSET as being positive, while the balance of a LIABILITY as negative.

typestring required

The account type, as designated by the institution.

Non-nullable: A value must be returned by Brazil's open finance network.

subtypestring required

The account subtype, as designated by the institution.

Non-nullable: A value must be returned by Brazil's open finance network.

namestring nullable required

The account name, as given by the institution.

numberstring nullable required

The account number, as designated by the institution.

agencystring nullable required

The branch code where the product was opened.

check_digitstring nullable required

The check digit of the product's number, if applicable.

currencystring required

The three-letter currency code (ISO-4217).

Non-nullable: A value must be returned by Brazil's open finance network if the balances field is available.

public_identification_namestring nullable required

The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be AGENCY/ACCOUNT.

public_identification_valuestring nullable required

The value for the public_identification_name.

For 🇧🇷 OFDA Brazilian savings and checking accounts, this field will be the agency and bank account number, separated by a slash. For example: 0444/45722-0.

For 🇧🇷 OFDA Brazilian credit card accounts, we will return a string of concatenated credit card numbers associated with the account. For example: "8763,9076,5522"

internal_identificationstring required

The institution's internal identification for the account.

Non-nullable: A value must be returned by Brazil's open finance network if the balances field is available.

funds_datastring nullable required

Note: This field is not applicable for OF Brazil and will return null.

Example response

[
  {
    "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"
    }
  }
]