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": 2081955,
    "TransactionStatus": {
        "Id": 3,
        "Code": "3",
        "Name": "Autorizado"
    },
    "CheckingAccounts": [
        {
            "Description": "CLIENTE DE TESTE (111111111111)",
            "Amount": 45.73,
            "Tax": 1.7,
            "IsTransferred": false,
            "ReleaseDate": "2020-02-14T00:00:00"
        }
    ],
    "PaymentMethod": {
        "Id": 1,
        "Code": "1",
        "Name": "Boleto"
    },
    "Application": "Pagamento",
    "Vendor": "E-commerce",
    "Amount": 47.43,
    "PaymentDate": "2020-02-12T00:00:00",
    "IncluedDate": "2020-02-12T13:07:59.84",
    "EndToEndId": "",
    "InstallmentQuantity": 0,
    "SecretKey": "SECRET_KEY",
    "TaxValue": 1.7,
    "NetValue": 45.73,
    "PaidValue": 47.43,
    "AdditionValue": 0,
    "DiscountValue": 0,
    "Reference": "147075358"
}
{
  "IdTransaction": 1040415,
  "TransactionStatus": {
    "Id": 3,
    "Code": "3",
    "Name": "Autorizado"
  },
  "CheckingAccounts": [
    {
      "Description": "João da Silva(29742237026)",
      "Amount": 0.01,
      "Tax": 0,
      "IsTransferred": false,
      "ReleaseDate": "2019-10-14T00:00:00",
      "InstallmentNumber": 1
    }
  ],
  "PaymentMethod": {
    "Id": 2,
    "Code": "2",
    "Name": "Cartão de Crédito"
  },
  "Application": "Teste Safe2Pay",
  "Vendor": "Lucas Diogo",
  "Amount": 200.0,
  "PaymentDate": "2019-09-11T12:57:50.587",
  "IncluedDate": "2019-09-11T12:42:54.143",
  "EndToEndId": "",
  "InstallmentQuantity": 1,
  "SecretKey": "SECRET_KEY",
  "TaxValue": 205.2,
  "NetValue": -5.2,
  "Reference": "",
  "Tid": "020006495642",
  "AuthorizationCode": "205340",
  "Splits": [
    {
      "IdTransactionSplitter": 1040416,
      "IdReceiver": 18,
      "CodeTaxType": 2,
      "Identity": "99999999999",
      "Name": "Empresa Teste Marketplace",
      "IsPayTax": true,
      "Amount": 200,
      "CheckingAccounts": [
        {
          "Description": "Descrição de Teste",
          "Amount": 200,
          "Tax": 0,
          "IsTransferred": false,
          "ReleaseDate": "2019-09-11T00:00:00",
          "InstallmentNumber": 1
        }
      ]
    }
  ]
}
{
    "IdTransaction": 26630087,
    "TransactionStatus": {
        "Id": 3,
        "Code": "3",
        "Name": "Autorizado"
    },
    "CheckingAccounts": [
        {
            "Description": "Cliente de Teste (1111111111)",
            "Amount": 9.03,
            "Tax": 0.97,
            "IsTransferred": false,
            "ReleaseDate": "2022-04-01T00:00:00"
        }
    ],
    "PaymentMethod": {
        "Id": 6,
        "Code": "6",
        "Name": "Pix Recebimento",
        "Show": false
    },
    "Payer": {
        "Name": "Pagador de Teste",
        "Identity": "88888888888"
    },
    "Application": "Aplicação de teste",
    "Vendor": "João da Silva",
    "Amount": 10.0,
    "PaymentDate": "2020-03-31T25:37:53.33",
    "IncluedDate": "2022-03-31T17:37:55.01",
    "EndToEndId": "E18236120202404241420s0612999999",
    "InstallmentQuantity": 0,
    "SecretKey": "",
    "Reference": "TESTE"
}