Criar cobrança PIX
createPixChargeCreate a PIX charge on ZuckPay and receive a copy-paste code, QR code image, and hosted checkout link. Supports idempotency, revenue splits, webhook confirmation, and tracking parameters.
Instructions
Cria uma cobrança PIX na ZuckPay e retorna o código copia-e-cola, a imagem do QR Code e o link de checkout hospedado. Suporta idempotência (external_id_client), split de receita entre contas, webhook de confirmação (urlnoty) e parâmetros de rastreio (UTMs). Valor em reais com até 2 casas decimais.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cpf | Yes | CPF do pagador (11 dígitos; pontuação é removida automaticamente) | |
| fbc | No | Parâmetro de rastreio fbc (opcional) | |
| fbp | No | Parâmetro de rastreio fbp (opcional) | |
| sck | No | Parâmetro de rastreio sck (opcional) | |
| src | No | Parâmetro de rastreio src (opcional) | |
| nome | Yes | Nome completo do pagador | |
| Yes | E-mail do pagador | ||
| gclid | No | Parâmetro de rastreio gclid (opcional) | |
| kclid | No | Parâmetro de rastreio kclid (opcional) | |
| valor | Yes | Valor da cobrança em reais (ex: 49.90). Atenção: algumas adquirentes exigem mínimo de R$ 10,00 — a API recusa se for o caso. | |
| fbclid | No | Parâmetro de rastreio fbclid (opcional) | |
| gbraid | No | Parâmetro de rastreio gbraid (opcional) | |
| splits | No | Divisão de receita entre contas ZuckPay (2 a 10 recebedores; soma dos percentuais = 100). Calculada sobre o valor líquido. | |
| ttclid | No | Parâmetro de rastreio ttclid (opcional) | |
| wbraid | No | Parâmetro de rastreio wbraid (opcional) | |
| urlnoty | No | URL https do seu sistema que receberá o postback (webhook) quando o pagamento for confirmado | |
| click_id | No | Parâmetro de rastreio click_id (opcional) | |
| telefone | Yes | Telefone do pagador com DDD (ex: 11999998888) | |
| utm_term | No | Parâmetro de rastreio utm_term (opcional) | |
| descricao | No | Descrição/motivo do pagamento (até 255 caracteres) | |
| product_id | No | ID de um produto cadastrado na conta ZuckPay (vincula a transação ao produto) | |
| utm_medium | No | Parâmetro de rastreio utm_medium (opcional) | |
| utm_source | No | Parâmetro de rastreio utm_source (opcional) | |
| utm_content | No | Parâmetro de rastreio utm_content (opcional) | |
| utm_campaign | No | Parâmetro de rastreio utm_campaign (opcional) | |
| external_id_client | No | ID externo do seu sistema (ex: ORDER-123). Garante idempotência: repetir o mesmo ID retorna a mesma cobrança pendente. |