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"
}
]
}
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) |
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 |
Updated 2 months ago