Pular para o conteúdo principal
POST
/
api
/
pix
/
cash-out
Realizar pagamento PIX (Cash-Out)
curl --request POST \
  --url https://api.public.firebanking.com.br/api/pix/cash-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 15.5,
  "details": {
    "key": "12312312387",
    "keyType": "DOCUMENT",
    "name": "John Marvin",
    "document": "12312312387"
  },
  "externalId": "external-teste-001",
  "description": "Pagamento fornecedor XYZ"
}
'
import requests

url = "https://api.public.firebanking.com.br/api/pix/cash-out"

payload = {
"value": 15.5,
"details": {
"key": "12312312387",
"keyType": "DOCUMENT",
"name": "John Marvin",
"document": "12312312387"
},
"externalId": "external-teste-001",
"description": "Pagamento fornecedor XYZ"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
value: 15.5,
details: {
key: '12312312387',
keyType: 'DOCUMENT',
name: 'John Marvin',
document: '12312312387'
},
externalId: 'external-teste-001',
description: 'Pagamento fornecedor XYZ'
})
};

fetch('https://api.public.firebanking.com.br/api/pix/cash-out', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.public.firebanking.com.br/api/pix/cash-out",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'value' => 15.5,
'details' => [
'key' => '12312312387',
'keyType' => 'DOCUMENT',
'name' => 'John Marvin',
'document' => '12312312387'
],
'externalId' => 'external-teste-001',
'description' => 'Pagamento fornecedor XYZ'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.public.firebanking.com.br/api/pix/cash-out"

payload := strings.NewReader("{\n \"value\": 15.5,\n \"details\": {\n \"key\": \"12312312387\",\n \"keyType\": \"DOCUMENT\",\n \"name\": \"John Marvin\",\n \"document\": \"12312312387\"\n },\n \"externalId\": \"external-teste-001\",\n \"description\": \"Pagamento fornecedor XYZ\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.public.firebanking.com.br/api/pix/cash-out")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"value\": 15.5,\n \"details\": {\n \"key\": \"12312312387\",\n \"keyType\": \"DOCUMENT\",\n \"name\": \"John Marvin\",\n \"document\": \"12312312387\"\n },\n \"externalId\": \"external-teste-001\",\n \"description\": \"Pagamento fornecedor XYZ\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.public.firebanking.com.br/api/pix/cash-out")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": 15.5,\n \"details\": {\n \"key\": \"12312312387\",\n \"keyType\": \"DOCUMENT\",\n \"name\": \"John Marvin\",\n \"document\": \"12312312387\"\n },\n \"externalId\": \"external-teste-001\",\n \"description\": \"Pagamento fornecedor XYZ\"\n}"

response = http.request(request)
puts response.read_body
{
  "transactionId": "456",
  "externalId": "external-teste-001",
  "status": "PENDING",
  "generateTime": "2024-01-15T10:30:00.000Z"
}

Autorizações

Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
value
number
obrigatório

Valor da transação em reais (até duas casas decimais)

Exemplo:

15.5

details
object
obrigatório

Informações da chave PIX de destino

externalId
string
obrigatório

Identificador externo único para a transação

Exemplo:

"external-teste-001"

description
string

Descrição opcional da transação

Exemplo:

"Pagamento fornecedor XYZ"

Resposta

Pagamento PIX 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:

"external-teste-001"

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-15T10:30:00.000Z"