# API da OpenPIX
 A API do OpenPIX tem duas URL base uma de teste `ttps://api.woovi-sandbox.com` e uma de produção `https://api.woovi.com`. Vamos ter a opção de usar como teste ou produção.
## Criar nova cobrança
### Requisição
```cURL
curl --request POST \
  --url {{baseUrl}}/api/v1/charge \
  --header 'accept: application/json' \
  --header 'Authorization: {{apiKey}}' \
  --header 'content-type: application/json' \
  --data '{
  "correlationID": "1234567", // Com esta string vai ser possivel identificar atraves do webhook
  "value": "100", // Em centavos
  "comment": "Mensalidade Sistema mes de janeiro de 2025",
  "customer": {
    "name": "Jorge Fernando dos Santos",
    "phone": "5511999999999"
    }
}'
```

### Resposta
```json
{
  "charge": {
    "customer": {
      "name": "Jorge Fernando dos Santos",
      "phone": "+5511999999999",
      "correlationID": "4986f358-ccfa-42c7-9619-5e87b828922f"
    },
    "value": "100",
    "comment": "Mensalidade Sistema mes de janeiro de 2025",
    "identifier": "2fef441c283b4386aa3c211aee2f051d",
    "correlationID": "1234567",
    "transactionID": "2fef441c283b4386aa3c211aee2f051d",
    "status": "ACTIVE",
    "additionalInfo": [],
    "fee": 50,
    "discount": 0,
    "valueWithDiscount": "100",
    "expiresDate": "2025-12-06T18:26:34.278Z",
    "type": "DYNAMIC",
    "paymentLinkID": "cad6f97c-68e7-4d40-ad13-4ece35a543fd",
    "createdAt": "2025-12-05T18:26:34.305Z",
    "updatedAt": "2025-12-05T18:26:34.305Z",
    "ensureSameTaxID": false,
    "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0",
    "expiresIn": 86400,
    "pixKey": "f00161aa-f2b9-444a-8395-25e75b5a3c79",
    "paymentLinkUrl": "https://woovi-sandbox.com/pay/cad6f97c-68e7-4d40-ad13-4ece35a543fd",
    "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/cad6f97c-68e7-4d40-ad13-4ece35a543fd.png",
    "globalID": "Q2hhcmdlOjY5MzMyM2RhYjQ1NDM4NmI5YTU3Y2ViMA==",
    "paymentMethods": {
      "pix": {
        "method": "PIX_COB",
        "txId": "2fef441c283b4386aa3c211aee2f051d",
        "value": "100",
        "status": "ACTIVE",
        "fee": 50,
        "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0",
        "transactionID": "2fef441c283b4386aa3c211aee2f051d",
        "identifier": "2fef441c283b4386aa3c211aee2f051d",
        "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/cad6f97c-68e7-4d40-ad13-4ece35a543fd.png"
      }
    }
  },
  "correlationID": "1234567",
  "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0"
}
```

