Transaction List - Kushki Developer Portal

Obtén un listado paginado de tus transacciones con múltiples opciones de filtro. Usa este endpoint para conciliación, reportes y búsqueda de transacciones.

INFO

Servicio disponible solo en México.

Requisitos

Una cuenta válida

Tu token de usuario

Entornos

Entorno	URL base
Dev	`https://valquiria.billpocket.dev`
Live	`https://valquiria.billpocket.com`

Flujo de autenticación

La API del listado de transacciones usa un JWT de corta duración. Intercambia tu token de usuario por un token de sesión antes de consultar.

WARNING

El token de sesión expira después de 6 horas.

1. Obtén un token de sesión

POST /api/v1/token

{
  "token": "your-user-token"
}

Respuesta:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

2. Consulta el listado de transacciones

GET /api/v1/transactions?dateFrom={ISO8601}&dateTo={ISO8601}

Envía el token de sesión en la cabecera Authorization.

https://valquiria.billpocket.dev/api/v1/transactions?dateFrom=2024-01-01T00:00:00&dateTo=2024-01-31T23:59:59

Respuesta:

{
  "data": [
    {
      "transaction_id": 105242,
      "authorization_number": "BP4460",
      "bank": "BANCOMER",
      "card_brand": "Visa",
      "card_type": "CREDIT",
      "capture_method": "ec",
      "commission": 8.94,
      "countercharged": false,
      "date": "2024-01-15T13:48:12.000Z",
      "details": "Product description",
      "device": "Terminal-001",
      "error_detail": "",
      "masked_card": "424242******4242",
      "msi": null,
      "retention": 0.93,
      "rejection_code": null,
      "subtotal": 437.71,
      "surcharge": 0,
      "tip": 0,
      "total_amount": 449,
      "transaction_type": "venta",
      "transaction_status": "aprobada",
      "vat": 1.43
    }
  ],
  "currentPage": 1,
  "perPage": 100,
  "total": 456
}

Filtros disponibles

Agrega parámetros de consulta para acotar los resultados:

Parámetro	Descripción
`dateFrom`	Fecha de inicio (ISO 8601, por ejemplo, `2024-01-01T00:00:00`)
`dateTo`	Fecha de fin (ISO 8601)
`size`	Resultados por página
`page`	Número de página
`device`	Filtra por nombre del dispositivo
`bin`	Filtra por el BIN de la tarjeta
`captureMethod`	`ec`, `nfc`, `msc`, etc.
`transactionStatus`	`aprobada`, `rechazada`, `rechazadaRiesgo`, etc.
`transactionType`	`venta`, `devolucion`
`card`	Número de tarjeta enmascarado
`uniqueReference`	Referencia de Cloud Terminal API (v2+)
`timezone`	Zona horaria para el filtrado por fecha (v4+)

Ejemplo con filtros:

GET /api/v1/transactions?dateFrom=2024-01-01T00:00:00&dateTo=2024-01-31T23:59:59&captureMethod=ec&transactionStatus=aprobada&page=1&size=50

Versiones de la API

Versión	Cambios principales
v1	Original. Nombres de campo en snake case
v2	Campos en camel case, filtro `uniqueReference`, campo `chargeback`
v3	`rejectionCode`, `finalAmount`, `msiFee` y `refundedTransactionId` renombrados
v4	Filtro `timezone`, formato de fecha RFC 9557

Próximos pasos

Revisa la referencia de la API del listado de transacciones

¿Tienes una sugerencia sobre esta documentación? Contáctanos.

Listado de transacciones

Requisitos#

Entornos#

Flujo de autenticación#

1. Obtén un token de sesión#

2. Consulta el listado de transacciones#

Filtros disponibles#

Versiones de la API#

Próximos pasos#

Requisitos

Entornos

Flujo de autenticación

1. Obtén un token de sesión

2. Consulta el listado de transacciones

Filtros disponibles

Versiones de la API

Próximos pasos