Credit Charges

Access Prerequisites

• Permission (module): viewCredits (list/view). Canceling a charge requires creditConfigManage.
• License/Feature: CREDIT_INVESTMENTS enabled in the tenant license (Vault).
• Menu container: TOKENIZATION → group Tokenized Credit

What it is / when to use

The Charges screen tracks the payment instruments (PIX, Boleto, or PIX+Boleto) issued against the drawee/debtor to settle the installments of a receivable. Each charge has a reference code, amount, due date, and payment status, and may carry the PIX EMV and the boleto line/URL.

Use this screen to monitor what has been paid, partially paid, overdue, or expired, view the details of each charge, and cancel charges that should no longer be paid (provided they have not yet been paid).

Prerequisites

• Permission: viewCredits to view; creditConfigManage to cancel (double permission — CPM enum + dynamic module in the DB).
• License/Feature: CREDIT_INVESTMENTS enabled. Without it the group does not appear in the menu at all.
• Dependencies on other screens: a charge originates from an installment of a Receivable; the drawee must be registered under Parties.

Step by step

1. Open the menu Tokenized Credit → Charges.
2. Filter by Status (All / Created / Sent / Paid / Expired / Cancelled).
3. Use ⋮ → View to open the details (PIX EMV, boleto line, history).
4. To cancel, use ⋮ → Cancel (only if the charge is not paid/partially paid/cancelled).

Filters and columns

Filter/Column	What it shows	Data source
Reference code	Charge identifier	Charge.referenceCode
Originator	Associated cedant	Charge.originatorId
Amount	Amount to charge	Charge.amount (BigNumber)
Due date	Payment deadline	Charge.dueDate
Status	CREATED, SENT, PAID, PARTIALLY_PAID, OVERDUE, EXPIRED, CANCELLED	Charge.status (filter statusFilter)
Created at	Issuance date	Charge.createdAt

Fields visible in the detail view: type (PIX/BOLETO/PIX_BOLETO), paidAmount/paidAt, pixEmv, boletoLine/boletoUrl, and the manual confirmation fields (paymentMethod, paymentReference, manualConfirmation, confirmedBy, confirmationNotes).

Actions and modals

• View details: opens the details dialog (ChargeDetailsDialog) with the payment data and the linked enriched receivable.
• Cancel: cancelCharge(id) after confirmation (bottom-sheet). Shown only when the status is not PAID, PARTIALLY_PAID, or CANCELLED, and requires creditConfigManage.

Canceling a charge may trigger step-up (password + MFA, X-Step-Up-Token) depending on the environment.

Business rules / caveats

Attention

• A paid charge cannot be cancelled. The Cancel button is hidden for PAID/PARTIALLY_PAID; adjustments for already-received payments are not handled on this screen.
• Manual confirmation exists. When a payment arrives outside the automatic PIX/Boleto flow, the manual confirmation fields (confirmedBy, confirmationNotes) record who did it and why — useful for reconciliation.
• Disputes are opened from the charge. Each charge may have Disputes linked by chargeId.

• Financial amounts: amount and paidAmount are BigNumber on the backend; partial payments accumulate up to the total — do not round when checking the outstanding balance.

Related screens

• Receivables
• Parties (drawee)
• Disputes
• Tokenized Credit (group index)