Skip to main content
Cada fila incluye un resource y un source tipados para que puedas presentar y enlazar el evento sin búsquedas adicionales. Usa la API de actividad financiera para crear un extracto o un feed de transacciones para una cuenta o un usuario, e informes financieros para resumir la actividad del saldo, los ingresos y los saldos en un intervalo de fechas, y luego desglosar el total de un informe en lo que lo originó.

Endpoints

Atributos

string
requerido
ID de la actividad del libro mayor.
account or user
La cuenta del visualizador propietaria del libro mayor de esta fila. Presente solo cuando la respuesta agrega cuentas propias (include_owned_accounts=true); se omite en otros casos.
string
requerido
Importe con signo en las unidades de precisión más pequeñas de la moneda.
string | null
requerido
Marca de tiempo ISO 8601 de cuándo esta actividad afecta a los fondos disponibles: 00:00:00 UTC en la fecha de liberación programada para créditos y débitos en un grupo de liberación de fondos confirmados pendiente; la hora de contabilización para créditos y débitos a fondos disponibles liquidados, incluidos reembolsos, disputas y retiros. Null para la actividad fuera de estas rutas, incluidas las filas on-chain. Los filtros available_after/before usan su fecha UTC; la actividad predeterminada excluye algunos movimientos, incluidas las reservas opcionales.
object
requerido
Moneda de esta actividad del libro mayor.

Propiedades

