Dividends

Holding income (acreencias) is a credit a user receives for holding an asset, typically bond coupons and amortizations, or dividends. The income arrives in one currency (incomeAsset) and may carry fees charged in another (finalClaimInfo.asset, usually ARS).


Types

The type depends on the asset generating the income:

TypeDescription
DIVIDENDProfit distributions companies pay to their shareholders (e.g. AAPL).
BONDInterest payments from governments or companies on borrowed money (e.g. AL30, MRCAO).
MATURITYExpiration of an asset (e.g. S31O4, T2X5).
REDEMPTIONCapital repayments from governments or companies (e.g. AL30).

Lifecycle

StatusDescription
PENDINGCreated, not yet processed.
LOCKED_BY_FEESProcessed, but the user has no balance in the claim currency to cover the fees.
PAIDHolding income executed and credits applied.

When holding income carries fees in a currency different from the credit, it starts in LOCKED_BY_FEES and the corresponding webhook fires.


Processing flow

  1. A holding-income-status-update webhook arrives with status: LOCKED_BY_FEES.
  2. Check whether the user has the funds needed (balance in finalClaimInfo.asset).
  3. If they do, confirm execution by calling POST /broker/v1/api/holdingIncome/{holdingIncomeId}.
  4. Manteca processes it: it generates debt (for the fees) and credit (for the income received).
  5. Reserve those funds from the user's balance to cover the generated debt.
{
  "id": "670d520139fa58ae89294c1b",
  "userId": "65cfadf9da953feea0e29400",
  "status": "PAID",
  "type": "BOND",
  "asset": "GD30",
  "incomeAsset": "USD",
  "amount": 5,
  "finalCreditInfo": { "asset": "USD", "base": 5, "total": 5 },
  "finalClaimInfo": { "asset": "ARS", "total": 124.37, "totalFees": 124.37, "holdingIncomeFee": 99, "marketRight": 4.58, "iva": 20.79 }
}

Endpoint references

Coupon and amortization dates for a bond are available in its instrument detail (paymentAt). See Instruments and pricing.


Did this page help you?