Envio e Pagamento (Cash Out)

O que é Cash Out?Copied!

O Cash Out é o momento em que o cliente decide sacar ou transferir valores de sua conta na Fire Banking para outra conta bancária, utilizando o Pix. Dessa forma, ele pode movimentar o saldo disponível na Fire Banking de maneira rápida, enviando-o para o CPF ou CNPJ do beneficiário (pessoa física ou jurídica).

Como funciona o fluxo de saque?Copied!

1. O cliente inicia um saque na plataforma da Fire Banking, informando os dados necessários: valor, chave Pix e dados do destinatário.

2. O sistema recebe a requisição (via nossa API) e valida as informações: verifica se o valor é positivo, se a chave Pix está em um formato válido, se há saldo em conta etc.

3. É gerada uma transação de saída (Cash Out) com um transactionId, que permite acompanhar o status.

4. A operação é confirmada de acordo com a disponibilidade de saldo e as regras de segurança.

5. O cliente é notificado com o status da operação, seja via retorno direto da API, seja via webhook (se configurado).

O que é preciso informar?Copied!

Para criar um saque via Pix, as informações mínimas são:

• Valor do saque (ex.: 123.45, que representa R$ 123,45).

• Chave Pix do destinatário (CPF/CNPJ, e-mail, telefone ou chave aleatória).

• Nome e documento (CPF ou CNPJ) do beneficiário.

• (Opcional) Um ID externo, caso você queira rastrear a transação no seu próprio sistema.

Exemplo de requisiçãoCopied!

POST https://api.firebanking.com.br/payment/withdraw
Header: 
  Content-Type: application/json
  apiKey: <sua-chave-api>

Body (JSON):
{
    "type": "PIX",
    "value": 15,
    "details": {
        "key": "12312312387",
        "keyType": "DOCUMENT",
        "name": "John Marvin",
        "document": "12312312387"
    },
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Campos principais

• type: Sempre "PIX" para saques via Pix.

• value: Valor a ser transferido (número positivo).

• details: Objeto com os dados do beneficiário:

  • key: Chave Pix (exemplo: CPF, CNPJ, e-mail, chave aleatória etc.).

  • keyType: Tipo dessa chave (DOCUMENT, EMAIL, RANDOM_KEY, etc.).

  • name: Nome do beneficiário.

  • document: CPF ou CNPJ do beneficiário.

• externalId (opcional): Um identificador externo usado pela sua aplicação para rastreio.

Exemplo de resposta bem-sucedida

Se o saque for criado com sucesso, o servidor retornará um JSON com o transactionId (ID da transação gerado pela Fire Banking) e o status inicial da operação. Exemplo:

{
    "transactionId":"75906707-8c31-479c-b354-aa805c4cefbc",
    "status":"WAITING_CONFIRMATION"
}

• transactionId: Identificador único para acompanhar a transação.

• status: Indica o estado atual do saque. Geralmente, inicia como "WAITING_CONFIRMATION" enquanto a conta e o saldo são validados.

Possíveis erros

Caso algo esteja incorreto (por exemplo, dados inválidos, saldo insuficiente ou chave Pix inválida), o sistema retornará códigos de erro (400, 404, 500 etc.) acompanhados de uma mensagem explicando o motivo. Exemplo:

{
    "message": "Payer document and full name are required."
}

Observações

• Você precisa de uma chave de API válida (apiKey) para realizar as requisições na plataforma.

• Garantir que o valor (campo value) seja positivo e maior que zero.

• Se o saque exigir confirmação adicional (regra interna), a transferência poderá ficar em análise antes da liquidação efetiva.

• Se desejar receber notificações automáticas sobre o status dessa transação (como sucesso ou falha), configure os webhooks na Fire Banking.

Essa é uma visão geral do Cash Out via Pix. Para mais detalhes técnicos, parâmetros de segurança ou exemplos de uso avançados, consulte o link de referência abaixo ou fale com o suporte.

Referência