Consultar um QR Code Pix

É possível buscar um QR Code específico do Alias pela qr_code_key gerada na criação do mesmo. Esse endpoint retornará todas as informações do mesmo, como status, pagamento, eventos.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode/QR_CODE_KEY

MÉTODO

GET

Response

STATUS

200 Ok

Response Body: Geral

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "pix_key": "3d7d6a2b-f72f-44z7-bb20-79a94dff5645",
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "qr_code_type": "dynamic_instant",
  "amount": 22.34,
  "expiration_seconds": 864000,
  "expiration_date": null,
  "max_payment_days": null,
  "payer_name": "João da Silva",
  "payer_document_number": "00000000000000",
  "payer_person_type": "legal",
  "payer_request": "Payment for order XXXXXXXXXXXX",
  "rebate_amount": 1,
  "interest_amount": 2,
  "fine_amount": 3,
  "discounts": [],
  "additional_data": [
    {
      "key_name": "Juros e Multa",
      "value": "Juros 2 ao mes e multa de 1%"
    }
  ],
  "pix_transfer_key": null,
  "paid_amount": null,
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "qr_code_events": [
    {
      "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
      "event_type": "registration",
      "created_at": "2023-03-03T12:04:06.179Z"
    },
    {
      "request_control_key": "cae915c8-1940-43ec-890b-ba1a3a66354c",
      "event_type": "payment",
      "created_at": "2023-03-03T12:04:06.179Z"
    }
  ],
  "created_at": "2023-03-03T12:04:06.179Z"
}

Campo	Tipo	Descrição	Caracteres
request_control_key *	string	Identificador UUID4 único da request que originou o QR Code.	-
pix_key *	string	Chave Pix que representa a conta de destino da transação.	-
receiver_conciliation_id *	string	Identificador do QR Code para conciliação após o pagamento.	-
qr_code_key *	string	Chave UUID4 identificadora do QR Code.	-
qr_code_status *	string	Status do QR Code.	-
qr_code_type *	string	Tipo do QR Code.	"dynamic_term" ou "dynamic_instant"
amount *	float	Valor do QR Code antes do cálculo de descontos ou juros e multas.	-
expiration_seconds	string	indica qual o tempo de validade do QR Code em segundos, padrão 1 dia.	-
expiration_date	date	Data de vencimento da cobrança (no formato "YYYY-MM-DD").	-
max_payment_days	int32	Dias máximos para pagamento da cobrança após vencimento.	-
payer_name *	string	Nome do pagador.	-
payer_document_number *	string	CPF/ CNPJ do pagador.	-
payer_request *	string	Mensagem ao pagador.	-
rebate_amount	float	Valor absoluto de abatimento antes do pagamento.	-
interest_amount	float	Valor absoluto por dia de atraso após o vencimento, caso seja pago um dia após o vencimento o valor total será o valor ordinario + multa.	-
fine_amount	float	Multa em valor absoluto após o vencimento.	-
discounts	array of objects	Configurações de desconto.	-
additional_data	array of objects	Informações que serão apresentadas para o pagador.	-
pix_transfer_key	string	Chave UUID4 identificadora da transação pix correspondente à liquidação do QR Code.	-
paid_amount	float	Valor do pagamento realizado, considerando multas, descontos e outros.	-
base_64_payload	string	URL do QR Code para pagamento, em base64.	-
qr_code_events	array of objects	Lista de mudanças de status pelas quais o QR Code passou.	-
created_at	datetime	Data e hora que o QR Code foi criado no sistema.	-

Objeto qr_code_status

Campo	Tipo	Descrição	Caracteres
active	string	QR Code se encontra ativo e disponível para pagamento.	-
finished	string	QR Code pago.	-
written_off	string	QR Code foi baixado pelo cliente.	-
bank_written_off	string	QR Code foi baixado automaticamente devido prazo expirado.	-

Objeto discount

Campo	Tipo	Descrição	Caracteres
discount_value *	float	Valor do desconto.	-
discount_number	int32	Ordem que o desconto deve ser aplicado.	-
discount_limit_date	string	Data limite do desconto.	-

Objeto additional_data

Campo	Tipo	Descrição	Caracteres
key_name *	string	Nome do campo	-
value	string	Valor do campo	-

Objeto qr_code_events

Campo	Tipo	Descrição	Caracteres
request_control_key *	string	Identificador UUID4 único da request que originou o event.	-
event_type *	string	Tipo de evento	"registration", "write_off", "payment"
created_at *	datetime	Data e hora que o evento foi criado.	-

STATUS

400

Response Body

{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}

STATUS

404

Response Body: QR Code key não encontrada

{
    "title": "Not found",
    "description": "No Pix QR Code found for qr_code_key {qr_code_key}.",
    "translation": "Não foi encontrado nenhum QR Code com a qr_code_key {qr_code_key}.",
    "code": "QRI000005"
}