Criar um payout
curl --request POST \
--url https://api.abacatepay.com/v2/payouts/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"externalId": "saque-123",
"pix": {
"key": "11987654321",
"type": "PHONE"
}
}
'import requests
url = "https://api.abacatepay.com/v2/payouts/create"
payload = {
"amount": 10000,
"externalId": "saque-123",
"pix": {
"key": "11987654321",
"type": "PHONE"
}
}
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({
amount: 10000,
externalId: 'saque-123',
pix: {key: '11987654321', type: 'PHONE'}
})
};
fetch('https://api.abacatepay.com/v2/payouts/create', 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.abacatepay.com/v2/payouts/create",
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' => 10000,
'externalId' => 'saque-123',
'pix' => [
'key' => '11987654321',
'type' => 'PHONE'
]
]),
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.abacatepay.com/v2/payouts/create"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\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.abacatepay.com/v2/payouts/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/payouts/create")
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 \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "tran_abc123xyz",
"status": "COMPLETE",
"devMode": false,
"receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
"amount": 10000,
"platformFee": 80,
"externalId": "saque-123",
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}Saques
Criar um Saque
Saca o saldo da sua conta AbacatePay para uma chave PIX do mesmo CNPJ da conta. Para enviar dinheiro a terceiros, use POST /pix/send.
POST
/
payouts
/
create
Criar um payout
curl --request POST \
--url https://api.abacatepay.com/v2/payouts/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 10000,
"externalId": "saque-123",
"pix": {
"key": "11987654321",
"type": "PHONE"
}
}
'import requests
url = "https://api.abacatepay.com/v2/payouts/create"
payload = {
"amount": 10000,
"externalId": "saque-123",
"pix": {
"key": "11987654321",
"type": "PHONE"
}
}
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({
amount: 10000,
externalId: 'saque-123',
pix: {key: '11987654321', type: 'PHONE'}
})
};
fetch('https://api.abacatepay.com/v2/payouts/create', 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.abacatepay.com/v2/payouts/create",
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' => 10000,
'externalId' => 'saque-123',
'pix' => [
'key' => '11987654321',
'type' => 'PHONE'
]
]),
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.abacatepay.com/v2/payouts/create"
payload := strings.NewReader("{\n \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\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.abacatepay.com/v2/payouts/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/payouts/create")
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 \"amount\": 10000,\n \"externalId\": \"saque-123\",\n \"pix\": {\n \"key\": \"11987654321\",\n \"type\": \"PHONE\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "tran_abc123xyz",
"status": "COMPLETE",
"devMode": false,
"receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
"amount": 10000,
"platformFee": 80,
"externalId": "saque-123",
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}Saca saldo da sua conta para uma chave PIX de sua titularidade.
Formato aceito pela API:
Limites:
Requer a permissão
WITHDRAW:CREATE.Saques vs PIX: use Saques para sua própria chave PIX. Para enviar a terceiros use Enviar PIX.
O destino é aninhado em
pix, com as chaves key e type. Enviar
pixKey/pixKeyType no topo falha com Property 'pix' is missing, e
aninhar com esses nomes falha com Property 'pix.type' is missing.{
"amount": 10000,
"description": "Saque semanal",
"externalId": "saque-123",
"pix": {
"key": "sua-chave@email.com",
"type": "EMAIL"
}
}
- Valor mínimo: R$ 3,50
- Taxa: descontada do valor: a conta de destino recebe
amountmenosplatformFee. Os valores estão na página de preços - Limite de frequência: 1 saque por minuto (HTTP 429 se excedido)
Authorizations
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.
Body
application/json
Dados necessários para criar um payout.
Valor do payout em centavos, mínimo 350 (R$ 3,50). A taxa (platformFee) é descontada desse valor.
Required range:
x >= 350Example:
10000
Chave PIX de destino do payout.
Show child attributes
Show child attributes
Descrição opcional do payout.
Example:
"Saque para conta bancária"
Identificador do payout no seu sistema.
Example:
"saque-123"
Was this page helpful?