API StatusAPI ReferenceError DocsInstitutionsSupportSign inCreate a Sandbox account

Transactions (OFDA)

Read up on the details for Transactions in Belvo's OFDA product.

Suggest Edits

With Belvo's Open Finance Data Aggregation (OFDA) product for Brazil, we've expanded our Transactions schema with improved core information about the transaction, counterparty information, and specific details regarding loan repayment transactions.

Full example

Below you can see a full example to compare our Standard (Multi-Region) and OFDA (Brazil) schemas.

{
  "id": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
  "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
  "account": {
    "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
    "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
    "institution": {
      "name": "erebor_mx_retail",
      "type": "bank"
    },
    "collected_at": "2019-09-27T13:01:41.941Z",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "category": "CHECKING_ACCOUNT",
    "balance_type": "ASSET",
    "type": "Cuentas de efectivo",
    "name": "Cuenta Perfiles- M.N. - MXN-666",
    "number": "4057068115181",
    "balance": {
      "current": 5874.13,
      "available": 5621.12
    },
    "currency": "MXN",
    "public_identification_name": "CLABE",
    "public_identification_value": "150194683119900273",
    "last_accessed_at": "2021-03-09T10:28:40.000Z",
    "credit_data": {
      "credit_limit": 192000,
      "collected_at": "2019-09-27T13:01:41.941Z",
      "cutting_date": "2019-12-11",
      "next_payment_date": "2019-12-13",
      "minimum_payment": 2400.3,
      "no_interest_payment": 2690.83,
      "interest_rate": 4,
      "end_date": null,
      "monthly_payment": null,
      "last_payment_date": null
    },
    "loan_data": {
      "collected_at": "2022-02-09T08:45:50.406032Z",
      "contract_amount": 202000,
      "principal": 192000,
      "loan_type": "Consignado",
      "payment_day": "27",
      "outstanding_principal": 142023,
      "outstanding_balance": 182000,
      "monthly_payment": 1000,
      "interest_rates": [
        {
          "name": "jurosEfetivo",
          "type": "MONTHLY",
          "value": 7.85
        }
      ],
      "fees": [
        {
          "type": "OPERATION_FEE",
          "value": 5.6
        }
      ],
      "number_of_installments_total": 60,
      "number_of_installments_outstanding": 48,
      "contract_start_date": "2020-03-01",
      "contract_end_date": "2027-10-01",
      "contract_number": "890ASLDJF87SD00",
      "credit_limit": null,
      "last_period_balance": null,
      "interest_rate": null,
      "limit_day": null,
      "cutting_day": null,
      "cutting_date": null,
      "last_payment_date": null,
      "no_interest_payment": null
    },
    "funds_data": [
      {
        "collected_at": "2020-04-23T21:32:55.336854+00:00",
        "name": "FIX X",
        "type": "CNPJ",
        "public_identifications": [
          {
            "name": "CNPJ",
            "value": "05.954.445/0221-68"
          }
        ],
        "balance": 88427.94,
        "percentage": 100
      }
    ],
    "receivables_data": {
      "current": 2193.83,
      "available": 800.37,
      "anticipated": 1393.46,
      "collected_at": "2022-02-09T08:45:50.406032Z"
    },
    "bank_product_id": null,
    "internal_identification": null
  },
  "collected_at": "2019-11-28T10:27:44.813Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "value_date": "2019-10-23",
  "accounting_date": "2019-10-23T13:01:41.941Z",
  "amount": 2145.45,
  "balance": 16907.96,
  "currency": "BRL",
  "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX",
  "observations": "OPTIONAL OBSERVATIONS",
  "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",
  "reference": "8703",
  "type": "INFLOW",
  "status": "PROCESSED",
  "credit_card_data": {
    "collected_at": "2019-09-27T13:01:41.941Z",
    "bill_name": "apr-2020",
    "bill_status": "PAID",
    "bill_amount": 300,
    "previous_bill_total": "9614.30"
  }
}