string
requerido
Código de moneda.
string
requerido
Factor de precisión de la moneda, por ejemplo 100000000 para USD.
string | null
La cuenta del libro mayor (un identificador ldgr_) a la que pertenece esta fila. Presente solo cuando la respuesta agrega cuentas propias (include_owned_accounts=true); se omite en otros casos. Combínala con account para limitar los paneles laterales y los enlaces del dashboard al negocio propietario.
string
requerido
La categoría de línea del libro mayor bajo la que se contabilizó esta actividad.Opciones disponibles: psp_payment_receivable, payment_gross, topup, topup_fee, payment_gross_reversal, topup_reversal, payment_refund, payment_refund_reversal, platform_balance_payment, platform_balance_payment_refund, ad_spend_purchase, psp_refund_payable, passthrough_gmv, passthrough_gmv_offset, installment_default, aggregated_fee, payment_processing_fixed_fee, payment_processing_percentage_fee, billing_percentage_fee, cross_border_percentage_fee, fx_percentage_fee, orchestration_percentage_fee, revshare_percentage_fee, stripe_domestic_processing_fee, stripe_international_processing_fee, three_ds_fixed_fee, whop_processing_fee, economic_intelligence_percentage_fee, high_risk_merchant_fee, fraud_prevention_fee, buyer_fee, sales_tax_fee, payout_fee, affiliate_fee, marketplace_affiliate_fee, application_fee, platform_markup_fee, platform_markup_fee_payout, sales_tax_remittance, sales_tax_remittance_reversal, sales_tax_collected, sales_tax_collected_reversal, sales_tax_remitted, payment_dispute, payment_dispute_adjustment, payment_dispute_fee, payment_dispute_reversal, platform_covered_dispute, dispute_alert_fee, dispute_representment_fee, payment_return_fee, dispute_hold_adjustment, dispute_hold_blocked, psp_dispute_payable, withdrawal, withdrawal_payable, withdrawal_payable_reversal, withdrawal_fee, withdrawal_fee_reversal, withdrawal_markup_fee, withdrawal_markup_fee_reversal, withdrawal_markup_fee_payout, withdrawal_markup_fee_payout_reversal, withdrawal_reversal, withdrawal_clawback, withdrawal_clawback_reversal, payout_receivable, withdrawal_reclassification, clawback_receivable, clawback_receivable_reversal, capital_withholding, capital_withholding_reversal, capital_hold, capital_hold_release, capital_remittance, capital_remittance_reversal, treasury_payin, treasury_payin_receivable, onchain_deposit, onchain_deposit_offset, onchain_withdrawal, onchain_withdrawal_offset, trading_account_withdrawal, trading_account_withdrawal_offset, trading_account_deposit, trading_account_deposit_offset, perps_load_transfer, perps_load_deposit, perps_unload_transfer, perps_unload_deposit, perps_bridge_fee, perps_bridge_fee_offset, perps_volume, perps_volume_offset, perps_fee, perps_fee_offset, platform_trading_commission, trading_fee, perps_realized_pnl, perps_realized_pnl_offset, onchain_wallet_transfer_outgoing, onchain_wallet_transfer_incoming, onchain_platform_transfer_outgoing, onchain_platform_transfer_incoming, onchain_internal_transfer_outgoing, onchain_internal_transfer_incoming, onchain_swap_source, onchain_swap_target, savings_revaluation, onchain_swap_offset, whop_swap_fee_received, swap_fee, internal_withdrawal, internal_withdrawal_reversal, internal_withdrawal_payable, internal_withdrawal_payable_reversal, internal_withdrawal_fee, internal_withdrawal_fee_reversal, internal_withdrawal_markup_fee, internal_withdrawal_markup_fee_reversal, internal_withdrawal_markup_fee_payout, internal_withdrawal_markup_fee_payout_reversal, internal_withdrawal_in_transit, internal_withdrawal_complete, internal_withdrawal_in_transit_reversal, card_load_transfer, card_load_deposit, card_unload_transfer, card_unload_deposit, external_card_load_deposit, external_card_load_offset, card_spend_authorization, card_spend_authorization_hold, card_spend_capture, card_spend_capture_offset, card_spend_authorization_void, card_spend_authorization_void_release, card_spend_refund, card_spend_refund_offset, cashback, cashback_expense, cashback_funding, card_interchange_receivable, card_interchange, account_settlement, currency_conversion_outgoing, currency_conversion_incoming, balance_reservation, balance_reservation_hold, balance_reservation_reversal, balance_reservation_release, bad_debt_offset, bad_debt_expense, platform_credits_payment, platform_credits_payment_refund, platform_credits_granted, levels_points_card, levels_points_ads, levels_points_trading, levels_points_partner, levels_points_action, levels_points_burned, levels_points_issued, levels_rebate, marketing_expense, platform_balance_transfer_outgoing, platform_balance_transfer_incoming, internal_balance_transfer_outgoing, internal_balance_transfer_incoming, platform_balance_transfer_fee, connected_account_clawback, connected_account_negative_balance, ad_publisher_payout, ad_publisher_payout_received, company_referral, platform_affiliate_payment, platform_affiliate_payment_reversal, onboarding_reward, partner_grant_reward, payment_revshare, payment_revshare_payout, payment_revshare_reversal, payment_revshare_refund, payment_referral, payment_referral_payable, payment_referral_reversal, payment_referral_refund, application_fee_payable, application_fee_payout, platform_earning, airdrop, airdrop_reversal, airdrop_expense, airdrop_expense_reversal, airdrop_link_funded, airdrop_link_canceled, airdrop_link_returned, airdrop_link_claimed, airdrop_link_redeemed, airdrop_link_created, resolution_center_refund, ad_funding_disbursement, ad_campaign_budget, ads_card_spread, ad_spend_charge, ad_network_cost, ad_spend_margin, ad_income_expense, ad_income_receipt, ad_budget_release, ad_network_settlement, ad_affiliate_payout, ad_affiliate_payout_received, ad_balance_funding_receipt, misc_reversal, fx_gain_loss, fx_markup, legacy_crypto_payment, legacy_payment, legacy_payment_refund, license_sale, license_sale_commission, license_sale_revenue, software_rental_revshare, software_rental_transaction, misc_purchase, misc_refund, referral_bonus, promo_reversal, payment_receivable_settlement, platform_earning_settlement, platform_earning_unreconciled_clearing, payment_receivable_clearing, payment_receivable_reversal, payment_unreconciled_clearing, payment_unreconciled_reversal, settlement_shortfall_loss, fx_settlement_gain_loss, settlement_rounding_variance, psp_payout_settlement, psp_payout_deposit, psp_payout_receivable, psp_payout_receivable_clearing, payout_unreconciled_clearing, psp_currency_conversion_outgoing, psp_currency_conversion_incoming, psp_currency_conversion_receivable, psp_currency_conversion_receivable_clearing, psp_fx_adjustment, refund_settlement, refund_settlement_reversal, refund_payable_clearing, refund_payable_reversal, refund_unreconciled_clearing, refund_unreconciled_reversal, psp_account_debit, payment_refund_fee, dispute_settlement, dispute_settlement_reversal, dispute_payable_clearing, dispute_payable_reversal, dispute_unreconciled_clearing, dispute_unreconciled_reversal, psp_reserve_hold, psp_reserve_release, psp_dispute_fee, psp_dispute_alert_fee, psp_refund_fee, psp_account_updater_fee, psp_adjusted_processing_fee, psp_authentication_fee, psp_commission_fee, psp_fixed_fee, psp_gateway_fee, psp_interchange_fee, psp_invoice_tax_fee, psp_markup_fee, psp_network_token_fee, psp_optimization_fee, psp_payment_method_fee, psp_payout_fee, psp_processing_fee, psp_risk_fee, psp_scheme_fee, psp_variable_fee, psp_billing_fee, psp_tax_service_fee, psp_connect_fee, external_account_connection_fee, psp_external_account_connection_fee, psp_invoicing_fee, psp_terminal_fee, treasury_fee, psp_treasury_fee, accelerated_settlement_fee, psp_accelerated_settlement_fee, psp_receivable_pooled, psp_pool_settlement, psp_pool_clearing, psp_pool_refund_settlement, psp_pool_refund_clearing, psp_correction, psp_payin_settlement, psp_payin_clearing, psp_bank_pull_settlement, psp_bank_pull_clearing, psp_pool_dispute_settlement, psp_payout_consolidation, psp_withholding_tax, psp_payout_settlement_reversal, psp_transfer_settlement, psp_transfer_settlement_reversal, psp_collection_settlement, payout_subsidy, withdrawal_topup_adjustment, withdrawal_payable_clearing, withdrawal_payable_clearing_reversal, identity_verification_fee, psp_identity_verification_fee, tax_filing_fee, psp_tax_filing_fee, psp_service_fee, recipient_wallet_load, psp_recipient_wallet_load, dispute_management_fee, psp_dispute_management_fee, psp_clawback_settlement, psp_clawback_settlement_reversal, clawback_receivable_settlement, clawback_receivable_settlement_reversal, clawback_fee, psp_clawback_fee, deposit, wallet_transfer_incoming, wallet_transfer_outgoing, swap_source, swap_target
string
requerido
payment | null
Pago relacionado con esta actividad del libro mayor. Se incluye cuando la hidratación enriquecida de recursos está habilitada y el movimiento está vinculado a un pago.

