Pagamento via QR Code (QR Code Pay)

Solicita o pagamento de uma cobrança Pix representada por um QR Code (via seu "hash"/payload).

Método	POST
Path	/api/pix/qrcode/pay
Autenticação	Authorization (Bearer token) + Channel-Id

Autenticação

Exige o header Authorization com um token válido e não expirado, emitido previamente para o integrador. Se ausente, mal formatado, ou o token for inválido/expirado, a API retorna 401 Unauthorized:

{ "error": "Token ausente ou inválido" }

ou

{ "error": "Token inválido" }

Também exige o header Channel-Id: <id_do_canal>. Se ausente, retorna 400 Bad Request:

{ "error": "Channel-Id header is required" }

Corpo da requisição

{
  "hash": "00020126360014BR.GOV.BCB.PIX...",
  "description": "Pagamento de boleto via Pix",
  "additional_data": [
    { "name": "order_id", "value": "12345" }
  ]
}

Campo	Tipo	Obrigatório	Descrição
hash	string	Sim	Payload/"copia e cola" do QR Code Pix a ser pago
description	string	Não	Descrição do pagamento
additional_data	array	Não	Lista de pares name/value (metadados livres). Mesmas regras de validação descritas em Pix Out

Respostas

201 Created — pagamento aceito para processamento:

{ "id": "b3f1c2d4-..." }

400 Bad Request — falha de validação de additional_data, Channel-Id ausente, ou a solicitação foi rejeitada:

{ "message": "<motivo da rejeição>" }

ou, quando a rejeição está associada a uma transação já registrada:

{ "id": "b3f1c2d4-...", "message": "<motivo da rejeição>" }