Skip to main content

What is on the accounting feed

The fields of each accounting feed delivery, and the bank rail, fee and bond payout events a ledger subscriber receives.

A subscriber that posts DALP events to its own ledger receives the deliveries listed here: the delivery envelope fields, plus bank rail, fee, and bond payout events. Run your own subscriber covers building and operating the subscriber.

What is on the feed

Each webhook delivery arrives as a JSON envelope with these fields for ledger processing:

Field
Meaning for a subscriber
evt_id
Identifies this recorded event. Retries carry the same evt_id, while a replay carries a new one.
source_id
Identifies the underlying occurrence and stays identical across replays. Present on every non-test event.
type, version
Event name and schema version. Match rules on both.
lifecycle_state
One of pending, provisional, final, retracted, recalled.
payload
Typed event data, including amounts and timestamps.
supersedes
On a retraction, the evt_id of the event it replaces.
is_replay
true on an envelope created by a replay request.
is_test
true on a test event. Never post it.

The event catalogue and market and settlement events document triggers and receiver actions. Payload schemas live in the machine-readable event definitions and TypeScript SDK. The manifest groups events into 14 families:

Family
What it reports
token
Transfers, corporate actions and retractions, fees, period closes, and bond payouts
asset
Asset creation, issuance, burns, pause, and unpause
primary-market
Token sale subscriptions, deliveries, refunds, and proceeds withdrawals
trading-venue
Orders, trades, trade settlements, and trade busts
xvp
Cross-party settlement lifecycle
compliance
Freezes, unfreezes, and verification verdicts
identity
Registration, claims, and status
access-control
Role grants and revocations
custody
Account creation, signer changes, and custody gateway settlements
funding
Funding requirements for operations
operations
Operations cases opened, acknowledged, and resolved
reporting
Wallet confirmations, client statements, and filing deadlines
transaction
Transaction request outcomes, from broadcast to confirmation, failure, or cancellation
bank-rail
Credit and cash-out milestones, bank reversals, and returned payouts

Bank rail events

Subscribe explicitly to bank-rail.credit.* or bank-rail.cash-out.*, because default state patterns skip their milestone names. These events carry amount, currency, and occurredAt. For admitted or requested milestones, lifecycle_state: "final" means the rail committed that observation, not that the payment finished.

Bank amounts are decimal currency strings (such as "12.50" EUR), not token base units. Convert them exactly to minor currency units before applying integer-cent posting rules, and never feed decimal bank amounts into rules expecting token base units.

Choose one posting milestone per movement so nothing counts twice (for example, do not post both credit admission and mint, or both mint and token issuance). A released cash-out can still report paid after late settlement and full recovery (partial recovery sends no event). A cash-out returned event only means the re-credit was admitted (provenance.cashOutId links back to the cash-out), so wait for the re-credit's minted event before booking the mint.

Recall recovered amounts, write-downs, and claws appear on the recall sheet on the Console's Payments tab. bank-rail.credit.recalled fires only once completed recalls cover the full credit, carrying only the completing reversal's amount. Read recall records directly before posting a full reversal history. See the bank rail catalogue.

Fee events

Fees arrive as dedicated events. For each token, post fees either from fee events or from token transfers, never both.

Event
What it reports
Fee id
trading-venue.trade-fee.final
Venue fee charged to one side of a settled trade (buyer or seller).
<tradeId>:<side>
trading-venue.trade-fee.retracted
Trade bust reversal of that venue fee.
<tradeId>:<side>
token.fee.final
Token fee charge: transaction, external, AUM, accrual, or fund management fee.
<blockNumber>:<logIndex>:<feeType>
token.fee-period-close.final
Accrual period close.
periodCloseId, <blockNumber>:<logIndex>

Custody gateway settlements also appear on the feed as custody.gateway-deposit.settled and custody.gateway-withdrawal.settled (custody events).

token.fee.final is final only, emitted once chain finality reaches its block, so it is never retracted. basis is collected or accrued (filterable with when), and payer is withheld from thin payloads. Because a fee id is unique per network only, multi-network ledgers key token fees on source_id.

Transaction, AUM, management, and DALP-token external fees also emit token.transfer.final or asset.issuance.final for the same value. Map either fee events or transfer events per token, never both.

token.fee-period-close.final reports the summed accrual since the prior close without moving tokens or cash. Most token fees are denominated in the token itself, and basis-point fees on 18-decimal tokens rarely land on exact cents, so leave unvalued security-token fees unmapped rather than rounding.

Endpoints receive fee events from deployment onward, and indexer rebuilds replay past fee logs from the endpoint's start block. Deduplicating on source_id prevents duplicate postings. Exclude earlier periods already booked from period reports.

Bond payout events

Bonds pay coupons and maturity redemptions one holder at a time as holders claim or redeem:

Event
What it reports
Domain key
token.coupon-claim.final
Holder coupon claim on a fixed treasury yield feature or legacy schedule.
claimId, <blockNumber>:<logIndex>
token.maturity-redemption.final
Holder redemption of matured bond tokens on a maturity redemption feature or legacy bond.
redemptionId, <blockNumber>:<logIndex>

Both events are final only, emitted once their block reaches chain finality, and never retracted. amount is the cash paid in base units of denominationAddress. Post amount directly rather than recomputing from coupon rates, because a claim can pay less than the period sum.

Redemptions also carry tokenAmount, and featureAddress names the paying contract (or the bond itself for legacy bonds). holder is withheld from thin payloads, and converting accrued yield into tokens emits no cash payout event.

token.corporate-action.completed for bond coupons and maturity redemptions moves no cash, so post cash from bond payout events instead. If the denomination asset is a DALP token, map either bond payout events or denomination token.transfer.final events per bond, not both.

Endpoints receive these events only for claims and redemptions reaching finality after the feature began emitting them. Earlier payouts and indexer rebuilds emit none.

The posting preset in Store a posting configuration posts both events for ledger-currency quote assets under classification servicing, debiting servicing.distributions.<suffix> or servicing.redemptions.<suffix> and crediting client-money.liability.<suffix>, while ignoring token.corporate-action.completed for bond coupons and maturity redemptions.

Every journal requires an amount and an ISO 8601 timestamp (occurredAt). Legacy token.transfer.final events predating occurredAt have no timestamp and are refused as malformed. Check schemas in the machine-readable event definitions before writing rules.

Was this page helpful?