Status Webhook

Payment status can be returned via webhook. This way, when creating the transaction, we send a request with the redirection URL.

After the conclusion of the operation by the user, we send the final status of the transaction.


Example of webhooks

{
   "callbackId":"b02ed5c1-8911-4eec-ab6a-edce15b15a9d",
   "callbackStatus":"created",
   "eventType":"pix_direct_success",
   "pixDirectPayment":{
      "paymentId":"de848f53-9a19-4340-8704-66afc682876c",
      "paymentStatus":"SUCCESS",
      "createdAt":"2025-03-09T20:23:59.290Z",
      "updatedAt":"2025-03-09T20:24:30.940Z",
      "externalId":"26bbe0bb-c429-485f-8bc3-d164e2d162a8",
      "endToEndId":"E44471172202503092024U5cc61c997b",
      "amount":30,
      "additionalInformation":[
         {
            "name":"my-key",
            "content":"my-value"
         },
         {
            "name":"my-other-key",
            "content":null
         }
      ],
      "pixAccountInfos":{
         "id":"01961a7d-b9f3-711b-9455-bf5b9b75b9c3",
         "ispb":"21018182",
         "branch":"0001",
         "account":"190193",
         "accountType":"CACC",
         "taxId":"22088962034",
         "personType":"CPF",
         "name":"usuario base de testes"
      }
   },
   "customerId":"92d725ff-fbd0-44df-a666-e673ba279945"
}
{
   "callbackId":"b02ed5c1-8911-4eec-ab6a-edce15b15a9d",
   "callbackStatus":"created",
   "eventType":"pix_direct_failed",
   "pixBiometricPayment":{
      "paymentId":"de848f53-9a19-4340-8704-66afc682876c",
      "paymentStatus":"FAILED",
      "failedReason":"ACCOUNT_MISMATCH",
      "failedDescription":"There was a mismatch between the debtor's account and the restrict payers account.",
      "createdAt":"2025-03-09T20:23:59.290Z",
      "updatedAt":"2025-03-09T20:24:30.940Z",
      "externalId":"26bbe0bb-c429-485f-8bc3-d164e2d162a8",
      "endToEndId":"E44471172202503092024U5cc61c997b",
      "amount":30,
      "additionalInformation":[
         {
            "name":"my-key",
            "content":"my-value"
         },
         {
            "name":"my-other-key",
            "content":null
         }
      ],
      "pixAccountInfos":{
         "id":"01961a7d-b9f3-711b-9455-bf5b9b75b9c3",
         "ispb":"21018182",
         "branch":"0001",
         "account":"190193",
         "accountType":"CACC",
         "taxId":"22088962034",
         "personType":"CPF",
         "name":"usuario base de testes"
      }
   },
   "customerId":"92d725ff-fbd0-44df-a666-e673ba279945"
}