Criação de Saque PIX

Autenticação

Antes de iniciar qualquer integração, você deve obter sua API Key para autenticação na plataforma.

Para mais detalhes, consulte a documentação de autenticação.

Link to a page in the guide

Integração

Esta integração permite criar uma solicitação de saque via PIX, onde o valor a ser transferido será debitado da sua conta.

Preparação da Requisição

Obtenha sua API Key: Utilize a chave para autenticar a requisição.
Monte o corpo da requisição: O JSON enviado deve atender aos seguintes critérios:
- Parâmetros obrigatórios: Os campos type, value, details e externalId devem ser preenchidos.
- Validação do documento: Em details.document deve ser informado um CPF ou CNPJ válido.
- Valor da transação: O campo value deve ser um número inteiro positivo (maior que zero).
- Chave PIX: O campo key dentro de details deve ser uma chave PIX válida.
- Tipo de chave: O campo keyType deve ser um dos seguintes: SOCIAL_NUMBER, DOCUMENT, MAIL, PHONE ou RANDOM_KEY.
- Identificador único: O campo externalId deve ser único para identificar a transação no seu sistema.

Exemplo de Corpo da Requisição

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

Exemplo de Requisição (CURL)

Após preparar a chave de autenticação e o corpo da requisição, faça a chamada para o endpoint:

curl --request POST \
  --url https://api.firebanking.com.br/payment/withdraw \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apiKey: 123' \
  --data '{
  "type": "PIX",
  "value": 15,
  "details": {
    "key": "12312312387",
    "keyType": "DOCUMENT",
    "name": "John Marvin",
    "document": "12312312387"
  },
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Tratamento da Resposta

Resposta de Sucesso (Status 200)

Em caso de sucesso, a resposta retornará um JSON com os seguintes dados:

Campos a serem recebidos

Campo	Tipo	Descrição
transactionId	string	Identificador único gerado para transação de saque
status	string	Status da cobrança/transação. Inicialmente, "WAITING_CONFIRMATION“ é o status padrão após gerar uma transferência e aguardar o pagamento, pois deve realizar todas as validações na conta, como por exemplo se há saldo na conta antes de realizar a transferência

Campo

Tipo

Descrição

transactionId

string

Identificador único gerado para transação de saque

status

string

Status da cobrança/transação.

Inicialmente, "WAITING_CONFIRMATION“ é o status padrão após gerar uma transferência e aguardar o pagamento, pois deve realizar todas as validações na conta, como por exemplo se há saldo na conta antes de realizar a transferência

Exemplo

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

Resposta com Erro (Status 400, 404 ou 500)

Caso ocorra um erro, a API retornará um status diferente de 200 com uma mensagem explicativa:

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

Para mais detalhes sobre os possíveis erros e parâmetros, acesse a referência completa da API.

Introdução