Skip to main content

Payload de Cobrança Pix Paga

Pix Cobrança Paga​

Os webhooks de CHARGE_COMPLETED enviam objetos com os seguintes campos no seu payload:

  • pix: Objeto com detalhes da transação Pix
  • company: Empresa a que a Transação pertence
  • account: Detalhes da conta que a Transação pertence

Exemplo​

{
  "event": "OPENPIX:CHARGE_COMPLETED",
  "charge": {
    "value": 1,
    "comment": "",
    "identifier": "d983a07836cf48ed9a65764d3c184273",
    "transactionID": "d983a07836cf48ed9a65764d3c184273",
    "status": "COMPLETED",
    "additionalInfo": [],
    "fee": 85,
    "discount": 0,
    "valueWithDiscount": 1,
    "expiresDate": "2025-09-25T15:08:12.278Z",
    "type": "DYNAMIC",
    "correlationID": "3f2a2690-8224-4aae-a1ba-ed26d4d61f81",
    "paymentLinkID": "788c8d0d-182b-468e-942e-546be6a621c2",
    "createdAt": "2025-09-24T15:07:47.334Z",
    "updatedAt": "2025-09-24T15:08:13.578Z",
    "customer": {
      "name": "Cliente Teste",
      "taxID": {
        "taxID": "44720743000101",
        "type": "BR:CNPJ"
      },
      "correlationID": "ecd41c3b-487c-4719-b9f7-53b6dd6759cb"
    },
    "paidAt": "2025-09-24T15:07:50.891Z",
    "payer": null,
    "ensureSameTaxID": false,
    "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/d983a07836cf48ed9a65764d3c18427352040000530398654040.015802BR5921Lucas_Aprigio_Sandbox6009Sao_Paulo62290525d983a07836cf48ed9a65764d363046759",
    "expiresIn": 86424,
    "pixKey": "67856db0-ac6e-4276-8309-503a22a896dc",
    "paymentLinkUrl": "https://woovi-sandbox.com/pay/788c8d0d-182b-468e-942e-546be6a621c2",
    "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/788c8d0d-182b-468e-942e-546be6a621c2.png",
    "globalID": "Q2hhcmdlOjY4ZDQwOTQzMDY5YTI4ZjgzMTEzOTVkZA==",
    "paymentMethods": {
      "pix": {
        "method": "PIX_COB",
        "txId": "d983a07836cf48ed9a65764d3c184273",
        "value": 1,
        "status": "COMPLETED",
        "fee": 85,
        "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/d983a07836cf48ed9a65764d3c18427352040000530398654040.015802BR5921Lucas_Aprigio_Sandbox6009Sao_Paulo62290525d983a07836cf48ed9a65764d363046759",
        "transactionID": "d983a07836cf48ed9a65764d3c184273",
        "identifier": "d983a07836cf48ed9a65764d3c184273",
        "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/788c8d0d-182b-468e-942e-546be6a621c2.png"
      }
    }
  },
  "pix": {
    "customer": {
      "name": "Cliente Teste",
      "taxID": {
        "taxID": "44720743000101",
        "type": "BR:CNPJ"
      },
      "correlationID": "ecd41c3b-487c-4719-b9f7-53b6dd6759cb"
    },
    "payer": {
      "name": "Cliente Teste",
      "taxID": {
        "taxID": "44720743000101",
        "type": "BR:CNPJ"
      },
      "correlationID": "ecd41c3b-487c-4719-b9f7-53b6dd6759cb"
    },
    "charge": {
      "value": 1,
      "comment": "",
      "identifier": "d983a07836cf48ed9a65764d3c184273",
      "transactionID": "d983a07836cf48ed9a65764d3c184273",
      "status": "COMPLETED",
      "additionalInfo": [],
      "fee": 85,
      "discount": 0,
      "valueWithDiscount": 1,
      "expiresDate": "2025-09-25T15:08:12.278Z",
      "type": "DYNAMIC",
      "correlationID": "3f2a2690-8224-4aae-a1ba-ed26d4d61f81",
      "paymentLinkID": "788c8d0d-182b-468e-942e-546be6a621c2",
      "createdAt": "2025-09-24T15:07:47.334Z",
      "updatedAt": "2025-09-24T15:08:13.578Z",
      "customer": {
        "name": "Cliente Teste",
        "taxID": {
          "taxID": "44720743000101",
          "type": "BR:CNPJ"
        },
        "correlationID": "ecd41c3b-487c-4719-b9f7-53b6dd6759cb"
      },
      "paidAt": "2025-09-24T15:07:50.891Z",
      "payer": null,
      "ensureSameTaxID": false,
      "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/d983a07836cf48ed9a65764d3c18427352040000530398654040.015802BR5921Lucas_Aprigio_Sandbox6009Sao_Paulo62290525d983a07836cf48ed9a65764d363046759",
      "expiresIn": 86424,
      "pixKey": "67856db0-ac6e-4276-8309-503a22a896dc",
      "paymentLinkUrl": "https://woovi-sandbox.com/pay/788c8d0d-182b-468e-942e-546be6a621c2",
      "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/788c8d0d-182b-468e-942e-546be6a621c2.png",
      "globalID": "Q2hhcmdlOjY4ZDQwOTQzMDY5YTI4ZjgzMTEzOTVkZA=="
    },
    "value": 1,
    "time": "2025-09-24T15:07:50.891Z",
    "endToEndId": "Efa8df7c628cf43d2af424696ea0c6444",
    "transactionID": "d983a07836cf48ed9a65764d3c184273",
    "infoPagador": "OpenPix testing",
    "status": "CONFIRMED",
    "type": "PAYMENT",
    "createdAt": "2025-09-24T15:07:50.915Z",
    "globalID": "UGl4VHJhbnNhY3Rpb246NjhkNDA5NDYwNjlhMjhmODMxMTM5NjU4"
  },
  "company": {
    "id": "6810ce3b892866f103d77ef2",
    "name": "Lucas Aprigio Sandbox",
    "taxID": "57437573000102"
  },
  "account": {
    "environment": "TESTING"
  }
}