Ir al contenido principal

¿Cómo cobrar a un método de pago o reintentar pago de un cobro fallido vía API?

Descubre como cobrar un método de pago utilizando la API de Treli.

Escrito por Olainer

Esta guía describe cómo crear un cobro contra el método de pago de un cliente, cómo reintentar un cobro fallido apuntando a un método de pago diferente, y cómo escuchar el evento que confirma que un cobro fue pagado exitosamente.


Resumen del flujo

Paso #1: Crear cobro

Utiliza el endpoint 'Crear cobro' para generar un nuevo cobro asociado a un cliente. Tienes dos alternativas según el método de pago que quieras usar:

  1. Método predeterminado: No envíes el parámetro payment_method. Treli cobrará automáticamente al método de pago predeterminado del cliente.

  2. Método especifico: Envía el payment_method con el ID del método de pago al que deseas realizar el cobro.

Si el cliente aún no tiene un método de pago almacenado, primero debes guiarlo por el flujo de almacenamiento de método de pago utilizando una sesión de checkout en modo setup.

Paso #2: Reintentar un cobro fallido

Si un cobro falla, puedes reintentarlo utilizando el endpoint 'Pagar un cobro'. Este endpoint recibe el ID del cobro fallido y el método de pago al cual deseas reintentar el cargo.

  1. Identifica el collection_id del cobro fallido que deseas reintentar.

  2. Utiliza al endpoint 'Pagar un cobro' enviando el ID del cobro y el payment_method al que se debe reintentar el cobro. Esto es especialmente útil cuando el cliente tiene más de un método de pago almacenado y quieres intentar con uno diferente al que falló.

Parámetros clave

Opcional: Escuchar evento mediante webhook

Cuando el cobro sea exitoso, puedes escuchar el evento collection.paid en la URL que definas.

  • Crea en Treli un Webhook y configura un punto de conexión para recibir el el evento collection.paid.

  • Al recibir el evento, utiliza el collection_id del payload para identificar qué cobro fue pagado y actualizar el estado en tu sistema.

¿Cómo verificar que un evento fue enviado por Treli?

Protege tu punto de conexión, debes proteger tu integración verificando que todas las solicitudes de webhook provengan realmente de Treli. Para ello, tu controlador debe validar la firma incluida en cada evento.

¿Ha quedado contestada tu pregunta?