Realizar pagamento PIX via QR Code (Cash-Out QR Code)
Envia um pagamento PIX a partir de um QR Code escaneado ou copiado (copia-e-cola). O QR Code deve seguir o padrão EMV PIX do Banco Central.
Requer token Bearer no header Authorization.
| Campo | Tipo | Obrigatório | Descrição |
|---|
value | number | Sim | Valor do pagamento em reais (até 2 casas decimais). Deve corresponder ao valor embutido no QR Code, quando presente |
qrCode | string | Sim | Conteudo do QR Code PIX (string EMV). Min 50, max 500 caracteres. Deve iniciar com 000201 |
externalId | string | Sim | Identificador externo único para a transação |
description | string | Não | Descrição opcional do pagamento |
name | string | Não | Nome do destinatário (pode estar embutido no QR Code) |
document | string | Não | CPF ou CNPJ do destinatário (pode estar embutido no 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"
}
| Campo | Tipo | Descrição |
|---|
transactionId | string | Identificador interno da transação gerada |
externalId | string | Identificador externo informado na requisição |
status | string | Status atual da transação (PENDING, CONFIRMED, ERROR) |
generateTime | string | Data/hora de geração da transação (ISO 8601) |
{
"transactionId": "456",
"externalId": "QRPAY-987654-20240119",
"status": "PENDING",
"generateTime": "2024-01-19T14:30:00.000Z"
}
| Status | Descrição |
|---|
| 400 | Dados inválidos, QR Code inválido, valor divergente ou saldo insuficiente |
| 401 | Token não fornecido ou inválido |
| 409 | externalId já utilizado em outra transação |
| 500 | Erro ao processar pagamento PIX via QR Code |
