Webhooks Event Types

eventType

Type of notification	Description
`pix_charge_paid`	The QRCode was paid.
`pix_charge_expired`	The QRCode created was expired.
`pix_transaction_success`	The transaction was completed successfully.
`pix_transaction_failed`	The transaction was failed.
`pix_outgoing_refund_success`	The refund of a deposit was successfully.
`pix_outgoing_refund_failed`	The refund of a deposit was failed.
`pix_incoming_refund_success`	The refund of a withdraw was successfully.
`pix_incoming_refund_failed`	The refund of a withdraw was failed.

Payload examples

`pix_charge_paid`

{
  "callbackId": "b02ed5c1-8911-4eec-ab6a-edce15b15a9d",
  "callbackStatus": "created",
  "externalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
  "eventType": "pix_charge_paid",
  "pixCharge": {
    "pixChargeId": "56b548a5-57e2-417f-9df9-f77ec737f25c",
    "pixChargeQrCodeType": "IMMEDIATE",
    "pixChargeExpiration": "2024-01-15T16:48:17.422Z",
    "pixChargeValue": 790.34,
    "pixChargeValuePaid": 790.34,
    "pixChargePaidAt": "2024-01-15T16:47:03.650Z",
    "pixChargeStatus": "paid",
    "pixChargeRestrictPayers": [],
    "pixAccountInfos": {
      "id": "3b52709e-1274-435a-bb9a-6e40a2f182ca",
      "branch": "1",
      "account": "10000294290",
      "ispb": "30980539",
      "taxId": "60418443734",
      "accountType": "TRAN",
      "personType": "CPF",
      "name": "conta teste carga"
    },
    "pixChargeTax": null,
    "pixChargeCost": 50,
    "pixChargeUrl": "qrcode-h.pixu4c.com.br/cob/56b548a5-57e2-417f-9df9-f77ec737f25c",
    "pixChargeTextContent": "00020101021226850014br.gov.bcb.pix2563qrcode-h.pixu4c.com.br/cob/56b548a5-57e2-417f-9df9-f77ec737f25c5204000053039865802BR5918ucrypto S T E F sa6014belo horizonte61083011201062070503***6304F3D2",
    "pixChargeCreatedAt": "2024-01-15T16:46:37.423Z",
    "pixChargeUpdatedAt": "2024-01-15T16:47:03.674Z",
    "pixChargeExternalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
    "pixChargeIdConciliation": "8ba73f3669d449ecbe2cc81fa0a75440",
    "pixTransactionEndToEndId": "E3098053920240115164700397678057",
    "pixTransactionId": "049d0c73-a528-40f0-8368-9ad55b6a86ed",
    "pixTransactionStatus": "success",
    "customerId": "fb15a339-4c0b-4065-888d-0ef71cc14888"
  }
}

`pix_charge_expired`

{
  "callbackId": "d1ba6625-0c57-44f5-8e38-696e0e3a7822",
  "callbackStatus": "created",
  "externalId": "864d5de4-3972-44f8-979b-2840364eafd1",
  "eventType": "pix_charge_expired",
  "pixCharge": {
    "pixChargeId": "e59065e2-3d5c-4861-9d22-4517d72327e1",
    "pixChargeStatus": "expired",
    "pixChargeExternalId": "864d5de4-3972-44f8-979b-2840364eafd1",
    "pixChargeValue": 0.1,
    "customerId": "1f8d3745-08c5-4567-9e68-5290a5270ded",
    "pixChargeQrCodeType": "IMMEDIATE",
    "pixChargeUpdatedAt": "2024-01-15T21:31:58.747Z",
    "pixChargeCreatedAt": "2024-01-15T20:31:26.541Z",
    "pixChargeExpiration": "2024-01-15T21:31:26.542Z",
    "pixChargeTextContent": "00020101021226850014br.gov.bcb.pix2563qrcode-h.pixu4c.com.br/cob/e59065e2-3d5c-4861-9d22-4517d72327e15204200053039865802BR5918ucrypto S T E F sa6014belo horizonte61088605586062070503***630444C8",
    "pixChargeIdConciliation": "632af4926bf34ab8ad41c11ad84a8542",
    "pixChargeUrl": "qrcode-h.pixu4c.com.br/cob/e59065e2-3d5c-4861-9d22-4517d72327e1",
    "pixChargeRestrictPayers": [
      "01910077224"
    ]
  }
}

`pix_transaction_success(credit)`

