Webhook

Introducción

La integración con nuestro webhook permitirá que se notifique automaticamente la actividad de las ordenes desde nuestra plataforma, permitiendo al comercio mantener actualizada su información basada en la información proporcionada y el trabajo operativo pueda disminuir.

La sección de Webhook para implementaciones custom code es una sección donde se puede configurar un endpoint para poder recibir notificaciones de los eventos por los que pasa esta solicitud mediante una petición POST y que pueden servir como referencia a los clientes para generar comportamientos o procesos dentro de su plataforma.

Ambientes

Ambiente de producción
https://atratopago.com/v3/partner

Ambiente de pruebas (desarrollo de la integración y pruebas)
https://sandbox.atratopago.com/v3/partner

Configuración

Con las credenciales que te fueron proporcionadas para el dashboard de partners puedes ingresar a la plataforma en la cual te desplegará información de solicitudes y opciones de configuración. Nos enfocaremos para este caso en la opción de API del menú lateral izquierdo para esto sigue los pasos que se muestran en la siguiente imagen:

Datos a capturar:

Plataforma: Seleccionar "Otro" , esto nos permite identificar que la plataforma es custom.
Url del webhook: Endpoint generada para recibir las notificaciones en la plataforma cliente, debe de ser un método tipo POST.
Usuario: Ingresar un usuario, el que sea de su preferencia, este dato nos servirá para llevar a cabo otros procesos.
Este dato es requerido para configurar la modal de pago en el atributo data-key
SecretKey: Este dato será enviado dentro del contenido de la notificación para que sea verificado por el cliente y saber que el origen de esa petición es de parte de Atrato.
Este dato es requerido para configurar la modal de pago en el atributo data-key

Notificación

A continuación se detallan la información que se envía en el Request

nombre	tipo	descripción
orderNumber	`string`	Numero de orden generado por el comercio cliente.
estatus	`string`	Status de la solicitud asociada con esa orden (CREADA, RECHAZADA, PRE_APROBADA, PRE_APROBADA_MONTO_MENOR, APROBADA)
ambiente	`string`	Ambiente de la orden (DESARROLLO, PRODUCCION)
monto	`number`	Monto del financiamiento registrado a la orden.
secretKey	`string`	Se envia el string registrado para que puda comprobar que información viene de nuestra parte.
timestamp	`integer (32-bit unix timestamp)`	Timestamp unix de cuando el evento se creó
nombre	`string`	Nombre del cliente referente a la orden
segundoNombre	`string`	Segundo nombre del cliente referente a la orden
apellidoPaterno	`string`	Apellido paterno del cliente
apellidoMaterno	`string`	Apellido materno del cliente
email	`string`	Email del cliente
telefono	`string`	Telefono principal del cliente

Eventos

CREADA

La solicitud fue creada. Este webhook se envía cuando el cliente termina todos los pasos de la solicitud y Atrato la recibe.

{
  "orderNumber": "67",
  "status": "CREADA",
  "monto": 10000.99,
  "ambiente": "DESARROLLO",
  "secretKey": "AAE11E76BF44",
  "timestamp": 1614096441,
  "info":{
       "nombre": "John",
       "segundoNombre": "",
       "apellidoMaterno": "Doe",
       "apellidoPaterno": "Perez",
       "email": "[email protected]",
       "telefono": "3335245789"
     }
 }

PRE_APROBADA

La solicitud fue pre aprobada por el monto del producto. El cliente aún tiene que subir sus documentos y firmar la oferta para poder completar el proceso. En esta etapa si el cliente no le da seguimiento a la solicitud para terminar el proceso se puede cancelar la orden por inactividad de manera automática.

{
  "orderNumber": "67",
  "status": "PRE_APROBADA",
  "monto": 10000.99,
  "ambiente": "DESARROLLO",
  "secretKey": "AAE11E76BF44",
  "timestamp": 1614096441,
  "info":{
       "nombre": "John",
       "segundoNombre": "",
       "apellidoMaterno": "Doe",
       "apellidoPaterno": "Perez",
       "email": "[email protected]",
       "telefono": "3335245789"
     }
 }

APROBADA

La solicitud fue aprobada, se puede marcar la orden como completa. Este evento se envía cuando el cliente firma su contrato, asegurando que el crédito ya fue autorizado y firmado.

{
  "orderNumber": "67",
  "status": "APROBADA",
  "monto": 8000.99,
  "ambiente": "DESARROLLO",
  "secretKey": "AAE11E76BF44",
  "timestamp": 1614096441,
  "info":{
       "nombre": "John",
       "segundoNombre": "",
       "apellidoMaterno": "Doe",
       "apellidoPaterno": "Perez",
       "email": "[email protected]",
       "telefono": "3335245789"
     }
 }

RECHAZADA

La solicitud fue rechazada, la orden asociada a esta solicitud ya no es valida. Este evento se puede activar por varias razones: el cliente no completo la solicitud, porque no le dió seguimiento a los procesos de la solicitud una vez pre-aprobada o porque que nuestro equipo de análisis no autorizó el crédito.

{
  "orderNumber": "67",
  "status": "RECHAZADA",
  "monto": 10000.99,
  "ambiente": "DESARROLLO",
  "secretKey": "AAE11E76BF44",
  "timestamp": 1614096441,
  "info":{
       "nombre": "John",
       "segundoNombre": "",
       "apellidoMaterno": "Doe",
       "apellidoPaterno": "Perez",
       "email": "[email protected]",
       "telefono": "3335245789"
     }
 }