Cobrança via PIX

O PIX é o método de pagamento instantâneo ideal para recebimentos imediatos e conciliação automática.

Gerar Cobrança PIX

Este endpoint cria um registro de cobrança e retorna os dados necessários para o pagamento via PIX.

Endpoint

POST /billing/charges

Headers

Header	Valor
Content-Type	application/json
Authorization	Bearer {seu_token}

Parâmetros da Requisição (JSON)

{
    "amount": 5.00,
    "due_date": "2026-12-31",
    "description": "Descrição da cobrança",
    "payment_method": "PIX",
    "name": "Nome do Cliente",
    "document": "12345678901",
    "email": "cliente@email.com",
    "webhook": "https://seu-sistema.com/webhook"
}

---

Resposta de Sucesso (201 Created)

O retorno contém os dados estruturados da cobrança e o código do QR Code no objeto pix.

{
    "data": {
        "id": 247866,
        "amount": 5,
        "code": "gbh4psf05qcotsm69jq13ojmjcpgdci1",
        "description": "Descrição da cobrança",
        "pix": {
            "id": 248499,
            "txid": "c5a9293f-d811-447b-a168-dc31b0537297",
            "qrcode": "00020101021226790014...",
            "amount": 5,
            "status": 0
        },
        "status": {
            "id": 1,
            "title": "pending",
            "description": "Em Aberto"
        },
        "timestamps": {
            "due_date": {
                "iso": "2026-12-31T03:00:00.000000Z",
                "human": "31 de dezembro de 2026"
            },
            "created_at": {
                "iso": "2026-04-10T11:46:19.000000Z"
            }
        }
    }
}

Campos Principais do PIX

• data.pix.qrcode: O código "Copia e Cola" (EMV) para ser usado no aplicativo do banco.
• data.pix.txid: Identificador único da transação PIX.
• data.status.title: Status atual da cobrança (pending, paid, etc).

---

Observações Técnicas

• Documento: Deve ser enviado sem pontos ou traços (apenas números).
• Webhook: Certifique-se de que sua URL de webhook esteja preparada para receber o JSON de notificação.