{
  "callbackId": "4f0d25c5-28ea-4aa9-abe4-f175a59788ca",
  "callbackStatus": "created",
  "externalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
  "eventType": "pix_transaction_success",
  "pixTransaction": {
    "pixTransactionId": "049d0c73-a528-40f0-8368-9ad55b6a86ed",
    "pixTransactionAmount": 790.34,
    "pixTransactionStatus": "success",
    "pixTransactionType": "credit",
    "customerId": "fb15a339-4c0b-4065-888d-0ef71cc14888",
    "pixTransactionCreatedAt": "2024-01-15T16:47:03.570Z",
    "pixTransactionUpdatedAt": "2024-01-15T16:47:03.671Z",
    "pixTransactionEndToEndId": "E3098053920240115164700397678057",
    "pixTransactionExternalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
    "pixAccountInfos": {
      "id": "3b52709e-1274-435a-bb9a-6e40a2f182ca",
      "branch": "1",
      "account": "10000294290",
      "ispb": "30980539",
      "taxId": "60418443734",
      "accountType": "TRAN",
      "personType": "CPF",
      "name": "conta teste carga"
    },
    "pixChargeInfo": {
      "pixChargeId": "56b548a5-57e2-417f-9df9-f77ec737f25c",
      "pixChargeType": "IMMEDIATE",
      "pixChargeValue": 790.34,
      "pixChargeValuePaid": 790.34,
      "pixChargeStatus": "paid",
      "pixChargeCreatedAt": "2024-01-15T16:46:37.423Z",
      "pixChargeUpdatedAt": "2024-01-15T16:47:03.674Z",
      "pixChargePaidAt": "2024-01-15T16:47:04.000Z",
      "pixChargeExternalId": "13e032b8-6452-4ed9-aca0-483535bca80a"
    }
  }
}

`pix_transaction_success(debit)`

{
  "callbackId": "166d85d4-1fce-4784-b075-452eccaec8f9",
  "callbackStatus": "created",
  "externalId": "f7447a21-17a8-4e20-8067-32f0542858fa",
  "eventType": "pix_transaction_success",
  "pixTransaction": {
    "pixTransactionId": "d22a0df1-8ea6-441e-8032-2ae134cba2c6",
    "pixTransactionAmount": 790.34,
    "pixTransactionStatus": "success",
    "pixTransactionType": "debit",
    "customerId": "9dffe3aa-2cb7-43a5-9dd6-c43ed01cc51b",
    "pixTransactionCreatedAt": "2024-01-15T16:47:01.383Z",
    "pixTransactionUpdatedAt": "2024-01-15T16:47:04.585Z",
    "pixTransactionEndToEndId": "E3098053920240115164700397678057",
    "pixTransactionExternalId": "f7447a21-17a8-4e20-8067-32f0542858fa",
    "pixAccountInfos": {
      "id": "8f372914-360d-4555-a34f-39195db21211",
      "branch": "1",
      "account": "10000295156",
      "ispb": "30980539",
      "taxId": "30980539000115",
      "accountType": "TRAN",
      "personType": "CNPJ",
      "name": "u4crypto solucoes tecnologicas e financeiras sa"
    }
  }
}

`pix_transaction_failed`

{
  "callbackId": "3eaee53f-09c6-4743-9a8a-c8f07ad80253",
  "callbackStatus": "created",
  "externalId": "e5505eff-4761-4808-ac71-a555afba55bb",
  "eventType": "pix_transaction_failed",
  "pixTransaction": {
    "pixTransactionId": "a6220c4b-c7e2-4ed3-b5e7-6d6a4e113c90",
    "pixTransactionAmount": 0.01,
    "pixTransactionStatus": "fail",
    "pixTransactionType": "debit",
    "customerId": "2720d8fe-1e9a-4ff4-ba07-c138070490a3",
    "pixTransactionCreatedAt": "2024-02-28T23:26:11.552Z",
    "pixTransactionUpdatedAt": "2024-02-28T23:26:16.717Z",
    "pixTransactionEndToEndId": "E3098053920240228232613925703625",
    "pixTransactionExternalId": "e5505eff-4761-4808-ac71-a555afba55bb",
    "pixAccountInfos": {
      "id": "0d729d33-d2c8-48a0-8e16-705b445d8b10",
      "branch": "3353",
      "account": "10002293",
      "ispb": "90400888",
      "taxId": "9236714583",
      "accountType": "CACC",
      "personType": "CPF",
      "name": "ANDRE AUGUSTO LOPES MARTINS"
    },
    "errorCode": "AC06",
    "errorMessage": "Pagamento rejeitado pelo PSP do recebedor"
  }
}

