Tipos de notificación

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
  }
}
PropiedadDescripciónValor default
event_typeTipo de evento"status_updated"
event_data.atrato_idNúmero de orden interna de Atrato
event_data.atrato_application_idNúmero de solicitud de Atrato
event_data.statusDescripción del estatus
event_data.status_idIdentificador numérico del status
event_data.status_codeCódigo del estatus
event_data.order_idNúmero de orden interna del Partner
event_data.order_numberNúmero de orden interna del Partner
event_data.customer.nameNombre del cliente
event_data.customer.emailEmail del cliente
event_data.customer.phoneNúmero telefónico del cliente
event_data.customer.adress.streetCalle del cliente
event_data.customer.adress.ext_numberNúmero exterior del cliente
event_data.customer.adress.int_numberNúmero interior del cliente
event_data.customer.adress.districtColonia / Municipio del cliente
event_data.customer.adress.postal_codeCódigo postal del cliente
event_data.customer.adress.cityCiudad del cliente
timestamptimestamp
observationsObservaciones

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  
    }  
  }  
}
PropiedadDescripciónValor default
event_typeTipo de evento"disbursement_updated"
event_data.statusDescripción del estatus
event_data.status_idIdentificador numérico del status
event_data.status_codeCódigo del estatus
event_data.data.amountMonto de la transferencia
event_data.data.transactionIdIdentificador de la transacción de desembolso
event_data.data.trackingKeyClave 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"
    }
  }
}