Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Transactions

List transactions

▶️ Usage

With the List Transactions method, you can:

  1. [Required] List transactions related to a specific link.id (using the link query parameter).
  2. Filter the returned transactions using query parameters (see the Filtering responses section below).
  3. Get the details of a specific transaction.id (using the id query parameter along with the link query parameter).

📖 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.

🔦 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.

get/api/transactions/

Query parameters

linkstring uuid required
Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The link.id you want to filter by.

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"
]
accountstring uuid
Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The account.id you want to filter by.

ℹ️ We highly recommend adding either the link.id or the account.id filters in order to improve your performance.

account__instring[]

Return results only for these account.ids.

[
  "85b77707-90ef-46fd-9059-5a757f24247a"
]
account__balance__availablenumber float
Example:4000.02

Return transactions that have a account.balance.available matching exactly this value.

account__balance__available__ltnumber float
Example:6000.02

Return transactions that have a account.balance.available less than this value.

account__balance__available__ltenumber float
Example:5999.02

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

account__balance__available__gtnumber float
Example:6000.02

Return transactions that have a account.balance.available more than this value.

account__balance__available__gtenumber float
Example:5999.02

Return transactions that have a account.balance.available more than or equal to this value.

account__balance__available__rangenumber[]

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

[
  100,
  5000
]
account__balance__currentnumber float
Example:4000.02

Return transactions that have a account.balance.current matching exactly this value.

account__balance__current__gtnumber float
Example:4020.02

Return transactions that have a account.balance.current greater than this value.

account__balance__current__gtenumber float
Example:4019.02

Return transactions that have a account.balance.current greater than or equal to this value.

account__balance__current__ltnumber float
Example:3000.02

Return transactions that have a account.balance.current less than this value.

account__balance__current__ltenumber float
Example:2999.02

Return transactions that have a account.balance.current less than or equal to this value.

account__balance__current__rangenumber[]

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

[
  100,
  5000
]
account_typestring
Example:Cuentas de efectivo

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

account_type__instring[]

Return information only for transactions matching these account types, as designated by the institution.

[
  "Depositos Ahorro"
]
accounting_datestring date
Example:2022-05-05

Return transactions that were processed by the institution on exactly this date (YYYY-MM-DD).

accounting_date__gtstring date
Example:2022-05-06

Return transactions that were processed by the institution after this date (YYYY-MM-DD).

accounting_date__gtestring date
Example:2022-05-04

Return transactions that were processed by the institution on this date (YYYY-MM-DD) or later.

accounting_date__ltstring date
Example:2022-03-02

Return transactions that were processed by the institution before this date (YYYY-MM-DD).

accounting_date__ltestring date
Example:2022-03-01

Return transactions that were processed by the institution on this date (YYYY-MM-DD) or earlier.

accounting_date__rangestring[]

Return transactions that were processed by the institution in this date. The first value indicates the start of the range and the second value indicates the end of the range. range (YYYY-MM-DD).

[
  "2022-01-01",
  "2022-12-31"
]
amountnumber float
Example:1000.02

Return results only for this value.

amount__gtnumber float
Example:1000.02

Return results only for more than this amount.

amount__gtenumber float
Example:1000.02

Return results only for and more than this amount.

amount__ltnumber float
Example:1000.02

Return results only for less than this amount.

amount__ltenumber float
Example:1000.02

Return results only for this amount or less.

amount__rangenumber[]

Return results between this amount range. The first value indicates the start of the range and the second value indicates the end of the range.

[
  100,
  5000
]
collected_atstring date
Example:2022-05-01

Return items that were retrieved from the institution on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__gtstring date
Example:2022-05-05

Return items that were retrieved from the institution after this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__gtestring date
Example:2022-05-04

Return items that were retrieved from the institution after or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__ltstring date
Example:2022-04-01

Return items that were retrieved from the institution before this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__ltestring date
Example:2022-03-30

Return items that were retrieved from the institution before or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__rangestring[]

