Documentação

English

Português
Español

English

Português
Español

Appearance

Settlements ​

Access Prerequisites

  • Permission (module): creditDisburse (execute/operate settlements).
  • License/Feature: CREDIT_INVESTMENTS enabled on the tenant license (Vault).
  • Menu container: TOKENIZATION → group Tokenized Credit

What it is / when to use ​

The Settlements screen shows the final distribution of money from a Deal when the receivables are paid. A settlement applies the Waterfall Template of the deal, splitting the received amount among recipients (investors, house, fees) in a priority order. Each settlement has a set of ordered items, each with a type, receivable/recipient, and amount.

Use this screen to track which deals have already been settled (fully or partially), the total amount distributed, and the item-by-item breakdown of each settlement.

Prerequisites ​

  • Permission: creditDisburse (a dual 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: the Deal must have been funded/disbursed and have paid Charges; the Waterfall Template determines the item order.

Step by step ​

  1. Go to the menu Tokenized Credit → Settlements.
  2. Filter by Status (All / Pending / Processing / Completed / Failed).
  3. Click View on a settlement to open the details panel with the ordered items.
  4. Close the panel to return to the list.

Filters and columns ​

Filter/ColumnWhat it showsData source
Deal NumberSettled dealSettlement.dealNumber / dealId
StatusPENDING, PROCESSING, COMPLETED, FAILEDSettlement.status (filter statusFilter)
Total amountAmount distributed in this settlementSettlement.totalAmount (BigNumber)
Settlement dateWhen it was processedSettlement.settlementDate
No. of itemsNumber of distribution linesSettlement.items.length
Created atRecord creation dateSettlement.createdAt

Detail of each item (SettlementItem): order (priority), itemType, receivableId/recipient, amount. Items are displayed sorted by order — exactly the waterfall order.

Actions and modals ​

  • View: opens the side panel with the settlement items, sorted by priority (getOrderedItems). There is no destructive action in this listing — the execution of the settlement is triggered by the disbursement flow / executeSettlement (module creditDisburse), which assembles the settlementItems (itemType, recipientPartyId, toAccountId, amount, priority) according to the waterfall.

Business rules / considerations ​

Attention

  • The waterfall order is the payment order. The order/priority of each item follows the deal's Waterfall Template — items with lower priority values are paid first; changing the waterfall afterwards does not rewrite settlements already executed.
  • Partial settlement exists. A deal can remain PARTIALLY_SETTLED while not all receivables have been paid; new settlements accumulate until reaching SETTLED.
  • FAILED status requires attention. A FAILED settlement indicates a transfer failure — investigate before reprocessing.

Irreversible

  • Settlement distribution is final. Upon execution, the money is transferred to recipients on/off-chain. There is no automatic rollback — corrections require a new financial event (e.g. Buyback or manual adjustment).
  • Financial values: totalAmount and amount of each item are BigNumber in the backend; the sum of items must match the total — do not round when reconciling.
  • Idempotency: the transfer goes through FinLib and is idempotent by externalId — on reprocessing, E00021 ("already processed") is success, not an error. See [[reference_finlib_idempotency]].