Obter QR Code
Retorna o QR Code da cobrança PIX no formato solicitado: base64 (imagem), SVG (vetor) ou url (string PIX/copia-e-cola).
Overview
Use após criar a cobrança com Gerar cobrança PIX. Substitua pixId pelo ID retornado. url devolve a string PIX; base64 e svg devolvem representação do QR.
Endpoint
GETGET /pix/{pixId}/qrcode
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Path Parameters
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| pixId | string | Sim | ID da cobrança PIX retornado em POST /pix. |
Query Parameters
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| format | string | Não | Formato do retorno do QR Code. Define como o valor PIX (copia-e-cola) é devolvido.Padrão: url. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/pix/pix_xyz789/qrcode?format=base64" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"format": "url",
"value": "00020126580014br.gov.bcb.pix..."
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| format | string | Formato retornado: url (string PIX), base64 (imagem), svg (vetor). |
| value | string | Conteúdo: em url é a string PIX; em base64/svg é a representação do QR. |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | Cobrança PIX não encontrada ou ID inválido. |
| 401 | INVALID_API_KEY | Chave de API inválida ou ausente. |
Exemplo de resposta de erro
JSON
{
"code": "RESOURCE_NOT_FOUND",
"message": "Cobrança PIX não encontrada."
}