Consulta y gestiona
tus cobros con Yappy.
APIs REST para acceder a tu historial de transacciones, verificar pagos individuales, listar tus puntos de cobro activos y anular transacciones — todo desde tu propio sistema, sin entrar al portal web de Yappy Comercial.
¿Qué son las Integraciones Yappy?
Una capa de consulta y gestión sobre transacciones que ya ocurrieron en Yappy, independientemente del método de cobro que las generó.
Las Integraciones Yappy son un conjunto de APIs que Yappy Comercial pone a disposición de los comercios afiliados para darles visibilidad, trazabilidad y control programático sobre sus cobros. A diferencia de Botón de Pago y Yappy en Caja — que son los productos con los que se procesa el pago — estas APIs operan después de que el pago ya ocurrió: permiten consultarlo, listarlo, ver qué métodos de cobro están activos y anularlo si todavía no se liquidó.
Estas APIs no inician cobros. Para cobrarle a un cliente necesitas Botón de Pago (online) o Yappy en Caja (presencial). Las Integraciones Yappy trabajan sobre transacciones ya existentes.
¿En qué se diferencia de los otros productos?
| Aspecto | Botón de Pago | Yappy en Caja | Integraciones Yappy |
|---|---|---|---|
| ¿Qué hace? | Cobra en tu sitio web / app | Cobra en tu tienda física con QR | Consulta y gestiona cobros ya realizados |
| ¿Inicia pagos? | Sí | Sí | No |
| Credenciales | Propias (API Key + Secret) | Propias (API Key + Secret) | Independientes, se generan en “Integraciones” |
| Autenticación | Token por orden | Token por sesión de caja | Token de sesión JWT (24 h) + HMAC-SHA256 |
| ¿Qué métodos cubre? | Solo cobros de Botón de Pago | Solo cobros de Yappy en Caja | Todos los métodos: Botón de Pago, Yappy en Caja, Puntos de Cobro Yappy, Directorio, etc. |
Arquitectura de la integración
sequenceDiagram
box Tu sistema interno
participant SYS as Backoffice / ERP<br/>del comercio
participant DB as Base de datos
end
box Yappy
participant API as Integraciones Yappy API<br/>session + movement + transaction
end
SYS->>API: 1. POST /session/login (HMAC code)
API-->>SYS: 2. Token JWT (válido 24 h)
SYS->>API: 3. POST /movement/history (rango fechas)
API-->>SYS: 4. Lista paginada de transacciones
SYS->>DB: 5. Guarda / concilia registros
SYS->>API: 6. PUT /transaction/{id} (anular)
API-->>SYS: 7. Confirmación de anulación Endpoints disponibles
| Método | Endpoint | Qué hace |
|---|---|---|
POST | /session/login | Abre sesión y obtiene el token JWT |
GET | /session/logout | Cierra la sesión activa |
POST | /movement/history | Historial paginado de transacciones (hasta 90 días) |
GET | /movement/{id} | Detalle completo de una transacción |
GET | /collection-method | Lista todos los puntos de cobro activos del comercio |
PUT | /transaction/{id} | Anula una transacción que aún no se liquidó |