Webhook

Introduction

This webhook integration will let your platform know of any updates in your customer applications with Atrato. Notifications will be sent via REST.

Inside our Partner dashboard, an API section is present. Inside there we can configure a URL pointing to an endpoint in your platform which accepts POST requests.

Environments

Production
<<https://atratopago.com/v3/partner>>

Testing/Sandbox
<<https://sandbox.atratopago.com/v3/partner>>

Configuration

After accessing our partner dashboard, choose API in the lateral menu bar

Data to input:

Plataforma: Select 'Otro'
Url del webhook: Endpoint which points to a place in your platform to recieve the notifications. This must be a POST endpoint.
Usuario: Input a username of your preference, it will help with the checkout process.
This field is required to configure the checkout payment popup, it will be passed via attribute data-key
SecretKey: This special key will be sent in each request for your platform to know it is us who are sending the notification.
This field is required to configure the checkout payment popup, it will be passed via attribute data-key

Notification structure

This is the general structure of the notifications that will be sent via Webhook:

name	data type	description
orderNumber	`string`	Order number generated by your store.
estatus	`string`	Application status in which this order is currently in (CREADA, RECHAZADA, PRE_APROBADA, PRE_APROBADA_MONTO_MENOR, APROBADA)
ambiente	`string`	Environment in which the event took place(DESARROLLO, PRODUCCION)
monto	`number`	Product purchase amount
secretKey	`string`	Special key sent to let you know it is us who sends the request
timestamp	`integer (32-bit unix timestamp)`	Timestamp unix de for when this event is created
nombre	`string`	Customer name
segundoNombre	`string`	Customer second name (if any)
apellidoPaterno	`string`	Customer first last name
apellidoMaterno	`string`	Customer second last name
email	`string`	Customer email
telefono	`string`	Customer telephone number

Event statuses

CREADA

This event takes place when the user finishes filling their Application form and Atrato recieves the data. There is no approval result at this point.

{
  "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

The application was approved by our team but the customer still needs to upload some documents and sign their contract. If the customer drops off and doesn't complete this step the application will be canceled automatically after a certain period of time.

{
  "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

The customer signs their contract, therefore the application process is complete and the purchase is approved. This is where you can safely create an order inside your platform and send the user to the confirmation page.

{
  "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

The application was rejected or canceled. This can happen due to many reasons, some of which include: the customer wasn't approved by our team, the customer didn't finish their application on time, the application was canceled manually by the user.

{
  "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"
     }
 }