Search for own dynamic Pix QR Code

Request

ENDPOINT

/baas/qrcode/dynamic

METHOD

GET

Path params

Field	Type	Description	Characters
account_key	string	QIAccount identification key linked to the Pix key (UUIDv4)	36
pix_key	string	PIX key linked to the QRCode	-
receiver_conciliation_id	string	Receiver's reconciliation ID	max_length = 35
page	integer	Page number being searched (default = 0)	-
page_size	integer	Number of items per page (default = 15)	-
first_result	boolean	Return only the first result (default = desc)	-
order_by	string	Determines the order of return of results (default = desc)	asc, desc

info

It is mandatory to send account_key or pix_key, only one of them is required.

Attention

To query a specific QR Code, the parameters receiver_conciliation_id and pix_key should be used.

Response

STATUS

200

Response Body

{
	"pagination": {
		"current_page": 0,
		"next_page": 1,
		"rows_per_page": 15,
		"total_pages": 1,
		"total_rows": 4
	},
	"data": [
		{
			"additional_data": [],
			"amount": 1.0,
			"discounts": [],
			"qr_code_type": "dynamic_term",
			"end_to_end_id": null,
			"base_64": "MDAwMjAxMjY4OTAwMTRici5nb3YuYmNiLnBpeDI1NjdxcmNvZGUtaC5kZXYucWl0ZWNoLmFwcC9iYWNlbi9jb2J2LzQ1NWQ4ZmY1NGE0ZDQ2Mzg4YmVhN2I4MmFhMDZiNzdmNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkxOVBydVBydXVDb211bmljYWNvZXM2MDA4i2FvUGF1bG82MTA4MDU0MjUwMjA2MjA3MDUwMyoqKjYzMDQyNkNF",
			"expiration_date": "2023-03-30",
			"expiration_seconds": null,
			"max_payment_days": 180,
			"rebate_amount": 0.0,
			"interest_amount": 0.0,
			"fine_amount": 0.0,
			"paid_amount": null,
			"payer_request": null,
			"pix_message": null,
			"modality_alteration": false,
			"payer_name": "Random",
			"payer_document_number": "00000000000000",
			"payer_person_type": "natural",
			"pix_key": {
				"account_key": "ce0db38f-a2ba-446f-bb1a-51d0bf3f40fc",
				"is_activated": true,
				"pix_key": "63602991000100",
				"created_at": "2023-02-14T23:26:52"
			},
			"qr_code_key": "455d8ff5-4a4d-4638-8bea-7b82aa06b77f",
			"qr_code_status": {
				"enumerator": "active"
			},
			"receiver_conciliation_id": "01234567891293134978",
			"created_at": "2023-03-29T15:26:50"
		}
	]
}

STATUS

400

Response Body: Missing Required Parameters

{
    "title": "Bad Request",
    "description": "Must use pix key or account key to search for QR Codes",
    "translation": "Chave Pix ou Chave da Conta devem ser utilizados para realizar buscas por QR Codes",
    "code": "PQR000009"
}

STATUS

400

Response Body: User does not have credentials

{
    "title": "Unauthorized",
    "description": "User is not allowed to do this transaction",
    "translation": "Usuário não tem autorização para fazer essa transação",
    "code": "PQR000004"
}

STATUS

400

Response Body: User is not the account owner

{
    "title": "Unauthorized",
    "description": "Person is not account owner.",
    "translation": "A pessoa não é dona da conta.",
    "code": "PQR000005"
}

STATUS

404

Response Body: Pix Key not found

{
    "title": "Not Found",
    "description": "No active Pix key found with key \{pix_key\}",
    "translation": "Não foi encontrada pix key ativa com a chave \{pix_key\}",
    "code": "PQR000007"
}

Enumeradtors QR Code Status

Enumerator	Description
active	Active QR Code
finished	Paid QR Code
written_off	QR Code deactivated at the request of the receiver/partner
bank_written_off	QR Code deactivated by QI