Consult QrCode - Reference Code

Returns billing data in more detail. To do so it must be the call to the QrCode query service is made, sending as parameters the unique identifier (reference_code).

The call must be made using the GET method.

URL

{BaseUrl}/api/v1/pix/qrcode/{reference_code}

If successful, a HTTP 200 – OK message will be returned, containing the data, as shown below:

HTTP 200 Response Body - Example

{
     "reference_code": "PAY2MPIXQRCODE2",
     "external_reference": "INVOICE01",
     "value": 2,
     "content":
"00020101021126580014br.gov.bcb.pix0136d5091c68-5056-481b-88ad-95eb340a1a2152040000530398654040025802BR5925Pay2m Solutions62220518PAY2MPIXQRCODE26 3044FC9",
     "status": "paid",
     "generator_name": "John Doe",
     "generator_document": "67178678097",
     "payer_name": "John Doe",
     "payer_document": "67178678097",
     "payment_date": "2021-11-10T14:52:10.000-03:00",
     "end_to_end": "E18236120202206142202a1022c1tg10"
}

Description of Attributes

ATTRIBUTE	DESCRIPTION	TYPE
reference_code (Required)	Unique QrCode identifier.	STRING 100 character limit
external_reference (Optional)	Partner-provided identifier	STRING 100 character limit
content (Required)	QrCode content. (Copy and paste PIX code)	STRING 255 character limit
value (Required)	Charge amount, in reais	DECIMAL Greater than zero
status (Required)	Billing status	ENUM expired awaiting_payment paid **canceled **(Cancelled)
generator_name (Optional)	Generator name	STRING 100 character limit
generator_document (Optional)	Generator Document	STRING 14 character limit
payer_name (Optional)	Payer name	STRING 100 character limit
payer_document (Optional)	Payer document	STRING 100 character limit
payment_date (Optional)	Charge payment date	STRING datetime format YYYY-mm-ddTHH:MM:ss. z
end_to_end (Optional)	Unique PIX payment identifier.	STRING 32 character limit

In case of errors, a json will be returned with the error attribute specifying the reason why the operation was invalidated.

HTTP 404 Response Body - Example

{
     "error": "Qrcode not found."
}