WebHooks
Pre-Requisitos
Deberas tener ya implementada la integracion via API para configurar los WebHooks
Webhooks
Una vez que tengas la API implementada podrás recibir notificaciones de cada uno de los eventos. Para esto deberás ingresar a la seccion de Ajustes en IncreasePay y dentro de Integraciones configurar tu URL como asi tambien a que eventos vas a querer suscribirte.
Eventos
Vamos a notificarte siempre en formato JSON y podremos notificarte ante los siguientes eventos.
| Evento | Descripción |
|---|---|
payments | Te notificaremos ante cada cambio en los payments (aprobado, rechazado, en proceso, abierto, revertido) |
subscriptions | Te notificaremos ante cada cambio en la suscripcion (creada, pausada, cancelada, programada) |
Con esta información podrás realizar las actualizaciones necesarias en tu sistema, como por ejemplo dar por acreditado un pago o activar el acceso al sitio del cliente que ya abono.
Payments
La información enviada en los payments tendrá el siguiente formato
Response
{
"id": "c4ae478a-99a7-417f-8b96-123123124",
"event": {
"id": "8a85bd65-83c9-4107-986e-123421312",
"name": "sent_to_processor",
"created_at": "2020-06-01T13:00:00Z"
},
"amount": "61666.60",
"status": "processing",
"invoice": {
"id": "41244214-f52aa-47b6-a209-sdadsads",
"amount": "61666.60",
"status": "open",
"currency": "ARS",
"external_id": null,
"payment_date": null
},
"currency": "ARS",
"customer": {
"id": "2a123719d-c64e-4828-2332-4241241",
"email": "mailcliente@ejemplo.com",
"language": "ES",
"timezone": "Buenos Aires",
"last_name": "Perez",
"created_at": "2020-03-27T22:43:40Z",
"first_name": "Juan",
"external_id": null,
"billing_info": {
"id": "a4009da9-c3a4-4ec1-8696-223213123",
"city": "Ciudad",
"phone": "Telefono",
"state": "Provincia",
"tax_id": "37204762",
"country": "ARG",
"zip_code": "1416",
"address_line_1": "CALLE 123",
"address_line_2": "Piso 4"
}
},
"subscriptions": [
{
"id": "d4cb23132-327b-43ca-aeb8-1c56dbfd8f4a",
"plan": {
"id": "223213-9b5d-4ee1-acad-0fb8c93cfcfc",
"name": "Gimnasio Mensual"
},
"amount": "15000.0",
"status": "active",
"product": {
"id": "231321-f6bf-4264-a332-3213123",
"name": "Gimnasio"
},
"currency": "ARS",
"customer": {
"id": "sdadsad-c64e-4828-9e36-65cbf0609eb8",
"email": "mailcliente@ejemplo.com",
"last_name": "Juan",
"first_name": "Perez"
},
"quantity": 11260,
"cancel_at": null,
"paused_at": "2020-05-27T15:21:19Z",
"created_at": "2020-05-27T15:21:19Z",
"activate_at": "2020-06-01",
"canceled_at": null,
"checkout_link": "/checkout/2dsads-dsadsad-sdasdas-12312?subscription_id=d23132a92-327b-43ca-aeb8-1c523218f4a",
"payment_method": {
"id": "21321312-a01e-47de-a16d-13408d3b7b2e",
"data": {
"type": "cbu",
"number": "02345678**0439",
"country": "ARG"
},
"created_at": "2020-05-27T15:21:19Z",
"external_id": null
},
"trial_period_end": "2020-06-01T03:00:00Z",
"next_billing_date": "2020-07-01T03:00:00Z"
}
]
}
Los diferentes status que podras recibir para el Hook de Payments son
| Status | Descripcion |
|---|---|
| Open | El pago esta abierto |
| Processing | El pago se esta procesando |
| Approved | El pago esta aprobado |
| Failed | El pago fallo |
| Reversed | El pago fue revertido |
Subscriptions
La información enviada en las subscriptions tendrá el siguiente formato
Response
{
"id": "d4cb23132-327b-43ca-aeb8-1c56dbfd8f4a",
"event": {
"id": "8a85bd65-83c9-4107-986e-123421312",
"name": "create",
"created_at": "2020-06-01T13:00:00Z"
},
"subscriptions": [
{
"id": "d4cb23132-327b-43ca-aeb8-1c56dbfd8f4a",
"plan": {
"id": "223213-9b5d-4ee1-acad-0fb8c93cfcfc",
"name": "Gimnasio Mensual"
},
"amount": "15000.0",
"status": "active",
"product": {
"id": "231321-f6bf-4264-a332-3213123",
"name": "Gimnasio"
},
"currency": "ARS",
"customer": {
"id": "sdadsad-c64e-4828-9e36-65cbf0609eb8",
"email": "mailcliente@ejemplo.com",
"last_name": "Juan",
"first_name": "Perez"
},
"quantity": 11260,
"cancel_at": null,
"paused_at": "2020-05-27T15:21:19Z",
"created_at": "2020-05-27T15:21:19Z",
"activate_at": "2020-06-01",
"canceled_at": null,
"checkout_link": "/checkout/2dsads-dsadsad-sdasdas-12312?subscription_id=d23132a92-327b-43ca-aeb8-1c523218f4a",
"payment_method": {
"id": "21321312-a01e-47de-a16d-13408d3b7b2e",
"data": {
"type": "cbu",
"number": "02345678**0439",
"country": "ARG"
},
"created_at": "2020-05-27T15:21:19Z",
"external_id": null
},
"trial_period_end": "2020-06-01T03:00:00Z",
"next_billing_date": "2020-07-01T03:00:00Z"
}
]
}
Los diferentes status que podras recibir para el Hook de Subscriptions son
| Status | Descripcion |
|---|---|
| active | La suscripcion esta activada |
| canceled | La suscripcion esta cancelada |
| scheduled | La suscripcion esta programada para que inicie un dia especifico |
| paused | La suscripcion esta pausada |
| pending | La suscripcion esta pendiente |
| finished | La suscripcion esta finalizada |
| pending_finished | La suscripcion esta pendiente de finalización |
| pending_canceled | La suscripcion esta pendiente de cancelación |
| pending_approval | La suscripcion esta pendiente de aprobación |
| request_rejected | La suscripcion fue rechazada por el merchant |
| trial | La suscripcion esta en período de prueba |
| grace_period | La suscripcion esta en período de gracia |
Reintentos
Pay enviará las notificaciones con el siguiente esquema de reintentos. Debes retornar un HTTP STATUS 200 (OK) o 201 (CREATED). Si no lo haces asumiremos que no lo recibiste correctamente y volveremos a notificarte
| Evento | Tiempo después del primer envio |
|---|---|
| Envio | - |
| Primer Reintento | 60 minutos |
| Segundo Reintento | 240 minutos (4 hs) |
| Tercer Reintento | 1680 minutos (1 día y 4hs) |
| Cuarto Reintento | 4560 minutos (3 día y 4hs) |