Skip to main content

Objeto

El objeto evento es la representación de una acción que ha ocurrido en la plataforma de Kausanna. Cada vez que ocurre una acción, se genera un evento que contiene información sobre lo que ha ocurrido y se te envía a tu servidor a través de una conexión segura. Tiene la siguiente estructura:
{
  "id": "evt_2o3k4j5l6m",
  "type": "chargeback.created",
  "timestamp": "2020-01-01T00:00:00Z",
  "test": true,
  "data": {
    "param": "value"
  }
}
id
string
El identificador único del evento.
type
string
El tipo de evento. Indica la acción que ha ocurrido. Su formato es recurso.accion.
timestamp
string
La fecha y hora en la que ocurrió el evento.
test
boolean
Indica si el evento fue generado en un ambiente de pruebas.
data
object
Un objeto con la información específica del evento. Consulta la documentación de cada evento para conocer los campos que contiene.

Ejemplo de request HTTP

POST /webhooks HTTP/1.1
Host: example.com
Content-Type: application/json
Content-Length: 123
x-hmac-hash: abcakdaodsdslajsdi12381293ijndaksdjnqd

{
  "id": "evt_2o3k4j5l6m",
  "type": "chargeback.created",
  "timestamp": "2020-01-01T00:00:00Z",
  "test": true,
  "data": {
    "param": "value"
  }
}

Webhooks

Evento de pruebas

Cuando ejecutas la acción de probar los webhooks de tu cuenta en Kausanna, te llegará un evento como el siguiente:
{
  "test": true,
  "event": "chargeback.created",
  "data": {
    "message": "Test webhook"
  }
}

Contracargos

Evento de nuevo contracargo

El evento de tipo chargeback.created contiene la siguiente información:
{
  "id": "200002043925",
  "data": {
    "acquirerId": "002222",
    "merchantId": "002403845259",
    "chargebackIds": ["300003030396", "300003030396"],
    "amount": "938.61 MXN",
    "primaryAccountNum": "5123********6694",
    "transactionId": "120602363",
    "isFraud": false
  },
  "type": "chargeback.created",
  "origin": "mastercard"
}
id
string
El identificador único del evento.
type
string
El tipo de evento. Indica la acción que ha ocurrido. Su formato es recurso.accion.
timestamp
string
La fecha y hora en la que ocurrió el evento.
test
boolean
Indica si el evento fue generado en un ambiente de pruebas.
data
object
Un objeto con la información específica del evento. Consulta la documentación de cada evento para conocer los campos que contiene.
data.acquirerId
string
El identificador del adquirente.
data.merchantId
string
El identificador del comercio.
data.chargebackIds
array
Un arreglo con los identificadores de los contracargos.
data.amount
string
El monto del contracargo.
data.primaryAccountNum
string
El número de tarjeta enmascarado.
data.transactionId
string
El identificador de la transacción.
data.isFraud
boolean
Indica si el contracargo es por fraude.
Por seguridad, el campo primaryAccountNum es enmascarado.

Evento de contracargo actualizado

El evento de tipo chargeback.updated contiene la siguiente información:
{
  "id": "200002043925",
  "data": {
    "acquirerId": "002222",
    "merchantId": "002403845259",
    "chargebackIds": ["300003030396", "300003030396"],
    "amount": "938.61 MXN",
    "primaryAccountNum": "5123********6694",
    "transactionId": "120602363",
    "isFraud": false
  },
  "type": "chargeback.updated",
  "origin": "mastercard"
}
id
string
El identificador único del evento.
type
string
El tipo de evento. Indica la acción que ha ocurrido. Su formato es recurso.accion.
timestamp
string
La fecha y hora en la que ocurrió el evento.
test
boolean
Indica si el evento fue generado en un ambiente de pruebas.
data
object
Un objeto con la información específica del evento. Consulta la documentación de cada evento para conocer los campos que contiene.
data.acquirerId
string
El identificador del adquirente.
data.merchantId
string
El identificador del comercio.
data.chargebackIds
array
Un arreglo con los identificadores de los contracargos.
data.amount
string
El monto del contracargo.
data.primaryAccountNum
string
El número de tarjeta enmascarado.
data.transactionId
string
El identificador de la transacción.
data.isFraud
boolean
Indica si el contracargo es por fraude.

Evento de contracargo resuelto

El evento de tipo chargeback.resolved contiene la siguiente información:
{
  "id": "200002043925",
  "data": {
    "acquirerId": "002222",
    "merchantId": "002403845259",
    "chargebackIds": ["300003030396", "300003030396"],
    "amount": "938.61 MXN",
    "primaryAccountNum": "5123********6694",
    "transactionId": "120602363",
    "isFraud": false
  },
  "type": "chargeback.resolved",
  "origin": "mastercard"
}
id
string
El identificador único del evento.
type
string
El tipo de evento. Indica la acción que ha ocurrido. Su formato es recurso.accion.
timestamp
string
La fecha y hora en la que ocurrió el evento.
test
boolean
Indica si el evento fue generado en un ambiente de pruebas.
data
object
Un objeto con la información específica del evento. Consulta la documentación de cada evento para conocer los campos que contiene.
data.acquirerId
string
El identificador del adquirente.
data.merchantId
string
El identificador del comercio.
data.chargebackIds
array
Un arreglo con los identificadores de los contracargos.
data.amount
string
El monto del contracargo.
data.primaryAccountNum
string
El número de tarjeta enmascarado.
data.transactionId
string
El identificador de la transacción.
data.isFraud
boolean
Indica si el contracargo es por fraude.

Documentación

Documento rechazado

El evento de tipo document.rejected contiene la siguiente información:
{
  "event": "documentation.rejected",
  "message": "The document uploaded didn't pass documentation checks",
  "disputeId": "1706558731586",
  "object": ["1706558731586", "01HQ0V0P7A122CR72T3M71H828.png"]
}
Cuando nuestra plataforma rechaza un documento, te enviamos un evento con la información necesaria para que puedas tomar las acciones necesarias.
event
string
El tipo de evento. Indica la acción que ha ocurrido.
message
string
El mensaje que describe el motivo del rechazo.
disputeId
string
El identificador único del contracargo.
object
array
Un arreglo con los identificadores del contracargo y el documento rechazado.

Origenes disponibles

OrigenDescripción
mastercardEventos relacionados con tarjetas Mastercard.
visaEventos relacionados con tarjetas Visa.
amexEventos relacionados con tarjetas American Express.
discoverEventos relacionados con tarjetas Discover.
dinersEventos relacionados con tarjetas Diners Club.
nxEventos relacionados con tarjetas NaranjaX.