Balance Actual

API de Consulta de Balance Actual

Descripción general

Este endpoint permite consultar el balance actual del comercio en la plataforma Tupay. El servicio retorna la información de saldos por moneda, incluyendo el saldo total, saldo disponible, y los montos en proceso de liquidación, lo que lo hace ideal para conciliación financiera, validaciones operativas y monitoreo de fondos.

La respuesta puede incluir uno o varios balances, dependiendo de la configuración del comercio (por ejemplo, múltiples monedas o tipos de cuenta).

Endpoint

GET STAGING https://merchants-api-stg.tupayonline.com/v1/balance

GET PRODUCCION https://merchants-api.tupayonline.com/v1/balance

Autenticación

El endpoint requiere autenticación mediante headers de autorización provistos por Tupay (por ejemplo, API Key / Bearer Token), los cuales deben ser enviados en cada solicitud

Response

Campo	Tipo	Descripción
balances	array	Lista de balances asociados al comercio.
balances.currency	string	Moneda del balance (ej. PEN).
balances.type	string	Tipo de balance (ej. PRIMARY).
balances.data	object	Información detallada del balance.
balances.data.totalBalance	number	Saldo total de la cuenta.
balances.data.availableBalance	number	Saldo disponible para uso o retiro.
balances.data.depositSettlementPeriod	number	Monto correspondiente a depósitos en proceso de liquidación.
balances.data.accountNumber	string	Número de cuenta asociado al balance.
hasWallet	boolean	Indica si el comercio tiene una billetera habilitada.
hasRolling	boolean	Indica si el comercio tiene un esquema de rolling habilitado.