{
  "id": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
  "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
  "account": { }, // See the Accounts schema
  "collected_at": "2019-11-28T10:27:44.813Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "value_date": "2019-10-23",
  "accounting_date": "2019-10-23T13:01:41.941Z",
  "amount": 2145.45,
  "local_currency_amount": 7623.64,
  "balance": null,
  "currency": "BRL",
  "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX",
  "observations": null,
  "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",
  "reference": null,
  "type": "INFLOW",
  "status": "PROCESSED",
  "credit_card_data": {
    "collected_at": "2019-09-27T13:01:41.941Z",
    "bill_name": "apr-2023",
    "bill_due_date": "2023-04-16",
    "bill_internal_identification": "92792126019929279212650822221989319252576",
    "bill_status": null,
    "previous_bill_total": null,
    "bill_amount": 300,
    "card_number": "4453",
    "fee_type": "NATIONAL_WITHDRAWAL",
    "fee_type_additional_info": "ATM withdrawal in Coriciba.",
    "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
}

Core Transaction Information

Within the core transaction information, Open Finance provides you with more robust and standardized data such as the account subtype, improved agency and account information, as well as the bank's internal identification for the field (all standardized across any partner in the Open Finance network).

{
  "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
  "account": {},
  "collected_at": "2019-11-28T10:27:44.813Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "value_date": "2019-10-23",
  "accounting_date": "2019-10-23T13:01:41.941Z",
  "amount": 2145.45,
  "balance": 16907.96,
  "currency": "BRL",
  "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX",
  "observations": "OPTIONAL OBSERVATIONS",
  "reference": "8703",
  "type": "INFLOW",
  "status": "PROCESSED",
}

{
  "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
  "account": {}, // See the Accounts schema
  "value_date": "2019-10-23", // not-nullable
  "accounting_date": "2019-10-23T13:01:41.941Z", // not-nullable
  "amount": 2145.45, // not-nullable
  "local_currency_amount": 7623.64, // not-nullable
  "balance": null,
  "currency": "BRL",
  "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", // not-nullable
  "observations": null,
  "reference": null,
  "type": "INFLOW", // not-nullable
  "status": "PROCESSED",
  "payment_type": "FULL", // new and nullable
  "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", // new and not-nullable
  "operation_type_additional_info": "Internal transfer.", // new and nullable
  "mcc": 5137 // new and nullable
}

Counterparty

With the counterparty object, you can see specific information regarding the other party in a bank-to-bank transfer.

{
  "counterparty": { // new and nullable
    "type": "INDIVIDUAL",
    "document_number": "73677831148",
    "clearing_code": "001",
    "agency": "6272",
    "check_digit": "7",
    "number": "24550245"
  }
}

Credit Card Data

With credit card data, you can now retrieve:

  • The card_number that the transaction occurred on.
  • Any fees charged on the transaction (fee_type).
  • Any type of credit added to the card (credits_ype.
  • the bill that the credit card transaction appears on (bill_name, bill_due_date, bill_internal_identification).
{
  "credit_card_data": {
    "bill_name": "apr-2020",
    "bill_status": "PAID",
    "bill_amount": 300,
    "previous_bill_total": "9614.30"
  }
}

{
  "credit_card_data": {
    "bill_name": "apr-2023",
    "bill_due_date": "2023-04-16", // new and not-nullable
    "bill_internal_identification": "92792126019929279212650822221989319252576", // new and not-nullable
    "bill_status": null, // not-aplicable for OFDA
    "previous_bill_total": null, // not-aplicable for OFDA
    "bill_amount": 300,
    "card_number": "4453", // new and not-nullable
    "fee_type": "NATIONAL_WITHDRAWAL",
    "fee_type_additional_info": "ATM withdrawal in Coriciba.",
    "credits_type": "BILL_INSTALLMENT_PAYMENT",
    "credits_type_additional_info": "Some additional information.",
    "installment_identifier": "PARCELA_896",
    "number_of_installments": 4, // new and not-nullable
    "credit_card_bill": {
      "id": "8e9d13c2-af41-4a49-b43e-2da012bd1d11",
      "internal_identification": "92792126019929279212650822221989319252576"
    }
  }
}

Loan Data

With the new loan_data object, for each transaction that relates to a loan payment you can retrieve:

  • whether the payment was a scheduled payment on the loan or not (is_detached)
  • the unique ID of the installment payment
  • the fees and charges included in the loan payment transaction.
{
  "loan_data": { // new and nullable
    "is_detached": true, // not nullable
    "installment_id": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH",
    "fees": [
      {
        "name": "Reavaliação periódica do bem", // not nullable when is_detached = true
        "code": "aval_bem", // not nullable when is_detached = true
        "amount": 8903.77 // not nullable when is_detached = true
      }
    ],
    "charges": [
      {
        "type": "MULTA_ATRASO_PAGAMENTO", // not nullable when is_detached = true
        "info": "Late payment charge.",
        "amount": 8903.77 // not nullable when is_detached = true
      }
    ]
  }
}

Funds Data

Information regarding pension funds will soon be added to the Open Finance network. According to the Brazilian government, this information should be made available at the end of 2023.

Receivables Data

Information regarding pension funds will soon be added to the Open Finance network. According to the Brazilian government, this information should be made available at the end of 2023.

Updated 8 months ago