Credit Card Bills

The Bill entity is recovered from institutions that support this product. It represents a bill (fatura) associated with an account of type "Credit", specifically the subtype CREDIT_CARD.
The bill represent each invoice the card provider sends to the user by the end of the month with the details of the debt, the taxes involved in the period, and when it's due.

📘

Only supported on Regulado connections

This entity its returned mandatory for all FI institutions on Open Finance Regulado connections.
For Open Finance Direct connections, its only returned in Inter PF & Itau Cartões.


{
    "id": "76edd0fa-57b4-4391-be8d-e8b6249d04b1",
    "dueDate": "2023-09-15T00:00:00.000Z",
    "totalAmount": 10000.76,
    "totalAmountCurrencyCode": "BRL",
    "minimumPaymentAmount": 3000,
    "allowsInstallments": true,
    "financeCharges": [
        {
            "id": "6119c3e0-706c-4a7a-a734-0fc7a0a94bdb",
            "type": "IOF",
            "amount": 7.01,
            "currencyCode": "BRL",
            "additionalInfo": "NA"
        },
        {
            "id": "3cd450a1-79d1-43fd-a5ea-f77b3fca960d",
            "type": "OTHER",
            "amount": 0,
            "currencyCode": "BRL",
            "additionalInfo": "NA"
        }
    ]
}
PropertyTypeOptionalDescription
idstringNoPrimary identifier
dueDatestringNoDue date of the bill, displayed for payment by the customer
totalAmountnumberNoTotal bill amount
totalAmountCurrencyCodestringNoCode referencing the currency of the bill
minimumPaymentAmountnumberYesMinimum payment amount of the bill
allowsInstallmentsbooleanYesIndicates whether the bill allows installment payments (true) or not (false)
financeChargesarrayNoList of charges associated with the bill (CreditCardBillFinanceCharge)

Credit Card Bill Finance Charge

PropertyTypeOptionalDescription
idstringNoPrimary identifier
typestringNoDenomination of the charges that apply to the postpaid payment account bill

- LATE_PAYMENT_REMUNERATIVE_INTEREST
- LATE_PAYMENT_FEE
- LATE_PAYMENT_INTEREST
- IOF
- OTHER
amountnumberNoAmount charged for the charge/fee
currencyCodestringNoCode referencing the currency of the charge
additionalInfostringYesFree field, mandatory to fill if 'OTHER' type of charge is selected