Configure Webhook

Callbacks

The callback should be triggered whenever one or more Pix transactions associated with a txid are received by the payee, as long as the key associated with the Pix transaction is linked to a registered webhook.

The callback should also be triggered whenever a refund associated with a Pix transaction linked to a txid reaches a final status: DEVOLVIDO or NAO_REALIZADO.

The specific SLA to be defined for triggering callbacks is at the discretion of each receiving PSP. However, it is recommended that the SLA be set within a reasonable timeframe, considering that the expectation is for the callback to serve as an "online" notification of payment occurrence.

In the context of each receiving PSP’s specific SLA strategy, it is possible to group Pix transactions associated with the same key to reduce multiple trigger events. This service is protected by an mTLS authentication layer. For more details, refer to the Pix Initiation Standards Manual.

Callback payload samples

{
  "txid": "971122d8f37211eaadc10242ac120002",
  "valor": "110.00",
  "horario": "2020-09-09T20:15:00.358Z",
  "pagador": {
  "cpf": "0123456789",
  "nome": "Nome Pagador"
  },
  "endToEndId": "E12345678202009091221abcdef12345"
}

Callback payload devolution samples

{
  "pix": {
    "txid": "c3e0e7a4e7f1469a9f782d3d4999343c",
    "valor": "110.00",
    "horario": "2020-09-09T20:15:00.358Z",
    "pagador": {
      "cpf": "0123456789",
      "nome": "Nome Pagador"
    },
    "devolucoes": {
      "id": "123ABC",
      "rtrId": "D12345678202009091221abcdf098765",
      "valor": "10.00",
      "status": "DEVOLVIDO",
      "horario": {
        "liquidacao": "2020-09-09T20:15:00.358Z",
        "solicitacao": "2020-09-09T20:15:00.358Z"
      },
      "natureza": "ORIGINAL"
    },
    "endToEndId": "E12345678202009091221abcdef12345"
  }
}