API StatusAPI ReferenceError DocsInstitutionsSupportSign inCreate a Sandbox account

Bills (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, you can retrieve the credit card bill information for a link.

For each bill, you receive:

  • the total amount of the bill.
  • the due date for the bill to be paid.
  • any fees and charges associated with the bill.
  • the payments made to pay off the bill.

🚧

Bills are only available for closed periods

In the Open Finance Network, credit card bill information is only available for periods (for example, months) that are "closed" according to the institution.

Full example

You can see a full example of a bill response below:

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "account": {}, // Account object
  "internal_identification": "92792126019929279212650822221989319252576",
  "bill_name": "apr-2020",
  "due_date": "2021-09-06",
  "currency": "BRL",
  "total_amount": 45391.89,
  "minimum_amount": 391.89,
  "is_installment": false,
  "finance_charges": [ // Details regarding any charges applied to the bill
    {
      "type": "LATE_PAYMENT_INTEREST",
      "additional_info": "Paid 15 days late, fee applied.", 
      "currency": "BRL",
      "amount": 91.89
    }
  ],
  "payments": [ // Array of payments made for this bill
    {
      "type": "FULL",
      "payment_date": "2021-09-04",
      "payment_mode": "DIRECT_DEBIT",
      "currency": "BRL",
      "amount": 45391.89
    }
  ]
}

Core information

Within the core bill information information, you can extract the following information for the closed bill:

  • internal_identification: The institution's internal identifier for the bill.
  • bill_name: The name of the closed bill.
  • due_date: Due date to pay the bill.
  • currency: The currency of the bill.
  • total_amount: The total amount of the bill.
  • minimum_amount: The minimum amount to pay.
  • is_installment: Boolean indicating if this bill can be paid in installments.
{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "account": {}, // Account object
  "internal_identification": "92792126019929279212650822221989319252576",
  "bill_name": "apr-2020",
  "due_date": "2021-09-06",
  "currency": "BRL",
  "total_amount": 45391.89,
  "minimum_amount": 391.89,
  "is_installment": false,
  "finance_charges": [],// Details regarding any charges applied to the bill
  "payments": []// Array of payments made for this bill
}

Finance charges

With the finance_charges array, you can see specific information regarding any charges that were applied to the bill:

  • type: The type of charge (for example, LATE_PAYMENT_INTEREST).
  • additional_info: Additional information about the charge.
  • currency: The currency of the charge.
  • amount: The amount of the charge.
{
  "finance_charges": [
    {
      "type": "LATE_PAYMENT_INTEREST",
      "additional_info": "Paid 15 days late, fee applied.",
      "currency": "BRL",
      "amount": 91.89
    }
  ]
}

Payments

With the payments array, you can see specific information regarding any payments that were made on the bill:

  • type: Indicates the type of payment (for example FULL or INSTALLMENT
  • payment_date: The date that the payment was made.
  • payment_mode: The method used to make the payment.
  • currency: The currency of the payment.
  • amount: The amount of the payment.
{
  "payments": [
    {
      "type": "FULL",
      "payment_date": "2021-09-04",
      "payment_mode": "DIRECT_DEBIT",
      "currency": "BRL",
      "amount": 45391.89
    }
  ]
}

Updated 2 months ago