Propiedades

string
requerido
ID del pago, con el prefijo pay_.
object | null
requerido
Total cobrado por el pago.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string | null
requerido
Marca de la tarjeta, cuando el cliente pagó con tarjeta.
string | null
requerido
Últimos cuatro dígitos de la tarjeta, cuando el cliente pagó con tarjeta.
string
requerido
Cuándo se creó el pago.
string
requerido
string | null
requerido
Cómo pagó el cliente, como card o paypal.
string | null
requerido
Procesador que gestionó el pago, como stripe.
object | null
requerido
Variante asociada al pago, cuando corresponda.

Propiedades

string
requerido
ID de la variante, con el prefijo plan_.
string | null
requerido
Nombre de la variante.
object | null
requerido
Producto asociado al pago, cuando corresponda.

Propiedades

string
requerido
ID del producto, con el prefijo prod_.
string
requerido
Nombre del producto.
object | null
requerido
Cliente asociado al pago. El correo electrónico requiere member:email:read.

Propiedades

string
requerido
ID del cliente, con el prefijo user_.
string | null
requerido
Correo electrónico del cliente, o null sin member:email:read.
string
requerido
Nombre visible del cliente.
string | null
ID del pago para cualquier actividad relacionada con pagos, incluidos reembolsos y disputas.
string | null
ID de la variante asociada al pago, cuando corresponda.
string | null
Nombre de la variante asociada al pago, cuando corresponda.
string
requerido
Cuándo se contabilizó la actividad en el libro mayor.
string | null
ID del producto asociado al pago, cuando corresponda.
string | null
Nombre del producto asociado al pago, cuando corresponda.
account or user or bounty or ledger_account or payment_method or payout_method or card_transaction | null
requerido
Recurso asociado a esta actividad del libro mayor.
object | null
requerido
Origen de esta actividad del libro mayor. Las comisiones de margen de la plataforma usan el objeto platform_fee y el ID de la actividad del libro mayor.

Propiedades

string
requerido
number | null
Importe del retiro como número decimal en la moneda de destino (solo orígenes de tipo payout; requiere payout:withdrawal:read).
string | null
Marca de la tarjeta usada por el origen del pago.
string | null
Cadena en la que se recibió el depósito, por ejemplo plasma (solo orígenes onchain_transaction).
string | null
La URL de reclamación del airdrop. Null salvo que el llamante pueda gestionar enlaces de reclamación en la cuenta de financiación o retirar del saldo personal de financiación.
string | null
Hora de creación del retiro como marca de tiempo ISO 8601 (solo orígenes de tipo payout; requiere payout:withdrawal:read).
object | null
Usuario que solicitó el retiro. Null para retiros generados por el sistema o sin payout:withdrawal:read.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.
string
requerido
Nombre de usuario público.
string | null
Llegada estimada como marca de tiempo ISO 8601 (solo orígenes de tipo payout; requiere payout:withdrawal:read).
object | null
Comisiones totales del retiro, incluidas las comisiones de margen. Requiere payout:withdrawal:read.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string | null
Acción que generó una comisión de margen de la plataforma: deposit, swap, transfer, card_spend o payout. Presente para platform_markup_fee y platform_markup_fee_payout, incluso cuando include_resource es false. Null cuando la acción de origen no está disponible; se omite en otros tipos de origen.Opciones disponibles: payout, transfer, deposit, swap, card_spend
string | null
Si las comisiones del retiro son inclusivas o exclusivas. Requiere payout:withdrawal:read.Opciones disponibles: exclusive, inclusive
string | null
Importe convertido desde from_currency como cadena decimal (solo orígenes de tipo swap).
string | null
Código de moneda en minúsculas desde el que se convirtió (solo orígenes de tipo swap).
string | null
Nota adjunta al origen transfer, payout o bank_deposit, o null cuando no se proporcionó ninguna (en orígenes de tipo payout requiere payout:withdrawal:read).
string
requerido
string | null
En orígenes de tipo payout, el nombre de la entidad que procesa el retiro (requiere payout:withdrawal:read). En orígenes de tipo bank_deposit, el nombre de la cuenta que envió el depósito.
object | null
Total cobrado por el origen del pago.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string | null
Método de pago usado por el origen del pago. En orígenes de tipo bank_deposit, la red de transferencia: wire, ach o rtp.
string | null
Procesador usado por el origen del pago.
object | null
Principal del retiro enviado al destino, sin incluir comisiones, en la moneda del retiro. Requiere payout:withdrawal:read.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
object | null
Información visible del destino del retiro (solo orígenes de tipo payout).

