# 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

<mark style="color:$success;">`GET STAGING`</mark> [`https://merchants-api-stg.tupayonline.com/v1/deposits`](https://merchants-api.tupayonline.com/v1/deposits)

<mark style="color:$success;">`GET PRODUCCION`</mark> [`https://merchants-api.tupayonline.com/v1/deposits`](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)

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

## RESPONSE

#### Deposits API – Campos de Respuesta

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tupayonline.com/documentacion-de-la-api/conciliacion/deposits.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.