Sign in
balanceTransactions

Listar movimientos del balance

Lista el ledger de la cuenta, del movimiento más reciente al más antiguo: es la forma API del estado de cuenta descargable. Los montos son firmados: positivo acredita el balance y negativo lo debita.

amount_in_cents es el bruto y net_amount_in_cents es lo que efectivamente movió el balance; sumar fee_in_cents al bruto siempre da el neto. En un cobro, fee_details desglosa esa diferencia en la comisión y el IVA retenido, las mismas columnas del reporte descargable. balance_after_in_cents corresponde a la columna Balance de ese reporte.

Para conciliar un mes, filtra con from_time + until_time y sube items hasta 100. Cada par de fechas se envía completo: enviar solo una mitad devuelve 400 en vez de ignorar el rango.

No existe forma de preguntar qué cobros financiaron un retiro: Recurrente registra el débito del retiro y nada más, así que esa relación habría que inventarla. El camino inverso sí existe — cada movimiento en GET /api/transfers trae balance_transaction_id, la fila de ledger que registró.

get/balance_transactions

Query parameters

from_timestring date-time

Inicio del rango de creación. Si se envía como fecha sin hora, se interpreta como el inicio del día. Se aplica solo junto con until_time.

until_timestring date-time

Fin del rango de creación. Si se envía como fecha sin hora, se interpreta como el final del día. Se aplica solo junto con from_time.

currencystring

Moneda del balance a consultar. Sin este filtro la lista mezcla todas las monedas de la cuenta.

typestring

Tipo contable del movimiento, por ejemplo charge, payout, refund o dispute.

pageinteger

Página a devolver. La respuesta trae los encabezados link, current-page, total-pages y total-count.

itemsinteger

Elementos por página.

Headers

X-SECRET-KEYstring required

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Response

Movimientos del balance

idstring required

ID público del movimiento del balance. Los movimientos registrados antes de que el ledger fuera público conservan el prefijo ba_; trata el ID como opaco.

account_idstring required

Cuenta cuyo balance cambió

typestring required

Tipo contable del movimiento

amount_in_centsinteger required

Monto bruto firmado en centavos; positivo acredita y negativo debita

fee_in_centsinteger

Lo retenido sobre el bruto, firmado. Sumado a amount_in_cents da net_amount_in_cents

net_amount_in_centsinteger required

Monto firmado que efectivamente movió el balance

currencystring required

Moneda del balance

descriptionstring nullable

Descripción opcional del movimiento

balance_before_in_centsinteger nullable

Snapshot del balance antes del movimiento, cuando está disponible

balance_after_in_centsinteger nullable

Snapshot del balance después del movimiento; equivale a la columna Balance del reporte descargable

created_atstring date-time required

Momento en que el movimiento fue registrado

Changes

No recorded changes to this endpoint across all 1 revision of this API.