Consultar QrCode - Código Referência

Retorna de forma mais detalhada os dados de uma cobrança. Para fazê-lo deve ser efetuada a chamada para o serviço de consulta de QrCode, enviando como parâmetros o identificador único (reference_code).

A chamada deverá ser feita utilizando o método GET.

URL

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

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

{
    "reference_code": "PAY2MPIXQRCODE2",
    "external_reference": "INVOICE01",
    "value": 2,
    "content":
"00020101021126580014br.gov.bcb.pix0136d5091c68-5056-481b-88ad-95eb340a1a2152040000530398654040025802BR5925Pay2m Solutions62220518PAY2MPIXQRCODE263044FC9",
    "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"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
reference_code (Obrigatório)	Identificador único do QrCode.	STRING limite de 100 caracteres
external_reference (Opcional)	Identificador fornecido pelo parceiro	STRING limite de 100 caracteres
content (Obrigatório)	Conteúdo do QrCode. (Código copia e cola PIX)	STRING limite de 255 caracteres
value (Obrigatório)	Valor da cobrança, em reais	DECIMAL Maior que zero
status (Obrigatório)	Status da cobrança	ENUM expired (Cobrança expirada) awaiting_payment (Aguardando pagamento) paid (Pago) canceled(Cancelado)
generator_name (Opcional)	Nome do gerador	STRING limite de 100 caracteres
generator_document (Opcional)	Documento do gerador	STRING limite de 14 caracteres
payer_name (Opcional)	Nome do pagador	STRING limite de 100 caracteres
payer_document (Opcional)	Documento do pagador	STRING limite de 100 caracteres
payment_date (Opcional)	Data de pagamento da cobrança	STRING formato datetime YYYY-mm-ddTHH:MM:ss. z
end_to_end (Opcional)	Identificador único do pagamento PIX.	STRING limite de 32 caracteres

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 404 Response Body - Exemplo

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