Preguntas frecuentes

Las consultas más comunes sobre las APIs de Integraciones Yappy.

Generales

¿Las Integraciones Yappy reemplazan al portal web de Yappy Comercial?

No. El portal web sigue siendo la herramienta principal para configurar tu comercio, ver reportes visuales, generar credenciales y gestionar tus datos. Las APIs de Integraciones Yappy son un complemento programático: te permiten integrar esas capacidades dentro de tus propios sistemas (ERP, backoffice, dashboards) sin tener que entrar al portal manualmente.

¿Necesito ya tener Botón de Pago o Yappy en Caja para usar estas APIs?

Sí. Las Integraciones Yappy consultan transacciones que ya existen en tu cuenta. Si tu comercio aún no tiene ningún método de cobro activo, no habrá datos que consultar. El orden natural es: primero configuras cómo cobrar (Botón de Pago o Yappy en Caja), y luego usas las Integraciones para gestionar programáticamente esos cobros.

¿Puedo consultar transacciones de Botón de Pago y Yappy en Caja en la misma llamada?

Sí. El endpoint /movement/history devuelve todas las transacciones del comercio sin importar el método de cobro que las generó. Puedes diferenciarlas usando el campo type de cada transacción (TXN-ECOM para Botón de Pago, TXN-CHECKOUT para Yappy en Caja) o aplicando el filtro COLLECTION_ALIAS para limitar los resultados a un punto de cobro específico.

Credenciales y autenticación

¿Por qué hay tres credenciales en lugar de dos?

El diseño tiene una razón de seguridad. La API Key identifica al comercio. La Clave secreta autentica cada request. El Seed nunca viaja en las llamadas — se usa solo localmente para calcular el code de login mediante HMAC-SHA256. Esto evita que el Seed esté expuesto en tráfico HTTP incluso si alguien intercepta las llamadas.

¿Qué pasa si regenero mis credenciales mientras hay sesiones activas?

Las nuevas credenciales invalidan inmediatamente las anteriores, incluyendo cualquier token JWT activo generado con las credenciales viejas. Cualquier llamada en vuelo que use el token anterior empezará a fallar. Coordina la regeneración con tu equipo para minimizar el impacto en producción.

¿Las credenciales de UAT y producción son las mismas?

No está confirmado en la documentación disponible. El flujo de generación de credenciales es el mismo en ambos ambientes (portal Yappy Comercial → Integraciones), pero cada ambiente tiene su propia URL base. Se recomienda usar sets de credenciales separados para UAT y producción para mantener el aislamiento entre ambientes. Confirma con el equipo técnico de Yappy antes de salir a producción.

¿Puedo tener más de una sesión abierta simultáneamente?

No está especificado en la documentación oficial. Por precaución, trata el token como un recurso singleton: usa uno por proceso/instancia y renuévalo cuando expire. Si necesitas múltiples workers paralelos, evalúa si pueden compartir el mismo token mientras esté vigente.

Transacciones y anulaciones

¿Puedo anular una transacción que fue hecha con Botón de Pago desde estas APIs?

Sí. El endpoint PUT /transaction/{id} funciona para transacciones de cualquier método de cobro, incluyendo Botón de Pago. La única condición es que la transacción esté en estado EXECUTED — es decir, que aún no se haya liquidado en tu cuenta bancaria.

¿Cuál es la diferencia entre EXECUTED y COMPLETED?

EXECUTED significa que el cliente pagó pero el dinero aún no se ha depositado en tu cuenta bancaria — la transacción está “en tránsito”. COMPLETED significa que el dinero ya fue liquidado en tu cuenta.

Solo puedes anular transacciones en estado EXECUTED. Una vez que están COMPLETED, la anulación programática no es posible.

¿Cuándo se liquidan las transacciones?

La liquidación ocurre típicamente al cierre del día hábil. Una transacción recibida durante el día estará en estado EXECUTED hasta que se procese el corte. Si necesitas anular una transacción del día, hazlo antes de ese cierre. Para detalles específicos sobre tu plan de liquidación, consulta con tu Customer Success Officer de Yappy.

Consultas y filtros

¿Por qué el filtro COLLECTION_ALIAS no devuelve resultados?

El valor del filtro debe coincidir exactamente con el nombre del punto de cobro — incluyendo mayúsculas, minúsculas y espacios. Usa GET /collection-method para obtener los nombres exactos antes de aplicarlos como filtro, y cópialos directamente de la respuesta.

¿Hay un límite de llamadas por minuto o por día?

No está documentado en la información disponible. Si tu integración hace un volumen alto de consultas (por ejemplo, polling frecuente), implementa un backoff razonable entre llamadas y monitorea respuestas YP-9999 (timeout) como indicador de sobrecarga. Ante dudas, consulta directamente con el equipo técnico de Yappy.

Puntos de cobro

¿Qué son “Punto Yappy” y “Directorio” como tipos de punto de cobro?

Son dos tipos de canales de cobro dentro de Yappy Comercial distintos de Botón de Pago y Yappy en Caja. Aparecen en las respuestas de /collection-method y sus transacciones aparecen en el historial. La documentación detallada sobre cómo se configuran en el portal no está disponible en esta documentación comunitaria. Para más información, consulta directamente con Yappy Comercial.

Yappy Comercial · Integraciones Yappy
Manual v1.0.0·Documentación comunitaria
¿Te fue útil esta página?