Send PIX payment via QR Code (Cash-Out QR Code)
Sends a PIX payment from a scanned or copied QR Code (copy-and-paste). The QR Code must follow the Central Bank EMV PIX standard.
Requires a Bearer token in the Authorization header.
| Field | Type | Required | Description |
|---|
value | number | Yes | Payment amount in BRL (up to 2 decimal places). Must match the amount embedded in the QR Code, when present |
qrCode | string | Yes | PIX QR Code content (EMV string). Min 50, max 500 characters. Must start with 000201 |
externalId | string | Yes | Unique external identifier for the transaction |
description | string | No | Optional payment description |
name | string | No | Recipient name (may be embedded in the QR Code) |
document | string | No | Recipient CPF or CNPJ (may be embedded in the QR Code) |
{
"value": 15.50,
"qrCode": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540515.505802BR5925DESTINATARIO LTDA6009SAO PAULO62070503***6304ABCD",
"externalId": "QRPAY-987654-20240119",
"description": "Pagamento fornecedor XYZ via QR Code",
"name": "Destinatário Ltda",
"document": "12345678000190"
}
| Field | Type | Description |
|---|
transactionId | string | Internal identifier of the generated transaction |
externalId | string | External identifier provided in the request |
status | string | Current transaction status (PENDING, CONFIRMED, ERROR) |
generateTime | string | Transaction generation date/time (ISO 8601) |
{
"transactionId": "456",
"externalId": "QRPAY-987654-20240119",
"status": "PENDING",
"generateTime": "2024-01-19T14:30:00.000Z"
}
| Status | Description |
|---|
| 400 | Invalid data, invalid QR Code, mismatched amount, or insufficient balance |
| 401 | Missing or invalid token |
| 409 | externalId already used in another transaction |
| 500 | Error processing PIX payment via QR Code |
