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 represents 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 is returned mandatory for all FI institutions on Open Finance Regulado connections. For Open Finance Direct connections, it is only returned in Inter PF & Itau Cartoes.
{
"id": "76edd0fa-57b4-4391-be8d-e8b6249d04b1",
"dueDate": "2023-09-15T00:00:00.000Z",
"totalAmount": 10000.76,
"totalAmountCurrencyCode": "BRL",
"minimumPaymentAmount": 3000,
"allowsInstallments": true,
"payments": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"valueType": "FULL_PAYMENT",
"paymentDate": "2023-09-15T00:00:00.000Z",
"paymentMode": "PIX",
"amount": 10000.76,
"currencyCode": "BRL"
}
],
"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"
}
]
}| Property | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Primary identifier |
| dueDate | string | No | Due date of the bill, displayed for payment by the customer |
| totalAmount | number | No | Total bill amount |
| totalAmountCurrencyCode | string | No | Code referencing the currency of the bill |
| minimumPaymentAmount | number | Yes | Minimum payment amount of the bill |
| allowsInstallments | boolean | Yes | Indicates whether the bill allows installment payments (true) or not (false) |
| financeCharges | array | No | List of charges associated with the bill (CreditCardBillFinanceCharge) |
| payments | array | No | List of payments associated with the bill (CreditCardBillPayment) |
Credit Card Bill Finance Charge#
| Property | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Primary identifier |
| type | string | No | Denomination of the charges that apply to the postpaid payment account bill: LATE_PAYMENT_REMUNERATIVE_INTEREST, LATE_PAYMENT_FEE, LATE_PAYMENT_INTEREST, IOF, OTHER |
| amount | number | No | Amount charged for the charge/fee |
| currencyCode | string | No | Code referencing the currency of the charge |
| additionalInfo | string | Yes | Free field, mandatory to fill if 'OTHER' type of charge is selected |
Credit Card Bill Payment#
| Property | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Primary identifier |
| valueType | string | No | Type of payment made against the bill (e.g. FULL_PAYMENT, MINIMUM_PAYMENT, OTHER) |
| paymentDate | string | No | Date the payment was made |
| paymentMode | string | No | Mode used to make the payment (e.g. PIX, account debit, bank slip) |
| amount | number | No | Amount paid |
| currencyCode | string | No | Code referencing the currency of the payment |
How to verify a previous bill is settled#
A bill's balance is considered settled when the payments recorded in the next billing cycle cover the previous bill's total amount plus any finance charges (interest, fees, etc.) that accrued during that next cycle:
totalAmount(Bill N) + sum(financeCharges(Bill N+1)) = sum(payments(Bill N+1))
Where N is the bill you want to verify and N+1 is the immediately following bill.
Example: verifying January bill settlement#
Suppose a customer has two consecutive bills: January (Bill N) and February (Bill N+1).
To confirm the January balance was fully paid, the following condition must hold:
totalAmount(January) + sum(financeCharges(February)) = sum(payments(February))
| Field | Source | Value |
|---|---|---|
totalAmount | January bill | R$ 500.00 |
sum(financeCharges) | February bill | R$ 12.50 |
sum(payments) | February bill | R$ 512.50 |
Since 500.00 + 12.50 = 512.50, the January bill is considered settled.