Skip to main content

Visão Geral

O endpoint PIX Cash-Out permite que você realize pagamentos PIX instantâneos para qualquer chave PIX válida (CPF, CNPJ, telefone, email ou chave aleatória). O pagamento é processado em tempo real e o valor é debitado da sua conta imediatamente.
Para pagamentos via QR Code PIX (escaneamento ou copia-e-cola), utilize o endpoint dedicado Cash-Out via QR Code. Este endpoint é exclusivo para pagamentos por chave PIX.
Este endpoint requer um token Bearer válido. Verifique a documentação de autenticação para mais detalhes.

Características

  • Pagamentos instantâneos 24/7
  • Suporte a todos os tipos de chave PIX
  • Validação automática de dados do destinatário
  • Identificação única por externalId
  • Descrição personalizável para o destinatário
  • Verificação de saldo automática

Endpoint

POST /api/pix/cash-out

Realiza um pagamento PIX.

Headers Obrigatórios

Request Body

Request

Response (201 Created)

Parâmetros da Requisição

number
obrigatório
Valor do pagamento em reais (BRL). Deve ter no máximo 2 casas decimais.Mínimo: 0.01Exemplo: 250.50
object
obrigatório
Informações da chave PIX de destino.
string
obrigatório
Chave PIX de destino.Formatos aceitos:
  • CPF: 12345678901 (11 dígitos)
  • CNPJ: 12345678000199 (14 dígitos)
  • Email: usuario@exemplo.com
  • Telefone: 5511999999999 (com DDI e DDD)
  • Chave aleatória: UUID formato xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
string
obrigatório
Tipo da chave PIX.Valores aceitos:
  • DOCUMENT - CPF ou CNPJ
  • EMAIL - Endereço de email
  • PHONE - Número de telefone
  • RANDOM - Chave aleatória (UUID)
Exemplo: "DOCUMENT"
string
obrigatório
Nome completo do titular da chave PIX de destino.Validação: O nome deve corresponder ao cadastrado na chave PIXExemplo: "Ana Costa"
string
obrigatório
CPF ou CNPJ do titular (apenas números).CPF: 11 dígitosCNPJ: 14 dígitosValidação: O documento deve corresponder ao cadastrado na chave PIXExemplo: "12345678901"
string
obrigatório
Identificador único externo da transação.Máximo: 255 caracteresRecomendação: Use um formato que garanta unicidadeExemplo: "PAYMENT-987654-20240119-154500"
string
Descrição do pagamento que aparecerá no extrato do destinatário.Máximo: 140 caracteresPadrão: VazioExemplo: "Pagamento de fornecedor - Nota Fiscal 12345"

Estrutura da Resposta

string
obrigatório
ID interno da transação gerada pela Fire Banking.Exemplo: "9876"
string
obrigatório
ID externo fornecido na requisição (mesmo valor do input).Exemplo: "PAYMENT-987654-20240119"
string
obrigatório
Status atual da transação.Valores possíveis:
  • PENDING: Pagamento em processamento
  • CONFIRMED: Pagamento confirmado e finalizado
  • ERROR: Erro no processamento
Exemplo: "PENDING"Nota: A maioria dos pagamentos PIX é confirmada em poucos segundos
string
obrigatório
Data e hora de criação do pagamento (ISO 8601 UTC).Exemplo: "2024-01-19T15:45:00.000Z"

Exemplos de Implementação

Node.js / TypeScript

Python

PHP

Casos de Uso

1. Folha de Pagamento

2. Marketplace - Repasse para Vendedores

3. Sistema de Reembolso

Validação de Chave PIX

Antes de enviar um pagamento, valide o formato da chave PIX:

Verificação de Saldo

Sempre verifique o saldo antes de realizar pagamentos para evitar erros 400.

Monitoramento de Status

Para acompanhar a confirmação do pagamento:

Códigos de Resposta

Consulte a Referência da API para detalhes completos dos campos de resposta.

Boas Práticas

Consulte o saldo disponível antes de realizar pagamentos para evitar erros.
Facilita a conciliação e o rastreamento de pagamentos: PAY-{timestamp}-{uuid}
Implemente validação local de chaves PIX e documentos antes de enviar a requisição.
Em caso de falhas temporárias, implemente lógica de retry com backoff exponencial.
Mantenha um log completo de todas as tentativas de pagamento para auditoria.

Observações Importantes

  • Valor mínimo: R$ 0,01

Próximos Passos

Pagar via QR Code

Realize pagamentos escaneando QR Codes PIX

Consultar Saldo

Verifique o saldo antes de realizar pagamentos

Gerar Cobrança PIX

Receba pagamentos via PIX