Github

Webhook transacional

Esse webhook é acionado e envia uma notificação via POST a cada alteração do status de uma transação. Ele é aplicado para todas as formas de pagamento e compreende todo o ciclo de vida de uma transação.

ℹ️

Antes de configurar seus webhooks, recomendamos fortemente que você leia:documentação completa sobre Webhooks e Callbacks.

Essa documentação apresenta detalhes essenciais como:

  • Como configurar as URLs de notificação;
  • Lista completa de eventos suportados por meio de webhook;
  • Formato e conteúdo dos payloads;
  • Política de retentativas em caso de falha;
  • Boas práticas para evitar perda de notificações;
⚠️

O sucesso da integração com webhooks depende diretamente da correta interpretação e tratamento das notificações. Entender esses pontos evita perda de eventos, problemas em conciliação e falhas críticas na automação do seu sistema.


Eventos

{
    "IdTransaction": 2091328,
    "TransactionStatus": {
        "Id": 1,
        "Code": "1",
        "Name": "Pendente"
    },
    "PaymentMethod": {
        "Id": 1,
        "Code": "1",
        "Name": "Boleto"
    },
    "Application": "Venda Rápida",
    "Vendor": "Vendedor 1",
    "Amount": 1,
    "IncluedDate": "2020-02-13T14:57:20.9",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "Reference": "Pedido 48",
    "DiscountAmount": 0.05
}
{
    "IdTransaction": 2086999,
    "TransactionStatus": {
        "Id": 2,
        "Code": "2",
        "Name": "Processamento"
    },
    "PaymentMethod": {
        "Id": 1,
        "Code": "1",
        "Name": "Boleto"
    },
    "Application": "Sistema de Gestão",
    "Vendor": "Vendedor",
    "Amount": 191.89,
    "PaymentDate": "2020-02-13T15:00:00",
    "IncluedDate": "2020-02-13T10:18:41.51",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "PaidValue": 191.89,
    "AdditionValue": 0,
    "DiscountValue": 0,
    "Reference": "91137"
}
{
    "IdTransaction": 1985277,
    "TransactionStatus": {
        "Id": 6,
        "Code": "6",
        "Name": "Estornado"
    },
    "PaymentMethod": {
        "Id": 2,
        "Code": "2",
        "Name": "Cartão de Crédito"
    },
    "Application": "Aplicação de teste",
    "Vendor": "Vededor Teste",
    "Amount": 5,
    "PaymentDate": "2020-01-30T09:44:43.917",
    "IncluedDate": "2020-01-30T09:44:39.463",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "Reference": ""
}
{
    "IdTransaction": 2081106,
    "TransactionStatus": {
        "Id": 7,
        "Code": "7",
        "Name": "Baixado"
    },
    "PaymentMethod": {
        "Id": 1,
        "Code": "1",
        "Name": "Boleto"
    },
    "Application": "NF-e",
    "Vendor": "Não informado",
    "Amount": 530,
    "IncluedDate": "2020-02-12T11:56:44.663",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "Reference": "1229"
}
{
    "IdTransaction": 2036495,
    "TransactionStatus": {
        "Id": 11,
        "Code": "11",
        "Name": "Liberado"
    },
    "PaymentMethod": {
        "Id": 1,
        "Code": "1",
        "Name": "Boleto"
    },
    "Application": "safe2pay-integration",
    "Vendor": "safe2pay-tests",
    "Amount": 100,
    "IncluedDate": "2020-02-05T14:07:42.27",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "Reference": "1229"
}
{
    "id": "XXXXXXXXXX_CHARGEBACK_1",
    "LastDatabaseUpdate": "2025-08-03T20:10:49.6909066-03:00",
    "PartitionKey": "XXXXXXXXXX",
    "NotificationWrapper": {
        "PayloadType": 1,
        "TransferRegisterId": 0,
        "ValidationSimplify": null,
        "TransactionId": "XXXXXXXXXX",
        "MerchantId": "XXXXX",
        "MerchantRootId": 0,
        "ApiVersion": 2,
        "MessageOrigin": null,
        "GatewayId": 2,
        "SentWithSuccess": true,
        "LastAttemptSentWithSuccess": true,
        "TransactionStatus": 13,
        "FirstSendingDate": "2025-08-03T20:10:48.1101966-03:00",
        "HttpRequest": null,
        "NotificationUrl": "https://webhook.XXXXX/al/safe2pay",
        "base64AuthorizationHeaderContent": null,
        "NotificationPayload": {
            "IdTransaction": "XXXXXXXXXX",
            "TransactionStatus": {
                "Id": 13,
                "Code": "13",
                "Name": "Chargeback"
            },
            "PaymentMethod": {
                "Id": 2,
                "Code": "2",
                "Name": "Cartão de Crédito",
                "Show": false,
                "IsEnabled": false
            },
            "Application": "XXXXXXXXXXXX",
            "Vendor": "XXXXXXXXXXXXXXXXXXXXXX",
            "Amount": "XX.XX",
            "PaymentDate": "2025-08-01T17:15:24.807",
            "IncluedDate": "2025-08-01T17:15:21.893",
            "InstallmentQuantity": 1,
            "SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "Reference": "XXXXXXXX",
            "Tid": "XXXXXXXXXXXXXXXXXXXXXXXX",
            "AuthorizationCode": "XXXXXX",
            "MultiPaymentChargeId": 0
        },
        "SendingAttemptsResults": [
            {
                "DescriptionSafe2Pay": null,
                "HttpResponseCode": 200,
                "HttpResponseDescription": "8/3/2025 8:10:48 PM | Resultado do envio da notificação: True - Fila unsent_notification",
                "HttpResponseText": "",
                "HttpRequestBody": null,
                "ElapsedTimeOfRequest": "00:00:00.2710143",
                "Date": "2025-08-03T20:10:48.9273136-03:00",
                "MaxSecondsTimeout": 10
            }
        ],
        "SendingAttemptsCount": 1,
        "IsManuallyResend": false,
        "PaymentMethod": 2,
        "CurrentStatusChangedDate": "2025-08-03T20:10:45.777"
    },
    "_rid": "XXXXXXXXXXXX",
    "_self": "dbs/XXXXX==/colls/XXXXXXXX=/docs/XXXXXXXXXXXX/",
    "_etag": "\"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\"",
    "_attachments": "attachments/",
    "_ts": 1754262649
}
{
    "id": "130618375_EM_DISPUTA_1",
    "LastDatabaseUpdate": "2025-08-04T06:03:04.1270277-03:00",
    "PartitionKey": "130618375",
    "NotificationWrapper": {
        "PayloadType": 1,
        "TransferRegisterId": 0,
        "ValidationSimplify": null,
        "TransactionId": 130618375,
        "MerchantId": 358822,
        "MerchantRootId": 0,
        "ApiVersion": 2,
        "MessageOrigin": null,
        "GatewayId": 2,
        "SentWithSuccess": true,
        "LastAttemptSentWithSuccess": true,
        "TransactionStatus": 5,
        "FirstSendingDate": "2025-08-04T06:03:03.5085451-03:00",
        "HttpRequest": null,
        "NotificationUrl": "https://mbc-api-queue.sthima.com/open-endpoints/safe2pay-callback",
        "base64AuthorizationHeaderContent": null,
        "NotificationPayload": {
            "IdTransaction": 130618375,
            "TransactionStatus": {
                "Id": 5,
                "Code": "5",
                "Name": "Em Disputa"
            },
            "PaymentMethod": {
                "Id": 2,
                "Code": "2",
                "Name": "Cartão de Crédito",
                "Show": false,
                "IsEnabled": false
            },
            "Application": "Minha Biblioteca Católica",
            "Vendor": "Minha Biblioteca Católica",
            "Amount": 479.4,
            "PaymentDate": "2025-07-23T10:55:49.223",
            "IncluedDate": "2025-07-23T10:55:45.553",
            "InstallmentQuantity": 6,
            "SecretKey": "48030EC3BA724F4AA7C54F2B735753D43B49F04FE081463CA92F984E398284DD",
            "Reference": "MBC5962509",
            "Tid": "27838337564NF0L6KICC",
            "AuthorizationCode": "365011",
            "MultiPaymentChargeId": 0
        },
        "SendingAttemptsResults": [
            {
                "DescriptionSafe2Pay": null,
                "HttpResponseCode": 204,
                "HttpResponseDescription": "8/4/2025 6:03:04 AM | Resultado do envio da notificação: True - Fila unsent_notification",
                "HttpResponseText": "",
                "HttpRequestBody": null,
                "ElapsedTimeOfRequest": "00:00:00.0151528",
                "Date": "2025-08-04T06:03:04.0707458-03:00",
                "MaxSecondsTimeout": 10
            }
        ],
        "SendingAttemptsCount": 1,
        "IsManuallyResend": false,
        "PaymentMethod": 2,
        "CurrentStatusChangedDate": "2025-08-04T06:03:02.96"
    },
    "_rid": "v7gdANYz1QAu2nsBAACAAg==",
    "_self": "dbs/v7gdAA==/colls/v7gdANYz1QA=/docs/v7gdANYz1QAu2nsBAACAAg==/",
    "_etag": "\"2c008233-0000-0b00-0000-689077480000\"",
    "_attachments": "attachments/",
    "_ts": 1754298184
}

