Create Dynamic PIX QR Code for Immediate Payment

The dynamic QR Code for immediate payment is used for payments with a short payment term, usually processed in seconds, for routine payment collection operations.

Request

Request Body: Dynamic PIX QR Code for Immediate Payment

{
  "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
  "qr_code_type": "dynamic_instant",
  "amount": 22.34,
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "payer_document_number": "00000000000000",
  "payer_name": "Random",
  "payer_request": "Payment for order XXXXXXXXXX",
  "pix_key": "3d7d6a2b-f72f-44z7-bb20-79a94dff5645",
  "expiration_seconds": 864000,
  "additional_data": [
    {
      "key_name": "identificacao_venda",
      "value": "Venda número 123 na plataforma"
    }
  ],
}

Body Params

Field	Type	Description	Characters
request_control_key *	string	Unique UUID4 identifier of the request.	-
qr_code_type *	string	Type of the dynamic QR Code. "dynamic_term" or "dynamic_instant"	-
amount *	float	QR Code amount before calculating discounts or interest and fines.	-
receiver_conciliation_id *	string	QR Code identifier for reconciliation after payment.	-
payer_document_number *	string	Payer's CPF/ CNPJ.	-
payer_name *	string	Payer's name.	-
payer_request *	string	Message to the payer.	-
pix_key *	string	PIX key representing the destination account of the transaction.	-
expiration_seconds	string	Indicates the validity time of the QR Code in seconds, default is 1 day	-
additional_data	array of objects	Information to be presented to the payer.	-

Object additional_data

Field	Type	Description	Characters
key_name *	string	Name of the field	-
value	string	Value of the field	-

Response

STATUS

201 Created

Response Body: Create Dynamic PIX QR Code for Immediate Payment

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "created_at": "2023-03-03T12:04:06.179Z",
}

Field	Type	Description	Characters
request_control_key *	string	Unique UUID4 identifier of the request.	-
qr_code_key *	string	QR Code identifier for future requests.	-
qr_code_status *	string	QR Code status in the system.	"active": default for creation.
base_64_payload *	string	URL of the QR Code for payment in base64.	-
created_at *	datetime	Date and time the QR Code was created in the system.	-

Object qr_code_status

Field	Type	Description	Characters
active	string	QR Code is active and available for payment.	-
finished	string	QR Code has been paid.	-
written_off	string	QR Code has been canceled by the client.	-
bank_written_off	string	QR Code was automatically canceled due to expiration.	-

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"
}