resource and source so you can present and link the event without extra lookups.
Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with amount (signed, in the currency’s smallest precision units) and posted_at, and use available_at to know when inflows became withdrawable.
Endpoints
Attributes
string
required
Ledger activity ID.
account or user
The viewer account that owns this row’s ledger. Present only when the response
aggregates owned accounts (include_owned_accounts=true); omitted otherwise.
string
required
Signed amount in the currency’s smallest precision units.
string | null
required
ISO 8601 timestamp these funds became (or are scheduled to become)
withdrawable: the posted time for already-settled funds, or 00:00:00 UTC on
the scheduled release date for pending funds. Present only on inflows entering
the balance (payments, top-ups, incoming transfers/affiliate); null on
withdrawals, refunds, disputes and on-chain rows. The available_after/before
filters window on its UTC settlement date.
string | null
required
When the activity record was created.
object
required
string | null
The ledger account (a ldgr_ identifier) this row belongs to. Present only when
the response aggregates owned accounts (include_owned_accounts=true); omitted
otherwise. Pair it with
account to scope drawers and dashboard links to the
owning business.string
required
The ledger line category this activity was posted under.Available options:
ad_budget_release, ad_campaign_budget, ad_publisher_payout, ad_publisher_payout_received, ad_spend_charge, affiliate_fee, airdrop, airdrop_link_created, airdrop_link_redeemed, airdrop_link_returned, airdrop_reversal, application_fee, application_fee_payout, bank_transfer, billing_percentage_fee, buyer_fee, card_spend_authorization, card_spend_authorization_void, card_spend_refund, company_referral, cross_border_percentage_fee, currency_conversion_incoming, currency_conversion_outgoing, dispute_alert_fee, dispute_hold_adjustment, fraud_prevention_fee, fx_percentage_fee, high_risk_merchant_fee, installment_default, internal_balance_transfer_incoming, internal_balance_transfer_outgoing, legacy_crypto_payment, legacy_payment, legacy_payment_refund, license_sale, license_sale_commission, license_sale_revenue, misc_purchase, misc_refund, misc_reversal, onchain_deposit, onchain_swap_target, onchain_wallet_transfer_incoming, onchain_wallet_transfer_outgoing, orchestration_percentage_fee, passthrough_gmv, payment_dispute, payment_dispute_adjustment, payment_dispute_fee, payment_dispute_reversal, payment_gross, payment_gross_reversal, payment_processing_fixed_fee, payment_processing_percentage_fee, payment_referral, payment_referral_reversal, payment_refund, payment_refund_reversal, payment_revshare, payment_revshare_payout, payment_revshare_refund, payment_revshare_reversal, payout_fee, platform_affiliate_payment, platform_affiliate_payment_reversal, platform_balance_payment, platform_balance_payment_refund, platform_balance_transfer_incoming, platform_balance_transfer_outgoing, platform_covered_dispute, promo_reversal, referral_bonus, resolution_center_refund, revshare_percentage_fee, sales_tax_fee, sales_tax_remittance, sales_tax_remittance_reversal, software_rental_revshare, software_rental_transaction, stripe_domestic_processing_fee, stripe_international_processing_fee, three_ds_fixed_fee, topup, topup_fee, topup_reversal, treasury_payin, whop_processing_fee, withdrawal, withdrawal_clawback, withdrawal_clawback_reversal, withdrawal_reclassification, withdrawal_reversalstring
required
string
required
When the activity posted to the ledger.
account or user or bounty or ledger_account or payment_method or payout_method or card_transaction | null
required
Resource associated with this ledger activity.
object | null
required
Source of this ledger activity.
Properties
Properties
string
required
number | null
Withdrawal amount as a decimal number in the destination currency (withdrawal
sources only; requires payout:withdrawal:read).
string | null
Chain the deposit landed on, for example plasma (onchain_transaction sources
only).
string | null
Public claim URL for the airdrop link (airdrop_link sources only).
string | null
Withdrawal creation time as an ISO 8601 timestamp (withdrawal sources only;
requires payout:withdrawal:read).
string | null
Estimated arrival as an ISO 8601 timestamp (withdrawal sources only; requires
payout:withdrawal:read).
string | null
Amount converted out of from_currency as a decimal string (swap sources only).
string | null
Lowercase currency code converted from (swap sources only).
string
required
string | null
Name of the entity processing the payout (withdrawal sources only; requires
payout:withdrawal:read).
object | null
string | null
Saved payout destination nickname (withdrawal sources only).
string | null
Transfer reason on transfer sources, for example pool_top_up or bounty_return.
string | null
Sender wallet address or onramp provider identifier (onchain_transaction
sources only).
string | null
Lifecycle status. On withdrawal sources this is the withdrawal status
(requires payout:withdrawal:read); on airdrop_link sources it is the
claim-link status (ungated); on payment and top-up sources it is the friendly
payment status such as succeeded/pending/failed (ungated).
string | null
Amount received in to_currency as a decimal string (swap sources only).
string | null
Lowercase currency code converted to (swap sources only).
string | null
On-chain transaction hash (onchain_transaction and swap sources only).
LedgerActivity
Glossary of line types
Every activity row carries aline_type that names the financial event it represents. Pass one or more line_types to List Financial Activity to filter the feed to specific events — either as repeated line_types[] parameters or as a single comma-separated value (line_types=payment_gross,payment_refund). Unknown line types return a 400.
Throughout this glossary, “LPM” means a local payment method (a non-card method such as a bank debit or wallet).
Categories
In place of listing individual line types, you can pass a category shorthand. A category expands to every line type it contains.Payments
Refunds
Disputes
Reserves
Withdrawals
Transfers
Currency conversion
Affiliates & revenue share
Airdrops
Advertising
Crypto & cards
onchain_deposit is opt-in: it is excluded from the default feed and only
returned when you request it explicitly in line_types.
