Criar Payout
curl --request POST \
--url https://api.example.com/payout \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"pixKey": "<string>",
"pixKeyType": "<string>",
"referenceId": "<string>",
"webhookUrl": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocument": "<string>"
}
'import requests
url = "https://api.example.com/payout"
payload = {
"amount": 123,
"pixKey": "<string>",
"pixKeyType": "<string>",
"referenceId": "<string>",
"webhookUrl": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocument": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
pixKey: '<string>',
pixKeyType: '<string>',
referenceId: '<string>',
webhookUrl: '<string>',
beneficiaryName: '<string>',
beneficiaryDocument: '<string>'
})
};
fetch('https://api.example.com/payout', 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.example.com/payout",
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([
'amount' => 123,
'pixKey' => '<string>',
'pixKeyType' => '<string>',
'referenceId' => '<string>',
'webhookUrl' => '<string>',
'beneficiaryName' => '<string>',
'beneficiaryDocument' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.example.com/payout"
payload := strings.NewReader("{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.example.com/payout")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPayouts (Pagamentos)
Criar Payout
Inicia uma transferência financeira (Saque) via PIX da sua conta corporativa para terceiros (contas, fornecedores).
POST
/
payout
Criar Payout
curl --request POST \
--url https://api.example.com/payout \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"pixKey": "<string>",
"pixKeyType": "<string>",
"referenceId": "<string>",
"webhookUrl": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocument": "<string>"
}
'import requests
url = "https://api.example.com/payout"
payload = {
"amount": 123,
"pixKey": "<string>",
"pixKeyType": "<string>",
"referenceId": "<string>",
"webhookUrl": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocument": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
pixKey: '<string>',
pixKeyType: '<string>',
referenceId: '<string>',
webhookUrl: '<string>',
beneficiaryName: '<string>',
beneficiaryDocument: '<string>'
})
};
fetch('https://api.example.com/payout', 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.example.com/payout",
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([
'amount' => 123,
'pixKey' => '<string>',
'pixKeyType' => '<string>',
'referenceId' => '<string>',
'webhookUrl' => '<string>',
'beneficiaryName' => '<string>',
'beneficiaryDocument' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.example.com/payout"
payload := strings.NewReader("{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.example.com/payout")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"webhookUrl\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocument\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCrie e acompanhe transferências de saídas seguras do seu saldo disponível utilizando as chaves PIX de destino cadastradas em território brasileiro.
Autorização
string
required
Use o Basic Auth codificado em 64 das suas chaves de produção.
Body
integer
required
Somas totais a retirar em centavos sem pontuação (Min: R$1,00 -
100).string
required
Documentação/chave da conta recebedora do Bacen. Pode ser Email, CPF/CNPJ ou UUID.
string
required
Determina de que formato é a pixKey. Valores suportados:
CPFCNPJEMAILPHONEEVP(Chave Aleatória)
string
required
Identificador unívoco do seu lado para alinhar recibos. Recomendação: GUIDV4.
string
Um end-point configurado do seu lado para ouvir mudanças até que o saco atinja
COMPLETED ou FAILED.string
O nome da pessoa que receberá na conta bancária (Aprovado durante o KYC do DICT - Diretório de contatos PIX). Opcional.
string
Opcional. Caso o recebedor possua empresa associada ao destino do saque.
Response
A rota retornará o estado inicial da transferência. Como o saque bancário depende da grade horária do SPB, geralmente a resposta nasce comoPENDING ou PROCESSING.
{
"id": "payout_1001A",
"externalId": null,
"status": "PENDING",
"amount": 250000,
"pixKey": "maria@email.com",
"pixKeyType": "EMAIL",
"referenceId": "comissionado_001",
"beneficiaryName": null,
"createdAt": "2026-03-02T16:25:00.000Z"
}
Erros de Validação Comuns (4xx):
- Insufficient Funds (400): A sua conta, descontando os bloqueios ou saques previstos, não possui o
amountpara a transferência se concretizar. - Invalid Key (422): A formatação da chave falhou antes de ser encaminhada ao DICT para varredura.
Lembre-se de verificar sempre em nossos Webhooks para automatizar o reflexo do saque retornado de falha na carteira do seu painel e devolver o saldo virtual de volta.
Was this page helpful?