Pular para o conteúdo principal
POST
/
api
/
pix
/
cash-in
Gerar cobrança PIX (Cash-In)
curl --request POST \
  --url https://api.public.firebanking.com.br/api/pix/cash-in \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction": {
    "value": 0.05,
    "description": "Cobrança de teste",
    "externalId": "external-teste-01",
    "expirationTime": 86400,
    "generateQrCode": true
  },
  "payer": {
    "fullName": "John Marvin",
    "document": "12312312387"
  },
  "additionalInfo": {
    "key1": "value1",
    "orderId": "ORD-12345"
  }
}
'
{
  "transactionId": "123",
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "external-teste-01",
  "status": "PENDING",
  "pixCode": "00020126580014br.gov.bcb.pix...",
  "generateTime": "2024-01-15T10:30:00.000Z",
  "expirationDate": "2024-01-16T10:30:00.000Z",
  "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}

Autorizações

​
Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
​
transaction
object
obrigatório

Dados da transação

​
payer
object
obrigatório

Dados do pagador

​
additionalInfo
object

Informações adicionais (objeto chave-valor string:string, máximo 10 chaves)

Exemplo:
{ "key1": "value1", "orderId": "ORD-12345" }

Resposta

Cobrança PIX gerada com sucesso

​
transactionId
string
obrigatório

Identificador único da transação gerada

Exemplo:

"123"

​
correlationId
string
obrigatório

ID de correlação da transação (UUID)

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
externalId
string
obrigatório

ID externo da transação (mesmo valor do input)

Exemplo:

"external-teste-01"

​
status
enum<string>
obrigatório

Status da transação

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

"PENDING"

​
pixCode
string
obrigatório

Código Pix no formato padrão EMV

Exemplo:

"00020126580014br.gov.bcb.pix..."

​
generateTime
string
obrigatório

Data e hora de geração do Pix (formato ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"

​
expirationDate
string
obrigatório

Data e hora de expiração do Pix (formato ISO 8601)

Exemplo:

"2024-01-16T10:30:00.000Z"

​
qrCodeImage
string

QR Code em Base64 (apenas quando generateQrCode=true)

Exemplo:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."