Deposits

API de Consulta de Depósitos (Deposits)

Descripción general

Este endpoint permite consultar los depósitos (transacciones de ingreso) registrados en la plataforma Tupay dentro de un rango de fechas, utilizando como referencia la fecha de creación de la transacción en formato Unix Timestamp. El servicio está orientado principalmente a procesos de conciliación, reportes y validaciones operativas.

Endpoint

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

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

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.

Parámetros de consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
from	integer	Sí	Fecha inicial del rango de búsqueda, expresada en Unix Timestamp. Corresponde a la fecha de creación de la transacción.
to	integer	Sí	Fecha final del rango de búsqueda, expresada en Unix Timestamp. Debe respetar el rango máximo permitido por el servicio.
page	integer	No	Número de página para paginación de resultados.
country	string	No	Código del país asociado a la transacción (ejemplo: PE).
paymentMethod	string	No	Código del método de pago utilizado (por ejemplo: XA, XAQR, XABT,etc.).
status	string	No	Estado de la transacción (por ejemplo: approved, pending, rejected).
clientDocument	string	No	Documento de identidad del cliente asociado a la transacción.

RESPONSE

Deposits API – Campos de Respuesta

Campo	Tipo	Descripción
idDeposit	integer	Identificador único del depósito en Tupay.
externalId	string	Identificador externo de la transacción proporcionado por el comercio.
creationDate	string (ISO 8601)	Fecha y hora de creación de la transacción en UTC.
lastChangeDate	string (ISO 8601)	Fecha y hora de la última actualización del estado de la transacción.
countryName	string	Nombre del país donde se procesó la transacción.
country	string	Código ISO del país (ej. PE).
paymentMethodName	string	Nombre del método de pago procesado.
paymentMethodCode	string	Código del método de pago procesado.
requestedPaymentMethod	string	Código del método de pago solicitado originalmente.
requestedPaymentMethodName	string	Nombre del método de pago solicitado originalmente.
clientDocument	string	Documento de identificación del cliente.
amount	number	Monto final procesado de la transacción.
currency	string	Moneda del monto procesado.
balanceCurrency	string	Moneda del balance del comercio.
requestedAmount	number	Monto solicitado inicialmente por el cliente.
requestedCurrency	string	Moneda del monto solicitado.
localAmount	number	Monto de la transacción en moneda local.
localCurrency	string	Código de la moneda local.
localCountryTaxFee	number	Impuesto del país aplicado en moneda local.
usdCountryTaxFee	number	Impuesto del país aplicado en USD.
fee	number	Comisión cobrada por Tupay.
feeCurrency	string	Moneda de la comisión aplicada.
status	string	Estado actual de la transacción (ej. APPROVED, CANCELLED, PENDING).
idUser	string	Identificador interno del usuario.
flags	array	Indicadores adicionales asociados a la transacción.
idMerchant	integer	Identificador del comercio en Tupay.
merchantName	string	Nombre del comercio.
refundAttempted	boolean	Indica si se intentó realizar un reembolso.
installments	integer	Número de cuotas asociadas a la transacción.
allowPixApiRefund	boolean	Indica si la transacción permite reembolsos vía API.
page	integer	Número de página del resultado.
rows	integer	Cantidad de registros retornados en la página actual.
maxRows	integer	Número máximo de registros permitidos por página.