# List transactions ## ▶️ Usage With the List Transactions method, you can: 1. List transactions related to a specific (using the query parameter). 2. Filter the returned transactions using query parameters (see the Filtering responses section below). 3. Get the details of a specific (using the query parameter along with the query parameter). ## 📖 Pagination This method returns a paginated response (default: 100 items per page). You can use the query parameter to increase the number of items returned to a maximum of 1000 items. You can use the query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article. ## 🔦 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 Filtering responses article. Endpoint: GET /api/transactions/ Version: 1.222.0 Security: basicAuth ## Query parameters: - `link` (string, required) The you want to filter by. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `page_size` (integer) 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). Example: 100 - `page` (integer) A page number within the paginated result set. Example: 1 - `omit` (string) Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article. - `fields` (string) Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article. - `link__in` (array) Return results only for these s. Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"] - `account` (string) The you want to filter by. ℹ️ We highly recommend adding either the or the filters in order to improve your performance. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `account__in` (array) Return results only for these s. Example: ["85b77707-90ef-46fd-9059-5a757f24247a"] - `account__balance__available` (number) Return transactions that have a matching exactly this value. Example: 4000.02 - `account__balance__available__lt` (number) Return transactions that have a less than this value. Example: 6000.02 - `account__balance__available__lte` (number) Return transactions that have a less than or equal to this value. Example: 5999.02 - `account__balance__available__gt` (number) Return transactions that have a more than this value. Example: 6000.02 - `account__balance__available__gte` (number) Return transactions that have a more than or equal to this value. Example: 5999.02 - `account__balance__available__range` (array) Return transactions that have a within a range of two values. Example: [4350.02] - `account__balance__current` (number) Return transactions that have a matching exactly this value. Example: 4000.02 - `account__balance__current__gt` (number) Return transactions that have a greater than this value. Example: 4020.02 - `account__balance__current__gte` (number) Return transactions that have a greater than or equal to this value. Example: 4019.02 - `account__balance__current__lt` (number) Return transactions that have a less than this value. Example: 3000.02 - `account__balance__current__lte` (number) Return transactions that have a less than or equal to this value. Example: 2999.02 - `account__balance__current__range` (array) Return transactions that have a within a range of two values. Example: [4350] - `account_type` (string) Return information only for transactions matching this account type, as designated by the institution. Example: "Cuentas de efectivo" - `account_type__in` (array) Return information only for transactions matching these account types, as designated by the institution. Example: ["Depositos Ahorro"] - `accounting_date` (string) Return transactions that were processed by the institution on exactly this date (). Example: "2022-05-05" - `accounting_date__gt` (string) Return transactions that were processed by the institution after this date (). Example: "2022-05-06" - `accounting_date__gte` (string) Return transactions that were processed by the institution on this date () or later. Example: "2022-05-04" - `accounting_date__lt` (string) Return transactions that were processed by the institution before this date (). Example: "2022-03-02" - `accounting_date__lte` (string) Return transactions that were processed by the institution on this date () or earlier. Example: "2022-03-01" - `accounting_date__range` (array) Return transactions that were processed by the institution in this date range (). Example: ["2022-05-06"] - `amount` (number) Return results only for this value. Example: 1000.02 - `amount__gt` (number) Return results only for more than this amount. Example: 1000.02 - `amount__gte` (number) Return results only for and more than this amount. Example: 1000.02 - `amount__lt` (number) Return results only for less than this amount. Example: 1000.02 - `amount__lte` (number) Return results only for this amount or less. Example: 1000.02 - `amount__range` (array) Return results between this amount range. Example: [2000.02] - `collected_at` (string) Return items that were retrieved from the institution on this date ( or full timestamp). Example: "2022-05-01" - `collected_at__gt` (string) Return items that were retrieved from the institution after this date ( or full timestamp). Example: "2022-05-05" - `collected_at__gte` (string) Return items that were retrieved from the institution after or on this date ( or full timestamp). Example: "2022-05-04" - `collected_at__lt` (string) Return items that were retrieved from the institution before this date ( or full timestamp). Example: "2022-04-01" - `collected_at__lte` (string) Return items that were retrieved from the institution before or on this date ( or full timestamp). Example: "2022-03-30" - `collected_at__range` (array) Return items that were retrieved from the institution between two dates ( or full timestamp). Example: ["2022-05-04"] - `created_at` (string) Return items that were last updated in Belvo's database on this date (in format). Example: "2022-05-05" - `created_at__gt` (string) Return items that were last updated in Belvo's database after this date (in format). Example: "2022-05-05" - `created_at__gte` (string) Return items that were last updated in Belvo's database after or on this date (in format). Example: "2022-05-04" - `created_at__lt` (string) Return items that were last updated in Belvo's database before this date (in format). Example: "2022-04-01" - `created_at__lte` (string) Return items that were last updated in Belvo's database before or on this date (in format). Example: "2022-03-30" - `created_at__range` (array) Return accounts that were last updated in Belvo's database between two dates (in format). Example: ["2022-03-03"] - `currency` (string) Return results that hold finances or balances in only this three-letter currency code. Example: "BRA" - `currency__in` (array) Return results that have funds or balances in one of these three-letter currency codes. Example: ["BRA"] - `credit_card_data__bill_name__in` (array) Return transactions for one of these bill names. Example: ["feb-2022"] - `reference` (string) Returns transactions with this institution-assigned reference number. Example: "085904452810319225" - `reference__in` (array) Returns transactions with these institution-assigned reference numbers. Example: ["085904452810319225"] - `status` (string) Return transactions with this status. Can be either , , or . Example: "PENDING" - `status__in` (array) Return transactions with these statuses. Can be either , , or . Example: ["PROCESSED"] - `type` (string) Return transactions with this type. Can be either or . Enum: "OUTFLOW", "INFLOW" - `type__in` (array) Return transactions with this types. Can be either or . Enum: "OUTFLOW", "INFLOW" - `value_date` (string) Return results for exactly this date (). Example: "2022-05-05" - `value_date__gt` (string) Return results that occurred after this date (). Example: "2022-05-06" - `value_date__gte` (string) Return results for this date () or later. Example: "2022-05-04" - `value_date__lt` (string) Return results for before this date (). Example: "2022-03-02" - `value_date__lte` (string) Return results for this date () or earlier. Example: "2022-03-01" - `value_date__range` (array) Return results for this date () range. Example: ["2022-05-06"] ## Response 200 fields (application/json): - `count` (integer) The total number of results in your Belvo account. Example: 130 - `next` (string,null) 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 . In our documentation example, we use as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, or ). Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2" - `previous` (string,null) The URL to the previous page of results. If there is no previous page, the value is . - `results` (array) Array of transaction objects (OFDA Brazil). - `results.id` (string, required) Belvo's unique identifier for the current item. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `results.internal_identification` (string, required) The institution's internal identification for the transaction. > A value must be returned by Brazil's open finance network. Example: "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl" - `results.account` (object,null, required) Details regarding the account. - `results.account.link` (string,null, required) The the data belongs to. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `results.account.institution` (object, required) Details regarding the institution. - `results.account.institution.name` (string) The name of the institution, as designated by Belvo. Example: "erebor_mx_retail" - `results.account.institution.type` (string) The type of institution. We return one of the following values: - - - Enum: "bank", "fiscal", "employment" - `results.account.collected_at` (string, required) The ISO-8601 timestamp when the data point was collected. Example: "2022-02-09T08:45:50.406032Z" - `results.account.created_at` (string, required) The ISO-8601 timestamp of when the data point was created in Belvo's database. Example: "2022-02-09T08:45:50.406032Z" - `results.account.last_accessed_at` (string,null, required) The ISO-8601 timestamp of Belvo's most recent successful access to the institution for the given link. Example: "2021-03-09T10:28:40.000Z" - `results.account.category` (string,null, required) The type of account. We return one of the following enum values: - - - - - - - - - - Enum: "ADVANCE_DEPOSIT_ACCOUNT", "CHECKING_ACCOUNT", "CREDIT_CARD", "FINANCING_ACCOUNT", "INVESTMENT_ACCOUNT", "INVOICE_FINANCING_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED" - `results.account.balance_type` (string,null, required) Indicates whether this account is either an or a . You can consider the balance of an as being positive, while the balance of a as negative. Example: "ASSET" - `results.account.overdraft` (object,null) - `results.account.overdraft.arranged` (number, required) The agreed upon overdraft limit between the account holder and the institution. > A value must be returned by Brazil's open finance network if the field is available. Example: 5000.5 - `results.account.overdraft.used` (number, required) The overdraft value used. > A value must be returned by Brazil's open finance network if the field is available. Example: 1000.5 - `results.account.overdraft.unarranged` (number, required) The overdraft used that was not arranged between the account holder and the institution. > A value must be returned by Brazil's open finance network if the field is available. Example: 300.1 - `results.account.type` (string, required) The account type, as designated by the institution. > A value must be returned by Brazil's open finance network. Example: "STANDARD_NACIONAL" - `results.account.subtype` (string, required) The account subtype, as designated by the institution. > A value must be returned by Brazil's open finance network. Example: "FINANCIAMENTO_HABITACIONAL_SFH" - `results.account.name` (string,null, required) The account name, as given by the institution. Example: "Cuenta Perfiles- M.N. - MXN-666" - `results.account.number` (string,null, required) The account number, as designated by the institution. Example: "4057068115181" - `results.account.agency` (string,null, required) The branch code where the product was opened. Example: "6272" - `results.account.check_digit` (string,null, required) The check digit of the product's number, if applicable. Example: "7" - `results.account.balance` (object, required) Details regarding the current and available balances for the account. - `results.account.balance.current` (number,null, required) The current balance is calculated differently according to the type of account. - : The user's account balance at the timestamp. - : The amount the user has spent in the current card billing period (see for information on when the current billing period finishes). - : The amount remaining to pay on the users's loan. Example: 5874.13 - `results.account.balance.available` (number,null) The balance that the account owner can use. - : The available balance may be different to the balance due to pending transactions. - : The credit amount the user still has available for the current period. The amount is calculated as minus . - : The present value required to pay off the loan, as provided by the institution. If the institution does not provide this value, we return . Example: 5621.12 - `results.account.balance.blocked` (number) The amount that is currently blocked due to pending transactions. > A value must be returned by Brazil's open finance network if the field is available. Example: 60.32 - `results.account.balance.automatically_invested` (number) The amount that is automatically invested (as agreed upon with the institution). > A value must be returned by Brazil's open finance network if the field is available. Example: 131.5 - `results.account.currency` (string, required) The three-letter currency code (ISO-4217). > A value must be returned by Brazil's open finance network if the field is available. Example: "BRL" - `results.account.public_identification_name` (string,null, required) The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be . Example: "AGENCY/ACCOUNT" - `results.account.public_identification_value` (string,null, required) The value for the . For 🇧🇷 OFDA Brazilian savings and checking accounts, this field will be the agency and bank account number, separated by a slash. For example: . 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" Example: "0444/45722-0" - `results.account.internal_identification` (string, required) The institution's internal identification for the account. > A value must be returned by Brazil's open finance network if the field is available. Example: "92792126019929279212650822221989319252576" - `results.account.credit_data` (object,null, required) Details regarding the credit cards associated with this account. - `results.account.credit_data.credit_limit` (number,null, required) The upper credit limit of the card. > A value must be returned by Brazil's open finance network. Example: 192000.9 - `results.account.credit_data.limits` (array) - `results.account.credit_data.limits.identification_number` (string,null, required) The credit card number. Often, this is just the last four digit of the credit card. > A value must be returned by Brazil's open finance network. Example: "4453" - `results.account.credit_data.limits.credit_limit` (number,null, required) The limit of the credit card. Example: 1000.04 - `results.account.credit_data.limits.used_amount` (number,null, required) The amount used. Example: 400.04 - `results.account.credit_data.limits.available_amount` (number, required) The amount still available. > A value must be returned by Brazil's open finance network. Example: 600 - `results.account.credit_data.limits.is_limit_flexible` (boolean, required) Boolean to indicate if the is flexible. > A value must be returned by Brazil's open finance network. - `results.account.credit_data.limits.type` (string, required) The type of limit. We return one of the following values: - - > A value must be returned by Brazil's open finance network. Enum: "TOTAL_LIMIT", "MODAL_LIMIT" - `results.account.credit_data.limits.consolidation_type` (string, required) Indicates whether or not the credit limit is consolidated or individual. > A value must be returned by Brazil's open finance network. Example: "INDIVIDUAL" - `results.account.credit_data.limits.line_name` (string,null, required) The credit limit line name. Example: "CREDITO_A_VISTA" - `results.account.credit_data.limits.line_name_additional_info` (string,null, required) Additional information about the line name. Example: "Informações adicionais e complementares" - `results.account.credit_data.cutting_date` (string,null) The date when the credit card's bill is due. Example: "2019-12-11" - `results.account.credit_data.minimum_payment` (number,null) The minimum amount that the account owner needs to pay in the current credit period. Example: 2400.3 - `results.account.credit_data.network` (string) The credit network that the card is associated with. We return one of the following values: - - - - - - - - - > A value must be returned by Brazil's open finance network. Enum: "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DINERS_CLUB", "HIPERCARD", "BANDEIRA_PROPRIA", "CHEQUE_ELETRONICO", "ELO", "OTHER" - `results.account.credit_data.network_additional_info` (string,null) Additional information about the credit card network. Example: "It's an orange card." - `results.account.credit_data.cards` (array) Details regarding the cards associated with the account. - `results.account.credit_data.cards.is_multiple` (boolean, required) Boolean to indicate if this account has multiple credit cards. > A value must be returned by Brazil's open finance network. - `results.account.credit_data.next_payment_date` (string,null) This field is not applicable for OF Brazil and will return null. - `results.account.credit_data.no_interest_payment` (number,null) This field is not applicable for OF Brazil and will return null. - `results.account.credit_data.interest_rate` (number,null) This field is not applicable for OF Brazil and will return null. - `results.account.credit_data.monthly_payment` (number,null) This field is not applicable for OF Brazil and will return null. - `results.account.credit_data.last_payment_date` (string,null) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data` (object,null, required) The loan options associated with this account. - `results.account.loan_data.loan_code` (string, required) The country-specific standardized contract number. > A value must be returned by Brazil's open finance network. Example: "92792126019929279212650822221989319252576" - `results.account.loan_data.contract_amount` (number,null, required) The initial total loan amount when the contract was signed, calculated by the institution. This amount includes the principal + interest + taxes + fees. Example: 202000 - `results.account.loan_data.total_effective_cost` (number,null) The initial total effective cost of the loan. Example: 209000 - `results.account.loan_data.loan_type` (string, required) The type of the loan, according to the institution. > A value must be returned by Brazil's open finance network. Example: "HOME_EQUITY" - `results.account.loan_data.outstanding_balance` (number,null, required) The amount remaining to pay in total, including interest. Example: 182000 - `results.account.loan_data.interest_rates` (array, required) Breakdown of the interest applied to the loan. With OF Brazil, we highly recommend using the information in for in-depth information. > A value must be returned by Brazil's open finance network. - `results.account.loan_data.interest_rates.name` (string,null, required) The name of the type of interest rate applied to the loan. For OFDA Brazil, we recommend you use the parameter. Example: "NOMINAL" - `results.account.loan_data.interest_rates.type` (string, required) The period that the interest is applied to the loan. > A value must be returned by Brazil's open finance network. Enum: "MONTHLY", "YEARLY" - `results.account.loan_data.interest_rates.value` (number,null, required) The interest rate (in percent or currency value). For OFDA Brazil, we recommend you use the and parameter. Example: 7.85 - `results.account.loan_data.interest_rates.interest_rate_data` (object,null, required) Detailed information regarding the interest rate. - `results.account.loan_data.interest_rates.interest_rate_data.tax_type` (string, required) The type of interest rate tax. We return one of the following values: - - > A value must be returned by Brazil's open finance network. Enum: "NOMINAL", "EFFECTIVE" - `results.account.loan_data.interest_rates.interest_rate_data.rate_type` (string, required) The type of interest rate. We return one of the following values: - - > A value must be returned by Brazil's open finance network. Enum: "SIMPLE", "COMPOUND" - `results.account.loan_data.interest_rates.interest_rate_data.calculation_base` (string, required) The base calculation for the interest rate. > A value must be returned by Brazil's open finance network. Example: "30/360" - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_type` (string, required) The reference index rate. We return one of the following values: - - - - - - - > A value must be returned by Brazil's open finance network. Enum: "WITHOUT_INDEX_TYPE", "PRE_FIXED", "POST_FIXED", "FLOATING", "INDEXED_PRICE", "RURAL_CREDIT", "OTHER_INDEX" - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_subtype` (string,null, required) The subtype of the reference index rate. Example: "TR_TBF" - `results.account.loan_data.interest_rates.interest_rate_data.reference_index_info` (string,null, required) Additional information regarding the reference index rate. Example: "Additional information" - `results.account.loan_data.interest_rates.interest_rate_data.pre_fixed_rate` (number, required) The pre-fixed percentage rate of the interest rate. > A value must be returned by Brazil's open finance network. Example: 0.062 - `results.account.loan_data.interest_rates.interest_rate_data.post_fixed_rate` (number, required) The post-fixed percentage rate of the interest rate. > A value must be returned by Brazil's open finance network. Example: 0.062 - `results.account.loan_data.interest_rates.interest_rate_data.additional_info` (string,null, required) Additional information regarding the interest rate. Example: "Additional information" - `results.account.loan_data.fees` (array,null, required) Breakdown of the fees applied to the loan. - `results.account.loan_data.fees.type` (string,null, required) This field is not applicable for OF Brazil and will return null. Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS", null - `results.account.loan_data.fees.value` (number,null, required) The total value of the fee. Same currency as the loan. Example: 5.6 - `results.account.loan_data.fees.name` (string, required) The fee name. > A value must be returned by Brazil's open finance network if the field is available. Example: "Renovação de cadastro" - `results.account.loan_data.fees.code` (string, required) The fee code. > A value must be returned by Brazil's open finance network if the field is available. Example: "CADASTRO" - `results.account.loan_data.fees.fee_charge_type` (string, required) Indicates the type of charge. We return one of the following values: - - > A value must be returned by Brazil's open finance network if the field is available. Enum: "SINGLE", "PER_INSTALLMENT" - `results.account.loan_data.fees.fee_charge` (string, required) Billing method, as agreed upon with the institution. We return one of the following values: - - - - > A value must be returned by Brazil's open finance network if the field is available. Enum: "MINIMUM", "MAXIMUM", "FIXED", "PERCENTAGE" - `results.account.loan_data.fees.rate` (number,null, required) The percentage rate of the fee. Required when is set to . Example: 0.062 - `results.account.loan_data.contracted_charges` (array,null) - `results.account.loan_data.contracted_charges.type` (string) The type of contracted charge. We return one of the following values: - - - - - - - > A value must be returned by Brazil's open finance network if the field is available. Enum: "LATE_PAYMENT_INTEREST_FEE", "LATE_PAYMENT_PENALTY_FEE", "DEFAULT_INTEREST_FEE", "LOAN_CONTRACT_TAX", "LATE_PAYMENT_TAX", "NO_CHARGE", "OTHER" - `results.account.loan_data.contracted_charges.info` (string,null) Additional information regarding the contracted charge. Example: "Late fee" - `results.account.loan_data.contracted_charges.rate` (number,null) The percentage rate of the charge, calculated based on the amount of the loan. Example: 0.062 - `results.account.loan_data.collaterals` (array,null, required) Details regarding any loan collaterals that the individual or business supplied. - `results.account.loan_data.collaterals.type` (string, required) The type of collateral, as defined by the institution. > A value must be returned by Brazil's open finance network if the field is available. Example: "OPERACOES_GARANTIDAS_PELO_GOVERNO" - `results.account.loan_data.collaterals.subtype` (string, required) The subtype of the collateral, as defined by the institution. > A value must be returned by Brazil's open finance network if the field is available. Example: "CCR_CONVENIO_CREDITOS_RECIPROCOS" - `results.account.loan_data.collaterals.amount` (number, required) The total amount of the bill. > A value must be returned by Brazil's open finance network if the field is available. Example: 45391.89 - `results.account.loan_data.balloon_payments` (array,null, required) Detailed information regarding any balloon payments for the loan, if applicable. - `results.account.loan_data.balloon_payments.due_date` (string,null, required) The date that the balloon payment is to be paid, in format. Example: "2021-09-06" - `results.account.loan_data.balloon_payments.currency` (string,null, required) The three-letter currency code (ISO-4217). Example: "BRL" - `results.account.loan_data.balloon_payments.amount` (number,null, required) The total amount of the balloon payment. Example: 45391.89 - `results.account.loan_data.installments_contract_term_frequency` (string,null, required) The frequency of contracted installment payments, as defined when the contract was first signed. We return one of the following: - - - - - - Enum: "DAY", "WEEK", "MONTH", "YEAR", "NO_DEADLINE_REMAINING", null - `results.account.loan_data.installment_frequency` (string, required) The frequency that the installments are paid. We return one of the following values: - - - - - - - - - > A value must be returned by Brazil's open finance network. Enum: "IRREGULAR", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "BIANNUALLY", "ANNUALLY", "OTHER" - `results.account.loan_data.installment_frequency_info` (string,null, required) Additional information regarding the . Example: "Both the term and requency are the same." - `results.account.loan_data.first_installment_due_date` (string,null, required) The date when the first installment of the loan is to be paid, in format. Example: "2020-03-01" - `results.account.loan_data.number_of_installments_total` (integer,null, required) The total number of installments required to pay the loan. Example: 60 - `results.account.loan_data.number_of_installments_outstanding` (integer,null, required) The number of installments left to pay. Example: 48 - `results.account.loan_data.number_of_installments_paid` (integer,null, required) The number of installments already paid. Example: 32 - `results.account.loan_data.number_of_installments_past_due` (integer,null, required) The number of installments that are overdue. Example: 2 - `results.account.loan_data.disbursement_dates` (array,null, required) An array of dates when the loan was disbursed. Example: ["2021-09-23"] - `results.account.loan_data.settlement_date` (string,null, required) The date that the loan was settled, in format. Example: "2021-09-23" - `results.account.loan_data.contract_start_date` (string, required) The date when the loan contract was signed, in format. > A value must be returned by Brazil's open finance network. Example: "2020-03-01" - `results.account.loan_data.contract_end_date` (string,null, required) The date when the loan is expected to be completed, in format. Example: "2027-10-01" - `results.account.loan_data.contract_remaining_frequency` (string,null, required) The frequency of the remaining contracted installment payments, as defined when the contract was first signed. We return one of the following: - - - - - - Enum: "DAY", "WEEK", "MONTH", "YEAR", "NO_DEADLINE_REMAINING", null - `results.account.loan_data.contract_remaining_total` (integer,null, required) The total number of installments remaining on the loan. Example: 20 - `results.account.loan_data.amortization_schedule` (string, required) The loan amortization schedule. > A value must be returned by Brazil's open finance network. Example: "SEM_SISTEMA_AMORTIZACAO" - `results.account.loan_data.amortization_schedule_info` (string,null, required) Additional information regarding the . Example: "No need for a schedule." - `results.account.loan_data.consignee_id` (string,null, required) The ID of the consignee of the loan. Example: "60500998000135" - `results.account.loan_data.contract_number` (string,null, required) The contract number of the loan, as given by the institution. Example: "1324926521496" - `results.account.loan_data.principal` (number,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.payment_day` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.outstanding_principal` (number,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.credit_limit` (number,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.last_period_balance` (number,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.limit_day` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.cutting_day` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.loan_data.cutting_date` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.account.funds_data` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.value_date` (string, required) The date when the transaction occurred, in format, in format. > A value must be returned by Brazil's open finance network. Example: "2019-10-23" - `results.transacted_at` (string) The ISO-8601 timestamp of when the transaction occurred (in the UTC timezone). > For transactions that occurred before 31.01.2024, the timestamp may only indicate the day (for example, ). However, transactions that occurred after this date must include the date and time (). > > Some institutions may not provide the exact time of the transaction. In this case, the timestamp will be set to . > Belvo has identified the following institutions as not abiding by the regulation and have raised the issue with regulators: Bradesco, Itau, and Sicoob. > A value must be returned by Brazil's open finance network for . Example: "2024-02-20T12:29:03.374Z" - `results.accounting_date` (string,null, required) The date when the transaction was processed and accounted for by the institution, in format. > A value must be returned by Brazil's open finance network for . Example: "2019-10-23" - `results.inferred_accounting_date` (string) In the case that the transaction occured on a weekend or public holiday, Belvo will infer the date that the transaction is accounted for by the institution. Typically, this is the next business day. Example: "2019-10-23" - `results.amount` (number, required) The transaction amount. ℹ️ The amount displayed is always positive as we indicate the direction of the transaction in the parameter. > A value must be returned by Brazil's open finance network. Example: 2145.45 - `results.local_currency_amount` (number,null, required) The value of the transaction in the local currency. > A value must be returned by Brazil's open finance network for . Example: 7623.64 - `results.balance` (number,null, required) This field is not applicable for OF Brazil and will return null. - `results.description` (string,null, required) The description of transaction provided by the institution. Usually this is the text that the end user sees in the online platform. > A value must be returned by Brazil's open finance network. Example: "SEVEN BUDDHAS RFC:XXXXXXXXXX" - `results.observations` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.merchant` (object,null, required) Additional data regarding the merchant involved in the transaction. We only return merchant information for new transactions made from or accounts. > We retrieve the merchant information for a transaction as part of our Transaction categorization product, turning raw data into actionable insights. To enable this product, just reach out to us, and we'll get right to it. - `results.merchant.logo` (string,null) The URL to the merchant's logo. Example: "https://logo.clearbit.com/asesor-contable.es" - `results.merchant.website` (string,null) The URL to the merchant's website. Example: "https://merchants-r-us.com" - `results.merchant.merchant_name` (string) The name of the merchant. Example: "Merchants R Us Global" - `results.category` (string,null, required) The name of the transaction category. > With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it. We return one of the following enum values: - - - - - - - - - - - - - - - * - - \* For clients not using our Transaction Categorization product, we return instead. Enum: "Bills & Utilities", "Credits & Loans", "Deposits", "Fees & Charges", "Food & Groceries", "Home & Life", "Income & Payments", "Insurance", "Investments & Savings", "Online Platforms & Leisure", "Personal Shopping", "Taxes", "Transfers", "Transport & Travel", "Unknown", "Withdrawal & ATM", null - `results.subcategory` (string,null, required) The transaction subcategory. > For clients not using our Transaction categorization, we return instead. To enable this feature, just reach out to us, and we'll get right to it. We return one of the following enum values: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enum: "Electricity & Energy", "Rent", "Telecommunications", "Water", "Auto", "Credit Card", "Instalment", "Interest & Charges", "Mortgage", "Pay Advance", "Personal", "Adjustments", "Bank Fees", "Chargeback", "Refund", "Blocked Balances", "Alimony", "Alcohol & Tobacco", "Bakery & Coffee", "Bars & Nightclubs", "Convenience Store", "Delivery", "Groceries", "Restaurants", "Education", "Gyms & Fitness", "Hair & Beauty", "Health", "Home Decor & Appliances", "Laundry & Dry Cleaning", "Pharmacies", "Professional Services", "Veterinary Services", "Freelance", "Interest", "Retirement", "Salary", "Government", "Home Insurance", "Auto Insurance", "Health & Life Insurance", "Savings", "Fixed income", "Equity", "Investment Funds", "Derivatives", "Cryptocurrencies", "Apps, Software and Cloud Services", "Events, Parks and Museums", "Gambling", "Gaming", "Lottery", "Movie & Audio", "Books & News", "Clothing & Accessories", "Department Store", "Electronics", "E-commerce", "Gifts", "Office Supplies", "Pet Supplies", "Auto Tax & Fees", "Donation", "Government Fees", "Income Tax", "Real Estate Tax & Fees", "Tax Return", "Accommodation", "Auto Expenses", "Auto Rental", "Flights", "Gas", "Mileage Programs", "Parking & Tolls", "Public Transit", "Taxis & Rideshares", "Other", null - `results.reference` (string,null, required) This field is not applicable for OF Brazil and will return null. - `results.type` (string,null, required) The direction of the transaction: - indicates money coming into the account. - indicates money going out of the account. - when no information was present regarding the direction of the transaction. Enum: "OUTFLOW", "INFLOW", null - `results.status` (string,null, required) The status of the transaction. We return one of the following values: - (The transaction has been processed by the institution.) - (The institution clearly states that the transaction has not yet been processed.) - (deprecated) - (deprecated) Enum: "PENDING", "PROCESSED", "UNCATEGORIZED", null - `results.credit_card_data` (object,null, required) Additional data provided by the institution for credit card transactions. - `results.credit_card_data.bill_name` (string,null, required) The title of the monthly credit card bill the transaction belongs to. The format of the returned value is institution specific, however, some common examples are: - diciembre-2021 - dec-2021 - dec-21 > : This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return . Example: "apr-2020" - `results.credit_card_data.bill_due_date` (string,null) The date that the bill is due to be paid, in format. > : This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return . Example: "2023-06-17" - `results.credit_card_data.bill_internal_identification` (string,null) The institution's internal identifier for the bill. > : This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return . Example: "927921260199292792126508222219893192525A6" - `results.credit_card_data.bill_status` (string,null, required) This field is not applicable for OFDA Brazil and will return . - `results.credit_card_data.previous_bill_total` (string,null, required) This field is not applicable for OFDA Brazil and will return . - `results.credit_card_data.bill_amount` (number,null, required) The bill amount, as of . For more information, see . Example: 300 - `results.credit_card_data.card_number` (string, required) The credit card number. Often, this is just the last four digit of the credit card. > A value must be returned by Brazil's open finance network. Example: "4453" - `results.credit_card_data.fee_type` (string,null, required) The fee that can be charged for a card transaction. We return one of the following values: - - - - - - - - - Enum: "ANNUAL_FEE", "NATIONAL_WITHDRAWAL", "INTERNATIONAL_WITHDRAWAL", "EMERGENCY_CREDIT_EVALUATION_FEE", "DUPLICATE_ISSUANCE_FEE", "PAYMENT_FEE", "SMS_FEE", "OTHERS", null - `results.credit_card_data.fee_type_additional_info` (string,null, required) Additional information regarding the fee. Example: "ATM withdrawal in Curitiba." - `results.credit_card_data.credits_type` (string,null, required) Other types of credit that have been contracted on the card. We return one of the following values: - - - - - Enum: "REVOLVING_CREDIT", "BILL_INSTALLMENT_PAYMENT", "LOAN", "OTHERS", null - `results.credit_card_data.credits_type_additional_info` (string,null, required) Additional information regarding the credit type. Example: "Some additional information." - `results.credit_card_data.installment_identifier` (string, required) An identifier for the installment, according to the institution. > A value must be returned by Brazil's open finance network. Example: "PARCELA_896" - `results.credit_card_data.number_of_installments` (integer,null, required) The total number of installments for the card transaction, if applicable. Example: 4 - `results.credit_card_data.credit_card_bill` (object,null) Information regarding the bill that this transaction appears on. - `results.credit_card_data.credit_card_bill.id` (string) The unique identifier created by Belvo used to reference the current credit card bill. > : This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return . Example: "8e9d13c2-af41-4a49-b43e-2da012bd1d11" - `results.credit_card_data.credit_card_bill.internal_identification` (string,null) The institution's internal identifier for the bill. > : This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return . Example: "92792126019929279212650822221989319252576" - `results.counterparty` (object,null, required) Information regarding the other party of this transaction, if available. - `results.counterparty.type` (string,null, required) The transaction counterparty type. We return one of the following values: - - - Enum: "INDIVIDUAL", "COMPANY", null - `results.counterparty.document_number` (string,null, required) The document number of the representative. : For Brazil: - When the is , this is the CPF number. - When the is , this is the CNPJ number. Example: "73677831148" - `results.counterparty.clearing_code` (string,null, required) The banking clearing code. Example: "001" - `results.counterparty.agency` (string,null, required) The branch code where the account was opened. Example: "6272" - `results.counterparty.check_digit` (string,null, required) The check digit of the account number, if applicable. Example: "7" - `results.counterparty.number` (string,null, required) The account number of the product. Example: "24550245" - `results.loan_data` (object,null, required) Information regarding the loan transactional data, if applicable. - `results.loan_data.is_detached` (boolean, required) Boolean to indicate whether or not this loan payment was part of the original payment schedule. > A value must be returned by Brazil's open finance network. Example: true - `results.loan_data.installment_id` (string,null) The institution's unique ID for this payment installment. Example: "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH" - `results.loan_data.fees` (array, required) Details regarding the fees associated with this payment. Only applicable when = . - `results.loan_data.fees.name` (string, required) The name of the fee. > A value must be returned by Brazil's open finance network when the field is present. Example: "Reavaliação periódica do bem" - `results.loan_data.fees.code` (string, required) The institution's code for the fee. > A value must be returned by Brazil's open finance network when the field is present. Example: "aval_bem" - `results.loan_data.fees.amount` (number,null, required) The amount of the fee. > A value must be returned by Brazil's open finance network when the field is present. Example: 8903.77 - `results.loan_data.charges` (array, required) Details regarding the charges associated with this payment. Only applicable when = . - `results.loan_data.charges.type` (string, required) The type of charge. > A value must be returned by Brazil's open finance network when the field is present Example: "MULTA_ATRASO_PAGAMENTO" - `results.loan_data.charges.info` (string, required) Additional information regarding the charge . Example: "Late payment charge." - `results.loan_data.charges.amount` (number, required) The amount of the charge. > A value must be returned by Brazil's open finance network when the field is present Example: 8903.77 - `results.payment_type` (string,null, required) The transaction payment type. We return one of the following values: - - - Enum: "FULL", "INSTALLMENT", null - `results.operation_type` (string, required) The type of transaction. For example, a PIX payment or a deposit. > A value must be returned by Brazil's open finance network for . Example: "TRANSFERENCIA_MESMA_INSTITUICAO" - `results.operation_type_additional_info` (string,null, required) Additional information regarding the , if applicable. Example: "Internal transfer." - `results.mcc` (integer,null, required) The four-digit (ISO-18245 compliant) Merchant Category Code (MCC) for the transaction. This field is only applicable for credit card transactions. Example: 5137 ## Response 403 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied. Example: "access_to_resource_denied" - `message` (string) A short description of the error. For errors, the description is: - . Example: "You don't have access to this resource." - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 404 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. Example: "not_found" - `message` (string) A short description of the error. For errors, the description is: - Example: "Not found" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 408 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors. Example: "request_timeout" - `message` (string) A short description of the error. For errors, the description is: - . Example: "The request timed out, you can retry asking for less data by changing your query parameters" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 428 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 428 token_required errors. Example: "token_required" - `message` (string) A short description of the error. For errors, the description is: - . Example: "A MFA token is required by the institution to login" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" - `session` (string) A 32-character unique ID of the login session (matching a regex pattern of: ). Example: "2675b703b9d4451f8d4861a3eee54449" - `expiry` (integer) Session duration time in seconds. Example: 9600 - `link` (string) Unique identifier created by Belvo, used to reference the current Link. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `token_generation_data` (object) Details on how to generate the token. - `token_generation_data.instructions` (string) Instructions for token generation. Example: "Use this code to generate the token" - `token_generation_data.type` (string) Type of the data to generate the token (QR code, numeric challenge). Example: "numeric" - `token_generation_data.value` (string) Value to use to generate the token. Example: "12345" - `token_generation_data.expects_user_input` (boolean) Indicates whether the user needs to provide input in order to complete the authentication. When set to , your user may need to: - confirm the login on another device - scan a QR code You will still need to make a PATCH call to complete the request. Example: true ## Response 500 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors. Example: "unexpected_error" - `message` (string) A short description of the error. For errors, the description is: - . Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb"