LYNX UPBANK
DocsReferência da APICriar PIX QR Code
1 min de leitura

Criar PIX QR Code

POST/v1/pixQrCode/create

Gera um QR Code dinâmico e um código copia-e-cola para receber um pagamento via PIX. O valor cai na sua conta LYNX no instante do pagamento, com confirmação por webhook assinado.

Permissão necessária: PIX:CREATE

Parâmetros

ParâmetroTipoDescrição
amountCentsobrig.integerValor em centavos (ex.: 4990 = R$ 49,90). Mínimo 200 (R$ 2,00).
descriptionstringDescrição exibida ao pagador.
passFeebooleanSe true, a taxa é somada ao valor que o pagador paga (você recebe o valor cheio).
expiresInintegerValidade do QR em segundos. Padrão 3600.
customerobjectDados do pagador: name, email, cellphone, taxId.
metadataobjectObjeto livre devolvido nos webhooks e consultas.

Boas práticas

  • Guarde o id retornado, é ele que identifica a cobrança nos webhooks e nas consultas.
  • Use metadata para correlacionar a cobrança com o pedido do seu sistema (ex.: { orderId: 123 }).
  • Confirme o pagamento pelo webhook pixQrCode.paid; a consulta de status é só reforço.
  • Defina um expiresIn realista para o seu checkout, evita QR pago depois do pedido expirar.

Requisição

bash
curl -X POST https://lynxpix.cc/api/v1/pixQrCode/create \
  -H "Authorization: Bearer lynx_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":4990,"description":"Pedido #1234","customer":{"name":"João Silva"}}'

Resposta

json
{
  "data": {
    "id": "chg_9f8a2c1e",
    "kind": "pixQrCode",
    "status": "PENDING",
    "amount": 4990,
    "netAmount": 4960,
    "brCode": "00020126850014br.gov.bcb.pix...6304AB12",
    "brCodeBase64": "data:image/png;base64,iVBORw0KG...",
    "devMode": true,
    "expiresAt": "2026-07-01T13:00:00Z",
    "createdAt": "2026-07-01T12:00:00Z"
  },
  "error": null
}