Pular para o conteúdo principal
POST
/
api
/
pix
/
cash-out-qrcode
Realizar pagamento PIX via QR Code (Cash-Out QR Code)
curl --request POST \
  --url https://api.public.firebanking.com.br/api/pix/cash-out-qrcode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 15.5,
  "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": "Destinatario Ltda",
  "document": "12345678000190"
}
'
{
  "transactionId": "456",
  "externalId": "QRPAY-987654-20240119",
  "status": "PENDING",
  "generateTime": "2024-01-19T14:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.firebanking.dev/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
​
value
number
obrigatório

Valor do pagamento em reais (até duas casas decimais). Deve corresponder ao valor embutido no QR Code, quando presente.

Exemplo:

15.5

​
qrCode
string
obrigatório

Conteúdo do QR Code PIX (string EMV). Mínimo 50 caracteres, máximo 500. Deve iniciar com '000201'.

Required string length: 50 - 500
Exemplo:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540515.505802BR5925DESTINATARIO LTDA6009SAO PAULO62070503***6304ABCD"

​
externalId
string
obrigatório

Identificador externo único para a transação

Exemplo:

"QRPAY-987654-20240119"

​
description
string

Descrição opcional do pagamento

Exemplo:

"Pagamento fornecedor XYZ via QR Code"

​
name
string

Nome do destinatário (opcional, pode estar embutido no QR Code)

Exemplo:

"Destinatario Ltda"

​
document
string

CPF ou CNPJ do destinatário (opcional, pode estar embutido no QR Code)

Exemplo:

"12345678000190"

Resposta

Pagamento PIX via QR Code iniciado com sucesso

​
transactionId
string
obrigatório

Identificador interno da transação gerada

Exemplo:

"456"

​
externalId
string
obrigatório

Identificador externo informado na requisição

Exemplo:

"QRPAY-987654-20240119"

​
status
enum<string>
obrigatório

Status atual da transação

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"PENDING"

​
generateTime
string
obrigatório

Data/hora de geração da transação (ISO 8601)

Exemplo:

"2024-01-19T14:30:00.000Z"