Generate new dynamic QR Code
POST/api/transaction/generate_qr_code_pix
Generates a new dynamic QR Code.
Request
- application/json
Body
required
value doublerequired
Value to be paid
description description (string)required
Description of the transaction
client_name client_name (string)required
Name of the person whose charge is being designed to
client_email client_email (string)
Email of the person whose charge is being designed to
client_document client_document (string)required
Document of the person whose charge is being designed to
merchant_id merchant_id (string)required
Reference of the store that solicitate the QrCode
expiration_date expiration_date (string)
UTC date informing when the QrCode is going to expire
Responses
- 201
- 400
- 401
- 403
- 408
- 500
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
code code (integer)
Possible values: [200
, 422
, 404
, 408
, 500
]
Response code
status status (string)
Possible values: [pending
, failed
]
Transaction status
message message (string)
Message about the request
qr_code qr_code (string)
PIX EMV QrCode
transaction_uuid transaction_uuid (string)
Reference of the QrCode for conciliation
merchant_id merchant_id (string)required
Reference of the store that solicitate the QrCode
{
"code": "200",
"status": "pending",
"message": null,
"qr_code": "00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927",
"transaction_uuid": "7da0c9af-215e-4625-b484-b8cfc87aaa09",
"merchant_id": "271e4016-47de-45e0-9340-6f2560ce3a90"
}
Bad Request
Unauthenticated
- application/json
- Schema
- Example (from schema)
Schema
message message (integer)
Response 401
{
"message": "Invalid x-api-key"
}
Forbidden
Request timeout
Error
Loading...