Webhook Example

This is the documentation section intended to illustrate the webhook sent to the URL registered by the retailer, varying according to the type of notification.

Payment Notification

The Payment Notification is sent using the parameters presented below:

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

The event parameter is for the type of event associated with the notification. See below the list of events associated with the notification:

Event	Description
PAYMENT.CREATED	First event of a payment indicates that the payment was created.
PAYMENT.PRE_AUTHORIZED	This status indicates the reservation of the payment amount on the customer's card.
PAYMENT.AUTHORIZED	It means the payment has been captured and debited from the customer's card.
PAYMENT_NOT_AUTHORIZED	It means that the created payment has been denied and cannot be approved.
PAYMENT.CANCELLED	This means the payment has been cancelled.
PAYMENT.REFUNDED	This means that the payment has been refunded.
PAYMENT.REFUNDED_REJECTED	This means that your payment refund request has been denied.
PAYMENT.REFUNDED_WAITING	This means that your payment refund request is still being processed.
PAYMENT.REVERSED	It means that the payment was reversed due to a chargeback.

Pay attention to each event and map it correctly according to the description of its meaning.

Establishment notification

Notification of changes in the establishment's status is sent according to the following parameters:

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

The event parameter is for the type of event associated with the notification. See below the list of events associated with the establishment's notification:

Event	Description
COMPANY.ACTIVE	It means that the Establishment has been activated.
COMPANY.DELETED	It means that the Establishment has been deleted.
COMPANY.INACTIVE	It means that the Establishment has been inactivated.
COMPANY.WAITING	It means the establishment is under analysis.

Pay attention to each event and map it correctly according to the description of its meaning.