Guia
PIX
Gere um QR Code dinâmico, mostre o copia e cola e libere o pedido quando o pagamento for confirmado.
1. Crie a cobrança
Informe o valor em centavos e, se quiser, o pagador e o seu externalId. A validade padrão é de 1 hora.
POST /v1/pix/charges
curl -X POST https://api2.bosspay.io/v1/pix/charges \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-1042" \
-d '{ "amount": "15990", "description": "Pedido #1042", "externalId": "1042", "expiresInSeconds": 1800 }'2. Exiba o QR
A resposta traz pix.qrCodeText (copia e cola) e pix.txid. Gere o QR Code a partir do texto ou mostre o código para copiar.
3. Confirme pelo webhook
Assine payment.approved. O corpo traz a transação com status APPROVED, pix.endToEndId e o seu externalId. Cobranças não pagas expiram automaticamente e geram payment.failed com status EXPIRED.
4. Estorne se precisar
Estorno total ou parcial pela rota de transações. Aceita Idempotency-Key.
POST /v1/transactions/:id/refund
curl -X POST https://api2.bosspay.io/v1/transactions/TX_ID/refund \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: estorno-1042" \
-d '{ "amount": "5000", "reason": "Item devolvido" }'Webhooks relevantes
payment.createdpayment.approvedpayment.failedpayment.refundedpix.received