Eventos de pagamentos autorizados

{
  "IdTransaction": 138667690,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Comercial Teste LTDA (11222333000199)",
      "Amount": 198.75,
      "Tax": 1,
      "IsTransferred": false,
      "ReleaseDate": "2025-09-26T00:00:00"
    }
  ],
  "PaymentMethod": {
    "Id": 1,
    "Code": "1",
    "Name": "Boleto",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTesteBoletos",
  "Vendor": "Loja Exemplo Teste",
  "Amount": 199.75,
  "PaymentDate": "2025-09-24T00:00:00",
  "IncluedDate": "2025-09-24T15:53:35.703",
  "InstallmentQuantity": 0,
  "SecretKey": "TESTESECRETKEYBOLETO1234567890",
  "TaxValue": 1,
  "NetValue": 198.75,
  "PaidValue": 199.75,
  "AdditionValue": 0,
  "DiscountValue": 0,
  "DiscountAmount": 0,
  "PaidByPix": true,
  "Reference": "REF-BOLETO-TESTE-001",
  "Origin": {
    "SingleSaleHash": "HASH-UNICO-TESTE-123456",
    "DueDate": "2025-09-25T00:00:00",
    "ExpirationDate": "2025-10-25T00:00:00"
  },
  "MultiPaymentChargeId": 0,
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T17:06:46.857"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T15:53:35.71"
    }
  ]
}
{
  "IdTransaction": 138665749,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Alfa Comércio de Testes LTDA (11222333000199)",
      "Amount": 108.33,
      "Tax": 1.67,
      "IsTransferred": false,
      "ReleaseDate": "2025-09-26T00:00:00"
    }
  ],
  "PaymentMethod": {
    "Id": 1,
    "Code": "1",
    "Name": "Boleto",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTesteBoletos / Pedido de Venda: 999999",
  "Vendor": "Maria Oliveira Teste",
  "Amount": 180,
  "PaymentDate": "2025-09-24T00:00:00",
  "IncluedDate": "2025-09-24T15:43:13.683",
  "InstallmentQuantity": 0,
  "SecretKey": "TESTESECRETKEYBOLETO987654321",
  "TaxValue": 1.67,
  "NetValue": 108.33,
  "PaidValue": 180,
  "AdditionValue": 0,
  "DiscountValue": 0,
  "DiscountAmount": 0,
  "PaidByPix": true,
  "Reference": "REF-BOLETO-TESTE-002",
  "Splits": [
    {
      "IdTransactionSplitter": 138665752,
      "IdReceiver": 40001,
      "CodeTaxType": 2,
      "Identity": "98765432100",
      "Name": "João da Silva Teste",
      "IsPayTax": false,
      "Amount": 70,
      "CheckingAccounts": [
        {
          "Description": "Alfa Comércio de Testes LTDA (11222333000199)",
          "Amount": 70,
          "Tax": 0,
          "IsTransferred": false,
          "ReleaseDate": "2025-09-26T00:00:00"
        }
      ]
    }
  ],
  "MultiPaymentChargeId": 0,
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T17:06:44.007"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T15:43:13.69"
    }
  ]
}
{
  "IdTransaction": 138678111,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Carlos Teste (12345678901)",
      "Amount": 37.63,
      "Tax": 1,
      "IsTransferred": false,
      "ReleaseDate": "2025-10-27T00:00:00",
      "InstallmentNumber": 1
    },
    {
      "Description": "Carlos Teste (12345678901)",
      "Amount": 37.62,
      "Tax": 0.99,
      "IsTransferred": false,
      "ReleaseDate": "2025-11-25T00:00:00",
      "InstallmentNumber": 2
    }
  ],
  "PaymentMethod": {
    "Id": 2,
    "Code": "2",
    "Name": "Cartão de Crédito",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTeste02",
  "Vendor": "Loja Exemplo Teste",
  "Amount": 77.24,
  "PaymentDate": "2025-09-24T16:56:48.683",
  "IncluedDate": "2025-09-24T16:56:44.85",
  "InstallmentQuantity": 2,
  "SecretKey": "TESTESECRETKEY987654321",
  "TaxValue": 1.99,
  "NetValue": 75.25,
  "Reference": "REF-TESTE-002",
  "Tid": "TID9876543210XYZ",
  "AuthorizationCode": "AUTH5678",
  "MultiPaymentChargeId": 0,
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T16:56:48.86"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T16:56:44.857"
    }
  ]
}
{
  "IdTransaction": 138678222,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Conta Teste (12345678900)",
      "Amount": 28.63,
      "Tax": 0.58,
      "IsTransferred": false,
      "ReleaseDate": "2025-10-27T00:00:00",
      "InstallmentNumber": 1
    }
  ],
  "PaymentMethod": {
    "Id": 2,
    "Code": "2",
    "Name": "Cartão de Crédito",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTeste01",
  "Vendor": "Padaria Teste Ltda",
  "Amount": 29.5,
  "PaymentDate": "2025-09-24T17:00:33.313",
  "IncluedDate": "2025-09-24T17:00:30.17",
  "InstallmentQuantity": 1,
  "SecretKey": "TESTE1234567890SECRETKEY",
  "TaxValue": 0.58,
  "NetValue": 28.63,
  "Reference": "REF123456",
  "Tid": "TID1234567890ABCDE",
  "AuthorizationCode": "AUTH1234",
  "Splits": [
    {
      "IdTransactionSplitter": 138678700,
      "IdReceiver": 210557,
      "CodeTaxType": 2,
      "Identity": "11222333000199",
      "Name": "Tech Solutions Teste LTDA",
      "IsPayTax": true,
      "Amount": 0,
      "CheckingAccounts": [
        {
          "Description": "Conta Teste (12345678900)",
          "Amount": 0,
          "Tax": 0,
          "IsTransferred": false,
          "ReleaseDate": "2025-10-27T00:00:00",
          "InstallmentNumber": 1
        }
      ]
    },
    {
      "IdTransactionSplitter": 138678701,
      "IdReceiver": 336147,
      "CodeTaxType": 2,
      "Identity": "98765432100",
      "Name": "João da Silva Teste",
      "IsPayTax": false,
      "Amount": 0.29,
      "CheckingAccounts": [
        {
          "Description": "Conta Teste (12345678900)",
          "Amount": 0.29,
          "Tax": 0,
          "IsTransferred": false,
          "ReleaseDate": "2025-10-27T00:00:00",
          "InstallmentNumber": 1
        }
      ]
    }
  ],
  "MultiPaymentChargeId": 0,
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T17:00:33.56"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T17:00:30.177"
    }
  ]
}
{
  "IdTransaction": 138682452,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Tech Demo LTDA (11222333000199)",
      "Amount": 4.83,
      "Tax": 0.16,
      "IsTransferred": false,
      "ReleaseDate": "2025-09-25T00:00:00"
    }
  ],
  "PaymentMethod": {
    "Id": 6,
    "Code": "6",
    "Name": "Pix Recebimento",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTestePix",
  "Vendor": "AppTestePix",
  "Amount": 4.99,
  "PaymentDate": "2025-09-24T17:29:46",
  "IncluedDate": "2025-09-24T17:28:43.8",
  "InstallmentQuantity": 0,
  "SecretKey": "TESTEPIXSECRET1234567890",
  "TaxValue": 0.16,
  "NetValue": 4.83,
  "EndToEndId": "E0000000000000000000000000000000",
  "Reference": "REF-PIX-TESTE-001",
  "MultiPaymentChargeId": 0,
  "Payer": {
    "Name": "José da Silva Teste",
    "Identity": "12345678900"
  },
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T17:30:22.683"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T17:28:43.8"
    }
  ]
}
{
  "IdTransaction": 138682650,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "Maria Teste (12345678900)",
      "Amount": 28.5,
      "Tax": 0,
      "IsTransferred": false,
      "ReleaseDate": "2025-10-01T00:00:00"
    }
  ],
  "PaymentMethod": {
    "Id": 6,
    "Code": "6",
    "Name": "Pix Recebimento",
    "Show": false,
    "IsEnabled": false
  },
  "Application": "AppTesteEventos",
  "Vendor": "AppTesteEventos",
  "Amount": 30,
  "PaymentDate": "2025-09-24T17:30:56",
  "IncluedDate": "2025-09-24T17:30:26.933",
  "InstallmentQuantity": 0,
  "SecretKey": "TESTESECRETKEYPIX1234567890",
  "TaxValue": 0.57,
  "NetValue": 28.5,
  "EndToEndId": "E000000000000000000000000000TEST",
  "Reference": "REF-PIX-EVENTO-TESTE-001",
  "Splits": [
    {
      "IdTransactionSplitter": 138682651,
      "IdReceiver": 20001,
      "CodeTaxType": 2,
      "Identity": "11222333000199",
      "Name": "Empresa Demo LTDA",
      "IsPayTax": false,
      "Amount": 0.57,
      "CheckingAccounts": [
        {
          "Description": "Maria Teste (12345678900)",
          "Amount": 0.31,
          "Tax": 0.26,
          "IsTransferred": false,
          "ReleaseDate": "2025-09-25T00:00:00"
        }
      ]
    },
    {
      "IdTransactionSplitter": 138682758,
      "IdReceiver": 20001,
      "CodeTaxType": 2,
      "Identity": "11222333000199",
      "Name": "Empresa Demo LTDA",
      "IsPayTax": false,
      "Amount": 0.93,
      "CheckingAccounts": [
        {
          "Description": "Maria Teste (12345678900)",
          "Amount": 0.93,
          "Tax": 0,
          "IsTransferred": false,
          "ReleaseDate": "2025-09-25T00:00:00"
        }
      ]
    }
  ],
  "MultiPaymentChargeId": 0,
  "Payer": {
    "Name": "João da Silva Teste",
    "Identity": "98765432100"
  },
  "TransactionHistory": [
    {
      "Code": "3",
      "Name": "Autorizado",
      "ChangedDate": "2025-09-24T17:31:25.583"
    },
    {
      "Code": "1",
      "Name": "Pendente",
      "ChangedDate": "2025-09-24T17:30:26.937"
    }
  ]
}