## Webhook
```json
{
      "event": "OPENPIX:CHARGE_COMPLETED",
      "charge": {
        "customer": {
          "name": "Jorge Fernando dos Santos",
          "phone": "+5511999999999",
          "correlationID": "4986f358-ccfa-42c7-9619-5e87b828922f"
        },
        "value": "100",
        "comment": "Mensalidade Sistema mes de janeiro de 2025",
        "identifier": "2fef441c283b4386aa3c211aee2f051d",
        "correlationID": "1234567", // String unica pata identificar a transação
        "transactionID": "2fef441c283b4386aa3c211aee2f051d",
        "status": "COMPLETED",
        "additionalInfo": [],
        "fee": 50,
        "discount": 0,
        "valueWithDiscount": "100",
        "expiresDate": "2025-12-06T18:26:34.278Z",
        "type": "DYNAMIC",
        "paymentLinkID": "cad6f97c-68e7-4d40-ad13-4ece35a543fd",
        "createdAt": "2025-12-05T18:26:34.305Z",
        "updatedAt": "2025-12-05T18:36:57.016Z",
        "paidAt": "2025-12-05T18:36:56.957Z",
        "payer": null,
        "ensureSameTaxID": false,
        "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0", // Cdogi copia e cola
        "expiresIn": 86400,
        "pixKey": "f00161aa-f2b9-444a-8395-25e75b5a3c79",
        "paymentLinkUrl": "https://woovi-sandbox.com/pay/cad6f97c-68e7-4d40-ad13-4ece35a543fd",
        "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/cad6f97c-68e7-4d40-ad13-4ece35a543fd.png", // QRcode
        "globalID": "Q2hhcmdlOjY5MzMyM2RhYjQ1NDM4NmI5YTU3Y2ViMA==",
        "paymentMethods": {
          "pix": {
            "method": "PIX_COB",
            "txId": "2fef441c283b4386aa3c211aee2f051d",
            "value": "100",
            "status": "COMPLETED",
            "fee": 50,
            "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0",
            "transactionID": "2fef441c283b4386aa3c211aee2f051d",
            "identifier": "2fef441c283b4386aa3c211aee2f051d",
            "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/cad6f97c-68e7-4d40-ad13-4ece35a543fd.png"
          }
        }
      },
      "pix": {
        "customer": {
          "name": "Jorge Fernando dos Santos",
          "phone": "+5511999999999",
          "correlationID": "4986f358-ccfa-42c7-9619-5e87b828922f"
        },
        "payer": {
          "name": "Cliente Teste",
          "taxID": {
            "taxID": "44720743000101",
            "type": "BR:CNPJ"
          },
          "correlationID": "633a3bcf-0731-47e9-86f6-3cbf53b82be1"
        },
        "charge": {
          "customer": {
            "name": "Jorge Fernando dos Santos",
            "phone": "+5511999999999",
            "correlationID": "4986f358-ccfa-42c7-9619-5e87b828922f"
          },
          "value": "100",
          "comment": "Mensalidade Sistema mes de janeiro de 2025",
          "identifier": "2fef441c283b4386aa3c211aee2f051d",
          "correlationID": "1234567",
          "transactionID": "2fef441c283b4386aa3c211aee2f051d",
          "status": "COMPLETED",
          "additionalInfo": [],
          "fee": 50,
          "discount": 0,
          "valueWithDiscount": "100",
          "expiresDate": "2025-12-06T18:26:34.278Z",
          "type": "DYNAMIC",
          "paymentLinkID": "cad6f97c-68e7-4d40-ad13-4ece35a543fd",
          "createdAt": "2025-12-05T18:26:34.305Z",
          "updatedAt": "2025-12-05T18:36:57.016Z",
          "paidAt": "2025-12-05T18:36:56.957Z",
          "payer": null,
          "ensureSameTaxID": false,
          "brCode": "00020101021226980014br.gov.bcb.pix2576api.woovi-sandbox.com/api/testaccount/qr/v1/2fef441c283b4386aa3c211aee2f051d52040000530398654041.005802BR5907Velmont6009Sao_Paulo622905252fef441c283b4386aa3c211ae6304A5C0",
          "expiresIn": 86400,
          "pixKey": "f00161aa-f2b9-444a-8395-25e75b5a3c79",
          "paymentLinkUrl": "https://woovi-sandbox.com/pay/cad6f97c-68e7-4d40-ad13-4ece35a543fd",
          "qrCodeImage": "https://api.woovi-sandbox.com/openpix/charge/brcode/image/cad6f97c-68e7-4d40-ad13-4ece35a543fd.png",
          "globalID": "Q2hhcmdlOjY5MzMyM2RhYjQ1NDM4NmI5YTU3Y2ViMA=="
        },
        "value": 100,
        "time": "2025-12-05T18:36:56.957Z",
        "endToEndId": "E99bfe47878ac4f25a35d9497220a502b",
        "transactionID": "2fef441c283b4386aa3c211aee2f051d",
        "infoPagador": "OpenPix testing",
        "status": "CONFIRMED",
        "type": "PAYMENT",
        "createdAt": "2025-12-05T18:36:56.976Z",
        "globalID": "UGl4VHJhbnNhY3Rpb246NjkzMzI2NDhiNDU0Mzg2YjlhNTdkNGY4"
      },
      "company": {
        "id": "68bf03c30c7854e4be56d940",
        "name": "Velmont",
        "taxID": "61857150000100"
      },
      "account": {
        "environment": "TESTING"
      }
    }
```