POST /transactions cria uma cobrança Pix. A resposta traz o QR Code em base64 e o código Copia e Cola, e você mostra os dois ao pagador. Quando ele paga, a NyxPag avisa por webhook.
O que enviar
Hoje o pagador precisa ser pessoa física: o campo
payer.document valida CPF. Para uma venda a uma empresa, informe o CPF do responsável.Criar a cobrança
A resposta
201 Created
fee e netAmount são ilustrativos: a tarifa real depende da sua conta. Todos os campos estão descritos em Ciclo de vida.
Códigos de resposta
Mostrar o Pix ao pagador
qrCodeBase64vem sem o prefixodata:image. Monte osrccomo acima.- Use o
copyPasteexatamente como veio. Qualquer espaço ou quebra de linha invalida o código. - A cobrança vale 15 minutos (
expiresAt). Passado esse prazo ela é cancelada, e você recebetransaction.cancelledcomexpired: true. Mostre uma contagem regressiva e ofereça gerar um novo Pix.
Confirmar o pagamento
1
Pelo webhook (recomendado)
A NyxPag envia
transaction.approved assim que o Pix é pago. Veja transaction.*.2
Pela consulta (fallback)
GET /transactions/{id}?refresh=true com o id ou o seu externalId. Use com moderação, porque gasta a cota de 100 requisições por minuto.coverFee
coverFee decide quem paga a tarifa da NyxPag.
Exemplo com tarifa ilustrativa de R$ 0,50 e sem split: com
false o pagador paga R$ 149,90 e você recebe R$ 149,40. Com true o pagador paga R$ 150,40 e você recebe R$ 149,90.
Se você combina
coverFee: true com split, crie uma cobrança de R$ 1,00 e confira amount, fee, splitAmount e netAmount na resposta antes de usar em produção.Erros comuns
Dividir o valor (split)
Repasse parte da venda a outras contas NyxPag.
Criar cobrança Pix
Referência completa do endpoint.

