Definición de tipos y estructuras de notificación
Notificación de cambio de estado de la solicitud
Estructura de datos que se enviará a través del webhook
{
"event_type": "status_updated",
"event_data": {
"atrato_id": number,
"atrato_application_id": number,
"status": string,
"status_id": number,
"status_code": string,
"order_id": string,
"order_number": string,
"customer": {
"name": string,
"email": string,
"phone": string,
"address": {
"street": string,
"ext_number": string,
"int_number": string,
"district": string,
"postal_code": string,
"city": string
}
},
"timestamp": number,
"observations": string
}
}
Propiedad | Descripción | Valor default |
---|---|---|
event_type | Tipo de evento | "status_updated" |
event_data.atrato_id | Número de orden interna de Atrato | |
event_data.atrato_application_id | Número de solicitud de Atrato | |
event_data.status | Descripción del estatus | |
event_data.status_id | Identificador numérico del status | |
event_data.status_code | Código del estatus | |
event_data.order_id | Número de orden interna del Partner | |
event_data.order_number | Número de orden interna del Partner | |
event_data.customer.name | Nombre del cliente | |
event_data.customer.email | Email del cliente | |
event_data.customer.phone | Número telefónico del cliente | |
event_data.customer.adress.street | Calle del cliente | |
event_data.customer.adress.ext_number | Número exterior del cliente | |
event_data.customer.adress.int_number | Número interior del cliente | |
event_data.customer.adress.district | Colonia / Municipio del cliente | |
event_data.customer.adress.postal_code | Código postal del cliente | |
event_data.customer.adress.city | Ciudad del cliente | |
timestamp | timestamp | |
observations | Observaciones |
Notificación de desembolso
Estructura de datos que se enviará a través del webhook
{
"event_type": "disbursement_updated",
"event_data": {
"status": string,
"status_id": number,
"status_code": string,
"data": {
"amount": number,
"transactionId": number,
"trackingKey": string
}
}
}
Propiedad | Descripción | Valor default |
---|---|---|
event_type | Tipo de evento | "disbursement_updated" |
event_data.status | Descripción del estatus | |
event_data.status_id | Identificador numérico del status | |
event_data.status_code | Código del estatus | |
event_data.data.amount | Monto de la transferencia | |
event_data.data.transactionId | Identificador de la transacción de desembolso | |
event_data.data.trackingKey | Clave de rastreo de la transacción |
Ejemplo de eventos de notificación
{
"event_type": "status_updated",
"event_data": {
"atrato_id": 2922,
"atrato_application_id": 8144,
"status": "creditoAutorizado",
"status_id": 29,
"status_code": "CREDITOAUTORIZADO",
"order_id": "AAAA-BBBBB-CCCC-DDDD-EEEEE70703",
"order_number": "AAAA-BBBBB-CCCC-DDDD-EEEEE70703",
"customer": {
"name": "RAMON LOPEZ PEREZ",
"email": "[email protected]",
"phone": "+523331230000",
"address": {
"street": "Calle Juarez",
"ext_number": "12",
"int_number": null,
"district": "Roma",
"postal_code": "28000",
"city": "Guadalajara"
}
},
"timestamp": 1729018079407,
"observations": ""
}
}
{
"event_type": "disbursement_updated",
"event_data": {
"status": "desembolsado",
"status_id": 19,
"status_code": "DESEMBOLSADO",
"data": {
"amount": 1000,
"transactionId": 464,
"trackingKey": "SUC123TX321"
}
}
}