# API · consultTransactions

> Consulta masiva de transacciones por rango de fechas, moneda, orden o correo.

- kind: api-operation
- status: stable
- api_version: v1
- last_verified: 2026-08-29
- url: https://www.tilopay.com/developers/api/procesos-operativos/consult-transactions

```http
POST /api/v1/consultTransactions
```

## Qué hace [#que-hace]

Consulta transacciones por rango de fechas, con filtros opcionales.

## Autenticación [#autenticacion]

Requiere el token bearer del API en el header `Authorization` — ver [autenticación](/developers/api/autenticacion).

## Parámetros [#parametros]

<Param id="consult-transactions-parametro-key" name="key" type="string" required>
Key de la integración Tilopay.
</Param>

<Param id="consult-transactions-parametro-startdate" name="startDate" type="string" required>
Fecha de inicio, formato `Y-m-d H:i:s` — por ejemplo "2022-01-15 00:00:00".
</Param>

<Param id="consult-transactions-parametro-enddate" name="endDate" type="string" required>
Fecha de fin, formato `Y-m-d H:i:s` — por ejemplo "2022-08-01 23:59:59".
</Param>

<Param id="consult-transactions-parametro-onlyaproved" name="onlyAproved" type="integer">
Indica si se obtienen solo transacciones aprobadas.

| Código | Valor |
| --- | --- |
| 0 | Cualquiera |
| 1 | Solo aprobadas |
</Param>

<Param id="consult-transactions-parametro-environment" name="environment" type="integer">
Ambiente de las transacciones a obtener.

| Código | Valor |
| --- | --- |
| 0 | Producción |
| 1 | Pruebas |
</Param>

<Param id="consult-transactions-parametro-currency" name="currency" type="array">
Array de monedas que se desean obtener, por ejemplo ["USD", "CRC"].
</Param>

<Param id="consult-transactions-parametro-merchantid" name="merchantId" type="string">
Id de comercio.
</Param>

<Param id="consult-transactions-parametro-ordernumber" name="orderNumber" type="string">
Número de orden.
</Param>

<Param id="consult-transactions-parametro-email" name="email" type="string">
Correo del cliente.
</Param>

<Param id="consult-transactions-parametro-auth" name="auth" type="string">
Número de autorización.
</Param>

## Ejemplo de request [#request]

Los valores `<...>` son marcadores: reemplazalos por tus credenciales y datos.

```json
{
  "key": "<api_key>",
  "startDate": "2023-06-01 00:00:00",
  "endDate": "2023-06-30 23:59:59",
  "onlyAproved": 1,
  "environment": 1,
  "currency": [
    "USD",
    "CRC"
  ],
  "merchantId": "<merchantId>",
  "orderNumber": "12135",
  "email": "customer@example.com",
  "auth": "123456"
}
```

## Respuesta [#respuesta]

```json
{
  "type": "200",
  "message": "",
  "response": [
    {
      "id": 734329,
      "orderNumber": "12135",
      "amount": "5.00",
      "taxes": "0.00",
      "discount": "0.00",
      "discount_name": "",
      "currency": "USD",
      "merchantId": "<merchantId>",
      "code": "1",
      "response": "Transacción aprobada",
      "auth": "123456",
      "card": "4021",
      "last": "5221",
      "email": "customer@example.com",
      "commission": 0.18,
      "iva_commission": 0.02,
      "retention_iva": 0.27,
      "retention_rent": 0.09,
      "cost": 0.35,
      "cost_iva": 0.05,
      "net_to_liquidate": 4.04,
      "capture": "Capture",
      "type": "Payment",
      "environment": "Production",
      "date": "2024-07-31 16:59:20"
    },
    {
      "id": 734330,
      "orderNumber": "12136",
      "amount": "5.00",
      "taxes": "0.00",
      "discount": "0.00",
      "discount_name": "",
      "currency": "USD",
      "merchantId": "<merchantId>",
      "code": "1",
      "response": "Transacción aprobada",
      "auth": "123456",
      "card": "4021",
      "last": "5221",
      "email": "customer@example.com",
      "commission": 0.18,
      "iva_commission": 0.02,
      "retention_iva": 0.27,
      "retention_rent": 0.09,
      "cost": 0.35,
      "cost_iva": 0.05,
      "net_to_liquidate": 4.04,
      "capture": "Capture",
      "type": "Payment",
      "environment": "Production",
      "date": "2024-07-31 17:25:35"
    }
  ]
}
```

Para interpretar una respuesta que no es de éxito, ver [cómo leer una respuesta de error](/developers/api/procesos-operativos/errors).