API Technical Docs

Mantente al día con las innovaciones tecnológicas que están transformando el mercado.

Acciones de cobro, “Ya pagó” y constancias

Estado documental: Propuesto. Este documento define la creación manual y por API, la acción “Ya pagó”, el uso de OCR y la cancelación de transacciones.

Acciones disponibles

Según permisos y canal, el usuario puede:

Iniciar turno
Crear cobro
Recibir cobro desde API
Ver instrucciones
Compartir pago
Consultar estado
Ya pagó
Enviar captura o fotografía
Reenviar instrucciones
Cancelar transacción
Ver pendientes del turno
Cerrar turno
Solicitar ayuda

Opción 1: crear el cobro desde el chat

El vendedor puede iniciar una cobranza manual.

Vendedor:
“Cobrar 85.50”

YUPY:
“Indica la referencia o concepto.”

Vendedor:
“Servicio de ensunchado”

YUPY:
“Solicitud creada.
Monto: S/ 85.50
Código: YP-7H2K9”

Este flujo debe mantenerse disponible incluso cuando la empresa tenga un sistema de ventas integrado.

Opción 2: recibir el cobro desde el sistema de ventas

El sistema comercial crea la operación mediante API e indica el turno y el dispositivo.

Sistema de ventas
    → crea la transacción en YUPY
    → indica shift_id
    → indica device_id o terminal_id

YUPY
    → identifica el turno activo
    → envía la transacción al chat del vendedor
    → muestra QR o transferencia
    → presenta instrucciones

El vendedor recibe la operación sin tener que volver a digitar el monto y la referencia.

Datos preferidos del comprador

La API debería enviar nombre y apellido cuando estén disponibles.

Otros datos personales son opcionales y dependen del caso de uso.

Compartir o mostrar el pago

YUPY puede:

  • mostrar el QR dentro del chat;
  • enviar los datos de transferencia;
  • entregar una URL;
  • mostrar la experiencia en una pantalla asociada;
  • enviar instrucciones al comprador mediante un canal autorizado.

Acción presencial: “Ya pagó”

En una atención presencial, el vendedor utiliza la acción “Ya pagó” cuando el comprador indica que completó el pago.

“Ya pagó”
= payment_reported

payment_reported
≠ payment_reconciled

La acción registra una señal y mantiene la verificación. No confirma el pago.

Nota para pagos remotos

Cuando el QR se envía directamente al comprador, la experiencia del comprador puede utilizar la acción “Ya pagué”.

Ambas acciones producen una señal equivalente, pero el texto se adapta a quien interactúa:

Vendedor presencial:
“Ya pagó”

Comprador remoto:
“Ya pagué”

La captura o fotografía reemplaza el botón

El vendedor puede enviar una captura de pantalla o tomar una fotografía de la constancia del comprador.

Presionar “Ya pagó”
        o
Enviar captura o fotografía
        ↓
YUPY registra payment_reported
        ↓
continúa la verificación

La imagen aporta además información que YUPY puede leer mediante OCR.

Medios cubiertos por la evidencia

La función de captura y OCR está disponible para:

  • Yape;
  • Plin;
  • transferencias bancarias;
  • depósitos;
  • otras billeteras habilitadas en el futuro.

Procesamiento OCR

YUPY puede extraer de la imagen, cuando sea visible:

  • monto;
  • fecha;
  • hora;
  • medio;
  • referencia;
  • receptor;
  • otros datos útiles.

La evidencia queda vinculada con la transacción, el turno, el dispositivo y el usuario que la envió.

OCR ayuda a ubicar y correlacionar; la confirmación final continúa dependiendo de la evidencia financiera.

Uso normal y uso como evidencia posterior

La imagen puede enviarse:

  • inmediatamente después del pago;
  • en reemplazo de “Ya pagó”;
  • después, cuando el comprador indique que el pago no fue aceptado;
  • durante una revisión o reclamo.

Mensajes de espera

Después de “Ya pagó” o de recibir una imagen, YUPY puede responder:

Estamos esperando la confirmación del pago.
La verificación continúa.

Cuando recibe la evidencia:

Recibimos la constancia.
Estamos verificando la operación.

Control de repeticiones

La acción debe ser idempotente y limitada.

Cada intento no debe generar una consulta externa independiente.

Primer uso válido
→ registra payment_reported

Usos posteriores
→ conservan auditoría
→ no crean otra orden
→ no crean otro pago
→ no disparan una llamada financiera por cada intento

Comportamiento en WhatsApp

En WhatsApp puede no ser posible retirar un botón ya enviado. YUPY controla la respuesta.

Acción ya registrada

Ya informaste que el cliente pagó.
Espera mientras continúa la verificación.

Acción no disponible

Esta función no está activa en este momento
para esta transacción.

Verificación en curso

Estamos verificando el pago.
No necesitas volver a informar la operación.

Consultar estado

El usuario puede consultar mediante el código, la referencia, la última operación o la lista de pendientes de su turno.

La respuesta debe distinguir espera, confirmación, diferencia, pago tardío, revisión, cancelación y otros estados.

Reenviar instrucciones

Reenviar el QR o los datos bancarios:

  • no crea una nueva transacción;
  • no cambia el monto;
  • no cambia el perfil;
  • no modifica el código;
  • no extiende automáticamente la vigencia.

Cancelación de transacciones

Toda transacción puede cancelarse mediante una acción autorizada, de acuerdo con su estado.

Cancelar:

  • cambia el estado operativo;
  • impide seguir utilizándola como operación activa;
  • conserva la auditoría;
  • no elimina un movimiento recibido;
  • no equivale a una devolución;
  • no impide detectar un pago posterior.

Si aparece un movimiento después de la cancelación, YUPY debe generar un caso pendiente.

Privacidad

El chat no debe exponer credenciales, tokens internos, datos de otras operaciones ni información fuera de los permisos del usuario.

Criterios de aceptación

  1. Existe creación manual y creación por API.
  2. La creación manual permanece siempre disponible.
  3. La API entrega al turno y dispositivo correctos.
  4. La acción presencial se denomina “Ya pagó”.
  5. “Ya pagué” se limita al caso remoto del comprador.
  6. Enviar imagen produce la señal equivalente a “Ya pagó”.
  7. OCR extrae datos y vincula la evidencia.
  8. Los intentos repetidos no generan una llamada externa por intento.
  9. WhatsApp responde de forma controlada aunque el botón siga visible.
  10. Toda transacción puede cancelarse con auditoría.