Orvion
Get started
Developer Guides
Core objects
Payment Receiving
Invoices
Billing
Collections
Payouts
Webhooks & events
SDKs & examples
Administration & security
Changelog & roadmap

Payout Ledger

The Payout Ledger tracks all fund distributions from collected payments to beneficiary wallets.

Payout Lifecycle

Payouts progress through statuses:

PENDING → SETTLED
    ↓
FAILED
  • PENDING: Payout created, awaiting execution
  • SETTLED: Payout confirmed on-chain, funds delivered
  • FAILED: Payout failed (network error, invalid address, etc.)

Payout Fields

  • amount: Payout amount (calculated from split)
  • currency: Currency/asset (e.g., "USDC")
  • beneficiary_address: Wallet address receiving funds
  • label: Role identifier (merchant, platform_fee, partner)
  • network: Blockchain network (e.g., "base-mainnet")
  • asset: Token identifier (e.g., "USDC")
  • status: Payout status
  • tx_hash: On-chain payout transaction hash

Multiple Payouts per Payment

Each settled payment can generate multiple payouts:

  • One payout leg per split beneficiary
  • Example: $100 payment → $90 merchant payout + $10 platform payout
  • All payouts tracked separately with individual status

Viewing Payouts

Via Dashboard

Navigate to Payouts → Payouts to see the payout ledger.

Via API

GET /v1/invoices/{invoice_id}/payouts

Returns all payouts for an invoice, grouped by payment.

Payout Summary

For each invoice, you can see:

  • Splits: Configuration (percentage/fixed, beneficiaries)
  • Payouts: Actual payout records with status
  • Totals by Label: Aggregated amounts per beneficiary type

Related Documentation