QR Code Payment (QR Code Pay)

Requests payment of a Pix charge represented by a QR Code (via its "hash"/payload).

Method	POST
Path	/api/pix/qrcode/pay
Authentication	Authorization (****** + Channel-Id

Authentication

Requires the Authorization header with a valid, non-expired token, previously issued for the integrator. If missing, malformed, or the token is invalid/expired, the API returns 401 Unauthorized:

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

or

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

Also requires the Channel-Id: <channel_id> header. If missing, it returns 400 Bad Request:

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

Request body

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

Field	Type	Required	Description
hash	string	Yes	Pix QR Code payload ("copy and paste") to be paid
description	string	No	Payment description
additional_data	array	No	List of name/value pairs (free-form metadata). Same validation rules described in Pix Out

Responses

201 Created — payment accepted for processing:

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

400 Bad Request — additional_data validation failure, missing Channel-Id, or the request was rejected:

{ "message": "<rejection reason>" }

or, when the rejection is associated with an already registered transaction:

{ "id": "b3f1c2d4-...", "message": "<rejection reason>" }