Casos de uso¶

Lo que puedes construir con las APIs de Integraciones Yappy en tu propia plataforma.

Conciliación contable automatizada¶

Automatiza el cruce del historial de Yappy contra tu sistema de facturación o ERP sin exportaciones manuales.

Hoy muchos comercios exportan manualmente reportes del portal de Yappy Comercial y los cruzan contra sus registros internos. Con POST /movement/history puedes automatizar ese proceso completo.

Cómo funciona

• Consultas el historial de transacciones para un rango de fechas (hasta 90 días por llamada).
• Cruzas cada transacción contra los registros de tu sistema de facturación, ERP o contabilidad usando el id de la transacción como llave.
• Marcas automáticamente los registros conciliados y alertas sobre discrepancias.

APIs involucradas

• POST /movement/history — historial paginado con filtros por fecha y punto de cobro.

Resultado esperado

Cierre contable diario o semanal sin intervención manual, con trazabilidad completa de qué se cobró y cuándo se liquidó.

Validación de pagos antes del despacho¶

Confirma programáticamente que el pago llegó antes de autorizar el despacho o la entrega del pedido.

En flujos de e-commerce o pedidos a domicilio, confirmar que el pago llegó efectivamente antes de despachar un pedido es crítico. Con GET /movement/{id} puedes hacerlo de forma programática.

Cómo funciona

• Al recibir una notificación de pago (por IPN de Botón de Pago o por polling), consultas el detalle de la transacción usando su id.
• Verificas que status === "COMPLETED" o "EXECUTED" y que el charge.amount coincide con el monto del pedido.
• Solo si la verificación es exitosa, tu sistema autoriza el despacho o activa el flujo siguiente.

APIs involucradas

• GET /movement/{id} — detalle completo de una transacción por su identificador único.

Resultado esperado

Eliminación de despachos por error en pagos no confirmados, sin depender únicamente de webhooks o notificaciones que pueden llegar con retraso.

Dashboard interno de ventas¶

Consolida las métricas de Yappy en tu propio panel interno sin acceder al portal de Yappy Comercial.

Si tu equipo comercial o de operaciones necesita visibilidad sobre los ingresos de Yappy sin acceder al portal web de Yappy Comercial, puedes construir un panel propio alimentado directamente desde la API.

Cómo funciona

• Consultas el historial paginado con el rango y los filtros por punto de cobro que necesitas.
• Consolidas métricas como volumen total, ticket promedio, distribución por método de cobro y evolución diaria.
• Presentas los datos en el formato que más le sirva a tu equipo: tabla, gráfico, reporte exportable.

APIs involucradas

• POST /movement/history — historial de transacciones con filtros y paginación.
• GET /collection-method — lista de puntos de cobro activos para segmentar los datos.

Resultado esperado

Tu equipo ve las ventas de Yappy en el mismo panel donde ya gestionan el resto del negocio, sin cambiar de herramienta.

Anulación de pagos desde tu backoffice¶

Procesa devoluciones directamente desde tu plataforma de gestión sin acceder manualmente al portal de Yappy.

Cuando un cliente solicita una devolución, hoy el proceso típico requiere acceder manualmente al portal de Yappy Comercial. Con PUT /transaction/{id} puedes operarlo directamente desde tu plataforma de gestión, siempre que la transacción aún no se haya liquidado.

Cómo funciona

• Tu backoffice o sistema de atención al cliente inicia la anulación.
• Consultas primero el estado con GET /movement/{id} para confirmar que es EXECUTED (aún no liquidada).
• Si el estado lo permite, envías PUT /transaction/{id} para revertir el cobro.
• Registras el resultado en tu sistema con la confirmación de Yappy.

APIs involucradas

• GET /movement/{id} — verificación del estado previo a la anulación.
• PUT /transaction/{id} — endpoint de anulación del cobro.

Resultado esperado

Devoluciones procesadas en segundos desde tu propia plataforma, sin acceso al portal de Yappy, con registro completo en tu sistema de gestión.

Auditoría de puntos de cobro activos¶

Mantén un inventario actualizado y programático de los canales de cobro activos en Yappy.

Si tu comercio tiene múltiples canales — sitio web, tiendas físicas con Yappy en Caja, perfil en el directorio — mantener un inventario actualizado de los puntos de cobro activos puede ser útil para auditorías internas o para segmentar reportes.

Cómo funciona

• Consultas periódicamente GET /collection-method para obtener la lista actualizada de puntos de cobro con sus tipos y detalles.
• Cruzas contra tu inventario interno para detectar puntos nuevos, eliminados o con cambios de nombre.
• Usas los alias exactos como filtros en las consultas de historial, asegurándote de que los nombres sean siempre correctos.

APIs involucradas

• GET /collection-method — lista completa de canales de cobro registrados en Yappy.

Resultado esperado

Visibilidad programática de qué canales de cobro están activos en Yappy, sin depender de accesos manuales al portal.

¿Por dónde empezar?¶

Independientemente del caso de uso que quieras implementar, el punto de partida es el mismo: obtener tus credenciales y completar el flujo de autenticación.