Balance Transactions

Listar

Devuelve una lista de objetos BalanceTransaction. Los registros se devuelven en orden y los más recientes aparecen primero. Por defecto se devuelven los últimos 10 registros creados.

get/balance_transactions

Request

  • Base URL
    https://api.ventipay.com/v1
  • URL
    https://api.ventipay.com/v1/balance_transactions
  • Auth
    HTTP bearer

Query parameters

periodstring

Filtra por rango de fechas. Acepta qtd (trimestre en curso), ytd (año en curso) o un mes específico en formato YYYY-MM. Por defecto: mes en curso.

expandstring[]

Opciones: billing_invoice, discount, dispute, loan, payout, payment, refund

accounting_afterstring date-time

Filtra por fecha de contabilización. Retorna registros con accounting_at mayor o igual a la fecha indicada (ISO 8601). Con formato YYYY-MM-DD se interpreta en la zona horaria del comercio (inicio del día). Tiene precedencia sobre el inicio derivado de period.

accounting_beforestring date-time

Filtra por fecha de contabilización. Retorna registros con accounting_at menor a la fecha indicada (ISO 8601). Con formato YYYY-MM-DD se interpreta en la zona horaria del comercio e incluye el día completo. Tiene precedencia sobre el fin derivado de period.

created_afterstring date-time

Filtra por fecha de creación. Retorna registros con created_at mayor o igual a la fecha indicada (ISO 8601).

created_beforestring date-time

Filtra por fecha de creación. Retorna registros con created_at menor a la fecha indicada (ISO 8601).

billing_invoice_idstring

Filtra por ID de BillingInvoice

dispute_idstring

Filtra por ID de Dispute

loan_idstring

Filtra por ID de Loan

payment_idstring

Filtra por ID de Payment

payout_idstring

Filtra por ID de Payout

refund_idstring

Filtra por ID de Refund

typestring[]

Filtra por tipo. Valores comunes: payment, loan, refund, dispute, dispute_won, payout, fee, tax_fee, payout_fee, fee_reimbursement, tax_fee_reimbursement, topup, surcharge, surcharge_tax, minimum_balance_hold, minimum_balance_release.

-typestring[]

Excluye los tipos indicados. Acepta los mismos valores que type.

limitinteger

Cantidad máxima de registros a retornar. Mínimo 1, máximo 200. Por defecto 10.

starting_afterstring

Cursor de paginación. Retorna los registros posteriores al cursor. Usa el valor de next_cursor de una respuesta anterior.

ending_beforestring

Cursor de paginación. Retorna los registros anteriores al cursor. Usa el valor de previous_cursor de una respuesta anterior.

Changes

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