Propiedades

string | null
string | null
string | null
La respuesta de seguridad que el comerciante estableció al añadir este método de retiro (por ejemplo, un Interac e-Transfer), necesaria para reclamar el retiro. null cuando el destino no tiene una respuesta personalizada. Requiere payout:destination:read.
string | null
Alias guardado del destino del retiro (solo orígenes de tipo payout).
string | null
Por qué se produjo la actividad. En orígenes de tipo transfer es el motivo de la transferencia, por ejemplo pool_top_up o bounty_return. En orígenes de tipo payout explica por qué el retiro se canceló, se denegó o falló (requiere payout:withdrawal:read); null mientras el retiro avanza con normalidad.
boolean | null
Si este retiro está retenido actualmente para una revisión manual de riesgos (solo orígenes de tipo payout; requiere payout:withdrawal:read).
string | null
En orígenes onchain_transaction, la dirección de la billetera remitente o el identificador del proveedor de onramp. En orígenes de tipo bank_deposit, los últimos cuatro dígitos de la cuenta bancaria remitente, como ••••1547.
string | null
Estado del ciclo de vida. En orígenes de tipo payout es el estado del retiro (requiere payout:withdrawal:read); en orígenes airdrop_link es el estado del enlace de reclamación (sin restricciones); en orígenes de pago y de recarga es el estado de pago legible, como succeeded/pending/failed (sin restricciones); en orígenes de tipo bank_deposit es succeeded, reversal_in_progress o reversed (sin restricciones).
string | null
Importe recibido en to_currency como cadena decimal (solo orígenes de tipo swap).
string | null
Código de moneda en minúsculas al que se convirtió (solo orígenes de tipo swap).
string | null
Referencia de rastreo bancario del retiro. Requiere payout:withdrawal:read.
string | null
Hash de la transacción on-chain (solo orígenes onchain_transaction y swap).
string | null
requerido
Valor en dólares de este movimiento como cadena decimal, con el mismo signo que amount. Se convierte a partir del importe contabilizado al tipo de cambio vigente cuando se contabilizó la línea —el mismo precio que usan el gráfico de saldo de la billetera y los informes financieros—, de modo que una fila de cripto también incluye su valor en dólares. null para una moneda para la que Whop no tiene tipo de cambio.
string | null
Correo electrónico del cliente asociado al pago. Requiere member:email:read.
string | null
ID del cliente asociado al pago.
string | null
Nombre visible del cliente asociado al pago.
LedgerActivity

Glosario de tipos de línea

Cada fila de actividad incluye un line_type que nombra el evento financiero que representa. Pasa uno o más line_types a Listar actividad financiera para filtrar el feed a eventos específicos, ya sea como parámetros line_types[] repetidos o como un único valor separado por comas (line_types=payment_gross,payment_refund). Los tipos de línea desconocidos devuelven un 400. El término método de pago local (LPM) se refiere a un método que no es tarjeta, incluidos los débitos bancarios, las transferencias bancarias y las billeteras.

Categorías

En lugar de enumerar tipos de línea individuales, puedes pasar una categoría abreviada. Una categoría se expande a todos los tipos de línea que contiene.

Pagos

Reembolsos

Disputas

Reservas

Retiros

Transferencias

Conversión de moneda

Afiliados y reparto de ingresos

Airdrops

Publicidad

Activos on-chain y tarjetas

onchain_deposit es opcional: se excluye del feed predeterminado y solo se devuelve cuando lo solicitas explícitamente en line_types.

Heredados y varios

Comisiones