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
Ledger activity ID.
The viewer account that owns this row’s ledger. Present only when the response
aggregates owned accounts (include_owned_accounts=true); omitted otherwise.
Signed amount in the currency’s smallest precision units.
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.
When the activity record was created.
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.Type of ledger activity.
When the activity posted to the ledger.
resource
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.
Source of this ledger activity.
Properties
Properties
Withdrawal amount as a decimal number in the destination currency (withdrawal
sources only; requires payout:withdrawal:read).
Chain the deposit landed on, for example plasma (onchain_transaction sources
only).
Public claim URL for the airdrop link (airdrop_link sources only).
Withdrawal creation time as an ISO 8601 timestamp (withdrawal sources only;
requires payout:withdrawal:read).
Estimated arrival as an ISO 8601 timestamp (withdrawal sources only; requires
payout:withdrawal:read).
Amount converted out of from_currency as a decimal string (swap sources only).
Lowercase currency code converted from (swap sources only).
Name of the entity processing the payout (withdrawal sources only; requires
payout:withdrawal:read).
Saved payout destination nickname (withdrawal sources only).
Transfer reason on transfer sources, for example pool_top_up or bounty_return.
Sender wallet address or onramp provider identifier (onchain_transaction
sources only).
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).
Amount received in to_currency as a decimal string (swap sources only).
Lowercase currency code converted to (swap sources only).
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.
