Skip to main content
GET
List Financial Activity

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

include_owned_accounts
boolean

When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning account.

include_resource
boolean
default:true

Whether to include the resource field in the response or not. Consider passing false if you need a fast response without as many rich details.

line_types
enum<string>[]

Optional ledger line categories to include. Some categories (for example onchain_deposit, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.

Available options:
account_settlement,
ad_affiliate_payout_received,
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,
balance_reservation,
balance_reservation_reversal,
bank_transfer,
billing_percentage_fee,
buyer_fee,
card_interchange,
card_load_deposit,
card_load_transfer,
card_spend_authorization,
card_spend_authorization_void,
card_spend_refund,
card_unload_deposit,
card_unload_transfer,
cashback,
cashback_funding,
company_referral,
connected_account_negative_balance,
cross_border_percentage_fee,
currency_conversion_incoming,
currency_conversion_outgoing,
dispute_alert_fee,
dispute_hold_adjustment,
dispute_representment_fee,
economic_intelligence_percentage_fee,
external_card_load_deposit,
fees,
fraud_prevention_fee,
fx_percentage_fee,
high_risk_merchant_fee,
installment_default,
internal_balance_transfer_incoming,
internal_balance_transfer_outgoing,
internal_withdrawal,
internal_withdrawal_complete,
internal_withdrawal_fee,
internal_withdrawal_fee_reversal,
internal_withdrawal_in_transit,
internal_withdrawal_in_transit_reversal,
internal_withdrawal_markup_fee,
internal_withdrawal_markup_fee_payout,
internal_withdrawal_markup_fee_payout_reversal,
internal_withdrawal_markup_fee_reversal,
internal_withdrawal_reversal,
legacy_crypto_payment,
legacy_payment,
legacy_payment_refund,
license_sale,
license_sale_commission,
license_sale_revenue,
marketplace_affiliate_fee,
misc_purchase,
misc_refund,
misc_reversal,
onboarding_reward,
onchain_deposit,
onchain_swap_source,
onchain_swap_target,
onchain_wallet_transfer_incoming,
onchain_wallet_transfer_outgoing,
onchain_withdrawal,
orchestration_percentage_fee,
partner_grant_reward,
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_refund,
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_fee,
platform_balance_transfer_incoming,
platform_balance_transfer_outgoing,
platform_covered_dispute,
platform_credits_granted,
platform_credits_payment,
platform_credits_payment_refund,
platform_earning,
platform_markup_fee,
platform_markup_fee_payout,
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,
swap_fee,
three_ds_fixed_fee,
topup,
topup_fee,
topup_reversal,
treasury_payin,
whop_processing_fee,
withdrawal,
withdrawal_clawback,
withdrawal_clawback_reversal,
withdrawal_fee,
withdrawal_fee_reversal,
withdrawal_markup_fee,
withdrawal_markup_fee_payout,
withdrawal_markup_fee_payout_reversal,
withdrawal_markup_fee_reversal,
withdrawal_reclassification,
withdrawal_reversal,
withdrawal_topup_adjustment
direction
enum<string>

Optional direction filter. money_in returns positive activity and money_out returns negative activity.

Available options:
money_in,
money_out
resource_id
string

Optional prefixed resource ID. Returns activity associated with that resource.

payment_id
string

Filter activity by payment ID (pay_), including related refunds, disputes, and fees. Combines with resource_id and other filters within the selected accounts. Unknown payments return an empty list.

activity_id
string

Optional ledger activity ID (for example line_3). Returns at most that one activity.

exclude_internal_movements
boolean
default:false

Whether to exclude balance reservations and balanced movements between the account's own balances.

balance_type
enum<string>

Which balance the activity changes. total includes available, pending, and reserved funds. available includes only movements into or out of available funds, including reservations, releases, and fees. Movements within the selected balance are omitted. Omit to preserve the existing activity feed. Requires account_id or user_id; cannot be combined with available_after or available_before.

Available options:
total,
available
withdrawal_id
string

Withdrawal ID (wdrl_). With balance_type=available, selects the same period as its statement, after the previous withdrawal and through this withdrawal, excluding this withdrawal and its fee. Requires a single account. Overrides currency and posted-date filters.

currency
string

Optional currency code filter, for example usd.

posted_after
string<date-time>

Only include rows posted after this ISO 8601 timestamp.

posted_before
string<date-time>

Only include rows posted before this ISO 8601 timestamp.

available_after
string<date>

Only include balance credits and debits available on or after this YYYY-MM-DD date (UTC), distinct from posted_at. Requires currency.

available_before
string<date>

Only include balance credits and debits available on or before this YYYY-MM-DD date (UTC). Set equal to available_after for a single day. Requires currency.

limit
integer
default:20

Maximum number of rows to return.

Required range: x <= 100
cursor
string

Cursor returned by the previous page.

Response

activities listed for a user

data
object[]
required
page_info
object
required