Return items that were retrieved from the institution between two dates (YYYY-MM-DD or full ISO-8601 timestamp). 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"
]
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"
]
credit_card_data__bill_name__instring[]

Return transactions for one of these bill names.

[
  "feb-2022"
]
referencestring
Example:085904452810319225

Returns transactions with this institution-assigned reference number.

reference__instring[]

Returns transactions with these institution-assigned reference numbers.

[
  "085904452810319225"
]
statusstring
Example:PENDING

Return transactions with this status. Can be either PENDING, PROCESSED, or UNCATEGORIZED.

status__instring[]

Return transactions with these statuses. Can be either PENDING, PROCESSED, or UNCATEGORIZED.

[
  "PROCESSED"
]
type'OUTFLOW' | 'INFLOW'
Example:OUTFLOW

Return transactions with this type. Can be either INFLOW or OUTFLOW.

type__instring[]

Return transactions with this types. Can be either INFLOW or OUTFLOW.

[
  "INFLOW"
]
value_datestring date
Example:2022-05-05

Return results for exactly this date (YYYY-MM-DD).

value_date__gtstring date
Example:2022-05-06

Return results that occurred after this date (YYYY-MM-DD).

value_date__gtestring date
Example:2022-05-04

Return results for this date (YYYY-MM-DD) or later.

value_date__ltstring date
Example:2022-03-02

Return results for before this date (YYYY-MM-DD).

value_date__ltestring date
Example:2022-03-01

Return results for this date (YYYY-MM-DD) or earlier.

value_date__rangestring[]

Return results for this date (YYYY-MM-DD) range. 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"
]

Response

Ok

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",
      "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
      "account": {
        "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"
        }
      },
      "collected_at": "2022-02-09T08:45:50.406032Z",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "value_date": "2019-10-23",
      "transacted_at": "2024-02-20T12:29:03.374Z",
      "accounting_date": "2019-10-23",
      "inferred_accounting_date": "2019-10-23",
      "amount": 2145.45,
      "local_currency_amount": 7623.64,
      "currency": "BRL",
      "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX",
      "merchant": {
        "logo": "https://logo.clearbit.com/asesor-contable.es",
        "website": "https://merchants-r-us.com",
        "merchant_name": "Merchants R Us Global"
      },
      "category": "Income & Payments",
      "subcategory": "Freelance",
      "type": "INFLOW",
      "status": "PROCESSED",
      "credit_card_data": {
        "collected_at": "2022-02-09T08:45:50.406032Z",
        "bill_name": "apr-2020",
        "bill_due_date": "2023-06-17",
        "bill_internal_identification": "927921260199292792126508222219893192525A6",
        "bill_amount": 300,
        "card_number": "4453",
        "fee_type": "NATIONAL_WITHDRAWAL",
        "fee_type_additional_info": "ATM withdrawal in Curitiba.",
        "credits_type": "BILL_INSTALLMENT_PAYMENT",
        "credits_type_additional_info": "Some additional information.",
        "installment_identifier": "PARCELA_896",
        "number_of_installments": 4,
        "credit_card_bill": {
          "id": "8e9d13c2-af41-4a49-b43e-2da012bd1d11",
          "internal_identification": "92792126019929279212650822221989319252576"
        }
      },
      "counterparty": {
        "type": "INDIVIDUAL",
        "document_number": "73677831148",
        "clearing_code": "001",
        "agency": "6272",
        "check_digit": "7",
        "number": "24550245"
      },
      "loan_data": {
        "is_detached": true,
        "installment_id": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
        "fees": [
          {
            "name": "Reavaliação periódica do bem",
            "code": "aval_bem",
            "amount": 8903.77
          }
        ],
        "charges": [
          {
            "type": "MULTA_ATRASO_PAGAMENTO",
            "info": "Late payment charge.",
            "amount": 8903.77
          }
        ]
      },
      "payment_type": "FULL",
      "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO",
      "operation_type_additional_info": "Internal transfer.",
      "mcc": 5137
    }
  ]
}