Ejemplo de Webhook

Esta es la sección de la documentación destinada a ejemplificar el webhook enviado a la URL registrada por el comerciante, variando según el tipo de notificación.

Notificación de Pago

La Notificación de Pago se envía mediante los parámetros presentados a continuación:

Exemplo de Requisição

{
  "event": "PAYMENT.REFUNDED",
  "data": {
    "id": "020000026803231938500000065382450000000000",
    "paymentLinkId": "b566309d-a420-4ff9-be44-a32a374c07f1",
    "status": 7,
    "returnCode": "FF",
    "returnMessage": "Sucesso",
    "authorizationCode": "006734",
    "orderNumber": "623b774a48472",
    "nsu": "623b775052d0e",
    "transactionType": "credit",
    "installments": "12",
    "brand": "mastercard",
    "amount": 452200,
    "fees": 15539,
    "liquid": 0,
    "refunds": 436661,
    "acquirer": "adiq",
    "createdAt": "2022-03-23 16:38:56",
    "updatedAt": "2022-06-20 10:45:47",
    "account": {
      "id": "8284b41c0c234b0f889b087a451de9420f2664fc",
      "name": "Sueli e Breno Contábil Ltda"
    },
    "events": [
      {
        "createdAt": "2022-06-20 10:45:47",
        "type": "PAYMENT.REFUNDED"
      },
      {
        "createdAt": "2022-03-23 16:38:56",
        "type": "PAYMENT.AUTHORIZED"
      },
      {
        "createdAt": "2022-03-23 16:38:56",
        "type": "PAYMENT.CREATED"
      }
    ]
  }
}

Siendo el parámetro event destinado al tipo de evento asociado a la notificación. A continuación, puedes ver la lista de eventos asociados a la notificación:

Evento	Descripción
PAYMENT.CREATED	Primer evento de un pago, indica que el pago ha sido creado.
PAYMENT.PRE_AUTHORIZED	Ese estado indica la reserva del valor del pago en la tarjeta del cliente.
PAYMENT.AUTHORIZED	Significa que el pago fue capturado y debitado de la tarjeta del cliente.
PAYMENT_NOT_AUTHORIZED	Indica que el pago creado ha sido denegado y no puede ser aprobado.
PAYMENT.CANCELLED	Significa que el pago fue cancelado.
PAYMENT.REFUNDED	Significa que el pago fue reembolsado.
PAYMENT.REFUNDED_REJECTED	Significa que la solicitud de reembolso del pago fue negada.
PAYMENT.REFUNDED_WAITING	Significa que la solicitud de reembolso de pago aún está siendo procesada.
PAYMENT.REVERSED	Significa que el pago fue revertido debido a un contracargo (chargeback).

Esté atento a cada evento y mapee correctamente según la descripción de su significado.

Notificación de Establecimiento

A notificación de cambio de estado del establecimiento se envía según los parámetros siguientes:

Exemplo de Requisição

{
  "event": "COMPANY.ACTIVE",
  "data": {
    "companyId": 1,
    "mccId": 208,
    "companyName": "Bruno E Ana Consultoria Financeira Me",
    "socialReason": "Bruno E Ana Consultoria Financeira Me",
    "type": "2",
    "documentNumber": "80017668000180",
    "softDescriptor": null,
    "siteUrl": null,
    "accessToken": "7612adf805f3408786d9181474977fd607149331",
    "active": "A"
  }
}

Siendo el parámetro event destinado al tipo de evento asociado a la notificación. A continuación, puedes ver la lista de eventos asociados a la notificación de establecimiento:

Evento	Descripción
COMPANY.ACTIVE	Significa que el establecimiento fue activado.
COMPANY.DELETED	Significa que el Establecimiento fue eliminado.
COMPANY.INACTIVE	Significa que el Establecimiento fue desactivado.
COMPANY.WAITING	Significa que el Establecimiento está en análisis.

Permaneça atento a cada evento y mapee correctamente según la descripción de su significado.