Skip to content

Flujo de canje

🚧Contrato en borrador. El flujo y los tiempos (como la vigencia de 15 minutos de la autorización) son propuestos.
  1. 1ValidarEl cliente se identifica. Consultas si tiene beneficios en tu comercio.POST /integrations/eligibility
  2. 2AplicarEliges el descuento, COME lo calcula y lo reserva con un código de autorización.POST /integrations/discounts/apply
  3. 3NotificarCobras la compra y confirmas el consumo para que quede registrado.POST /integrations/consumptions

Secuencia ​

text
Cliente          Tu punto de venta                      COME
   │ Identificación ──▶ │                                  │
   │                    │── 1. POST /eligibility ────────▶ │
   │                    │◀──── eligible + descuentos ───── │
   │ Elige beneficio ─▶ │                                  │
   │                    │── 2. POST /discounts/apply ────▶ │  (reserva el descuento)
   │                    │◀──── authorizationCode + monto ─ │
   │ Paga el total ───▶ │                                  │
   │                    │── 3. POST /consumptions ───────▶ │  (registra el consumo)
   │ ◀── Comprobante ── │◀──── code del consumo ───────── │

1. Validar ​

Cuando el cliente dice que es colaborador de una empresa afiliada, pide su tipo y número de identificación y llama a Validar elegibilidad.

  • Si eligible es false, cobra la compra normalmente. Por privacidad no se indica el motivo.
  • Si es true, muestra al cajero collaborator.displayName y companyName para confirmar con el cliente, y la lista de discounts para elegir uno.

2. Aplicar ​

Con el descuento elegido, llama a Aplicar descuento con el monto de la compra y tu reference (número de ticket u orden).

  • COME calcula discountAmount y finalAmount: cobra finalAmount al cliente.
  • Guarda authorizationCode junto a tu ticket.
  • La autorización vence en expiresAt. Si el cliente desiste, no hagas nada: al vencer se libera sola.

3. Notificar ​

Cuando la compra quede pagada, llama a Notificar consumo con el authorizationCode y la misma reference.

  • Si el total cambió después de autorizar (quitaron un artículo), envía el nuevo purchaseAmount: COME recalcula y nunca otorga más de lo autorizado.
  • El consumo queda visible para la empresa y para el colaborador en su historial de COME.

Reglas importantes ​

ReglaDetalle
Un descuento por compraCada reference admite una sola autorización activa.
Vigencia de la autorizaciónPropuesto: 15 minutos desde apply. Si vence, vuelve a aplicar.
Notificar solo lo cobradoNo notifiques compras anuladas o no pagadas.
Idempotenciaapply y consumptions exigen Idempotency-Key: reintentar no duplica. Ver Buenas prácticas.
MontosEn DOP con dos decimales; COME redondea el descuento a dos decimales.

COME · Beneficios que te conectan