Webhooks
En el sistema T1pagos algunos procesos son ejecutados de manera automática, como es el caso de los cobros de las suscripciones, para poder mantener sincronizados los sistemas, podrá configurarse un endpoint para recibir notificaciones de algunos eventos como nuevos cargos, renovación de suscripciones y otros.
El registro se realiza desde el sistema Admin, podrá incluirse más de un endpoint y canalizar las notificaciones a cada nueva ruta.
Eventos disponibles:
| Método | Tipo de Evento | Id | Descripción |
|---|---|---|---|
| Cargo | Exitoso | cargo.exitoso | Indicará cuando fue realizado un cargo exitoso |
| Cargo | Fallido | cargo.fallido | Indicará cuando fue realizado un cargo fallido o rechazado |
| Cargo | Cancelado | cargo.cancelado | Indicará cuando un cargo haya sido cancelado |
| Cargo | Reembolsado | cargo.reembolsado | Indicará cuando un cargo haya sido reembolsado |
| Suscripción | Creada | suscripcion.creada | Indicará la creación de una nueva suscripción, el evento no notificará el cobro de una suscripción |
| Suscripción | Actualizada | suscripcion.actualizada | Se ejecuta cuando se realiza una actualización a una suscripción. |
| Suscripción | Cancelada | suscripcion.cancelada | Se ejecuta cuando se ejecuta el comando “cancelar” de una suscripción. |
| Suscripción | Pago.exitoso | suscripcion.pago.exitoso | Se ejecuta cuando se realiza el cobro de una suscripción de manera exitosa |
| Suscripción | Pago.fallido | suscripcion.pago.fallido | Se ejecuta cuando se realiza el cobro de una suscripción de manera fallida |
Seguridad en recepción de eventos
En la configuración de recepción de eventos podrá habilitarse un usuario y contraseña que deberá de validar el sistema al recibir cada evento. El esquema, conocido como autenticación básica, permite añadir una capa de seguridad adicional.
Consulta de eventos
Si el sistema que recibe las notificaciones presenta algún contratiempo, o se busca confirmar las operaciones realizadas, podrá hacerse uso del método GET /notificacion para consultar un listado de eventos que han sido creados y enviados.
Request:
curl --request GET \
--url https://api.sandbox.claropagos.com//v1/notificacion \
--header 'authorization: Bearer BEARER_TOKEN'
Response:
{
"status": "success",
"http_code": 200,
"datetime": "2018-09-05T00:27:35-05:00",
"timestamp": 1536125255,
"data": {
"eventos": {
"data": [
{
"id": "string",
"creacion": "Date-time",
"tipo": "evento",
"tipo_evento": "cargo.exitoso",
"prueba": true,
"estatus": "string",
"fecha_entrega": "Date-time",
"codigo_http": 200,
"mensaje_http": "string",
"total_intentos": 1,
"data": {
"cargo": {
"id": "string",
"monto": 0,
"autorizacion_id": "string",
"tipo": "cargo",
"fecha": "2018-09-19T10:47:37.895Z",
"orden_id": "string",
"cliente_id": "string",
"estatus": "completada",
"codigo": "string",
"descripcion": "string",
"tarjeta": {
"token": "string",
"pan": "string",
"terminacion": 0,
"nombre": "string",
"expiracion_mes": 0,
"expiracion_anio": 0,
"direccion": {
"creacion": "2018-09-19T10:47:37.895Z",
"linea1": "string",
"linea2": "string",
"linea3": "string",
"cp": "string",
"telefono": {
"tipo": "no_definido",
"codigo_pais": "string",
"codigo_area": "string",
"prefijo": "string",
"numero": 0,
"extension": 0
},
"municipio": "string",
"ciudad": "string",
"estado": "string",
"pais": "string",
"referencia_1": "string",
"referencia_2": "string",
"longitud": 0,
"latitud": 0
},
"iin": 0,
"marca": "visa",
"cliente_id": "string",
"default": true,
"cargo_unico": true
},
"cliente": {
"id": "176f76a82670428898001dd5f031a57e",
"creacion": "2018-09-19T10:47:37.895Z",
"id_externo": "string",
"creacion_externa": "2018-09-19T10:47:37.895Z",
"nombre": "string",
"apellido_paterno": "string",
"apellido_materno": "string",
"sexo": "masculino",
"email": "usuario@T1pagos.com",
"estado": "activo",
"telefono": {
"tipo": "no_definido",
"codigo_pais": "string",
"codigo_area": "string",
"prefijo": "string",
"numero": 0,
"extension": 0
},
"nacimiento": "2018-09-19T10:47:37.895Z",
"direccion": {
"creacion": "2018-09-19T10:47:37.895Z",
"linea1": "string",
"linea2": "string",
"linea3": "string",
"cp": "string",
"telefono": {
"tipo": "no_definido",
"codigo_pais": "string",
"codigo_area": "string",
"prefijo": "string",
"numero": 0,
"extension": 0
},
"municipio": "string",
"ciudad": "string",
"estado": "string",
"pais": "string",
"referencia_1": "string",
"referencia_2": "string",
"longitud": 0,
"latitud": 0
}
}
}
}
}
],
"registros_por_pagina": 5,
"pagina_actual": 1,
"desde": 1,
"hasta": 1,
"total": 1,
"total_pagina": 1,
"ultima_pagina": 1
}
}
}