`pix_outgoing_refund_success`

{
  "callbackId": "58a078f8-4ab3-4181-86ba-a753bc8783eb",
  "callbackStatus": "created",
  "externalId": "39d7db4c-7b3e-4fe7-a6b7-93063b6e6236",
  "eventType": "pix_outgoing_refund_success",
  "pixOutgoingRefund": {
    "pixTransactionId": "5a6958b1-7bf6-46dd-b9d9-5850b9ad4eda",
    "pixTransactionAmount": 5.88,
    "pixTransactionStatus": "success",
    "pixTransactionType": "debit",
    "customerId": "0b373c06-2b22-4ba0-a4a0-c7dec08110e2",
    "pixTransactionCreatedAt": "2024-01-03T09:02:26.131Z",
    "pixTransactionUpdatedAt": "2024-01-03T09:02:29.093Z",
    "pixTransactionEndToEndId": "D2b79a8069904f6ea390b02f620d4192",
    "pixTransactionExternalId": "39d7db4c-7b3e-4fe7-a6b7-93063b6e6236",
    "pixAccountInfos": {
      "id": "3b52709e-1274-435a-bb9a-6e40a2f182ca",
      "branch": "1",
      "account": "10000294290",
      "ispb": "30980539",
      "taxId": "60418443734",
      "accountType": "TRAN",
      "personType": "CPF",
      "name": "conta teste carga"
    },
    "pixChargeInfo": {
      "pixChargeId": "1c6114c5-15e3-4a1b-b2db-f665aa2799d3",
      "pixChargeType": "IMMEDIATE",
      "pixChargeValue": 416.24,
      "pixChargeValuePaid": 416.24,
      "pixChargeStatus": "paid",
      "pixChargeCreatedAt": "2024-01-03T08:59:14.020Z",
      "pixChargeUpdatedAt": "2024-01-03T08:59:31.469Z",
      "pixChargePaidAt": "2024-01-03T08:59:31.000Z",
      "pixChargeExternalId": "d8691304-9d13-4432-b952-803e5000be89"
    },
    "returnDetails": {
      "pixTransactionLeftAmount": 404.48,
      "pixTransactionReturnedHistoric": [
        {
          "amount": 5.88,
          "createdAt": "2024-01-03T09:01:32.568Z",
          "endToEndId": "D9c205b7ca614f1d9e6d00d50dec9063",
          "codeReturned": "MD06",
          "reasonReturned": "Solicitado pelo usuário recebedor",
          "transactionStatus": "DEBT_REFUNDED"
        }
      ],
      "pixTransactionOriginalAmount": 416.24
    }
  }
}

`pix_incoming_refund_success`

{
  "callbackId": "60b21a0a-8dc2-473d-afbb-64c0d7597c59",
  "callbackStatus": "created",
  "eventType": "pix_incoming_refund_success",
  "pixIncomingRefund": {
    "pixTransactionId": "bef92e41-ff3d-4c96-a0ff-51dc5b797698",
    "pixTransactionAmount": 3,
    "pixTransactionStatus": "success",
    "pixTransactionType": "credit",
    "customerId": "2003d8c5-99df-4046-bb4a-bd2ee914fdd4",
    "pixTransactionCreatedAt": "2024-02-23T19:16:20.761Z",
    "pixTransactionUpdatedAt": "2024-02-23T19:17:55.042Z",
    "pixTransactionEndToEndId": null,
    "pixTransactionOriginalExternalId": "4316625c-f2b9-485c-84c5-cfcdf1f25084",
    "pixAccountInfos": {
      "id": "15e6c864-be84-4024-8f09-5b56720c205b",
      "branch": "1",
      "account": "10000000369",
      "ispb": "30980539",
      "taxId": "30980539000115",
      "accountType": "TRAN",
      "personType": "CNPJ",
      "name": "u4crypto solucoes tecnologicas e financeiras sa"
    },
    "pixTransactionReturn": {
      "pixTransactionReturnedEndToEndId": "E3098053934e436db3154443e9a4dfa9",
      "pixTransactionReturnedAmount": 3,
      "pixTransactionReturnedDescription": "Internal Refund",
      "pixTransactionOriginalAmount": 3,
      "pixTransactionOriginalEndToEndId": "E3098053934e436db3154443e9a4dfa9",
      "pixTransactionIdOriginal": "b389ad81-9a45-4166-86d1-2b0b62499a11"
    }
  }
}