Criar Saque
curl --request POST \
--url https://api.example.com/api/v1/cobranca/withdrawals \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"amount": 123,
"method": "<string>",
"pixKey": "<string>",
"pixKeyType": "<string>",
"metadata": {},
"description": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocumentType": "<string>",
"beneficiaryDocumentNumber": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/cobranca/withdrawals"
payload = {
"amount": 123,
"method": "<string>",
"pixKey": "<string>",
"pixKeyType": "<string>",
"metadata": {},
"description": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocumentType": "<string>",
"beneficiaryDocumentNumber": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<x-api-key>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
method: '<string>',
pixKey: '<string>',
pixKeyType: '<string>',
metadata: {},
description: '<string>',
beneficiaryName: '<string>',
beneficiaryDocumentType: '<string>',
beneficiaryDocumentNumber: '<string>'
})
};
fetch('https://api.example.com/api/v1/cobranca/withdrawals', 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/api/v1/cobranca/withdrawals",
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,
'method' => '<string>',
'pixKey' => '<string>',
'pixKeyType' => '<string>',
'metadata' => [
],
'description' => '<string>',
'beneficiaryName' => '<string>',
'beneficiaryDocumentType' => '<string>',
'beneficiaryDocumentNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <x-api-key>"
],
]);
$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/api/v1/cobranca/withdrawals"
payload := strings.NewReader("{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/api/v1/cobranca/withdrawals")
.header("x-api-key", "<x-api-key>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/withdrawals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"data.id": "<string>",
"data.amount": 123,
"data.status": "<string>"
}Criar Saque
Solicitar um saque do saldo disponível via PIX
POST
/
api
/
v1
/
cobranca
/
withdrawals
Criar Saque
curl --request POST \
--url https://api.example.com/api/v1/cobranca/withdrawals \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"amount": 123,
"method": "<string>",
"pixKey": "<string>",
"pixKeyType": "<string>",
"metadata": {},
"description": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocumentType": "<string>",
"beneficiaryDocumentNumber": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/cobranca/withdrawals"
payload = {
"amount": 123,
"method": "<string>",
"pixKey": "<string>",
"pixKeyType": "<string>",
"metadata": {},
"description": "<string>",
"beneficiaryName": "<string>",
"beneficiaryDocumentType": "<string>",
"beneficiaryDocumentNumber": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<x-api-key>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
method: '<string>',
pixKey: '<string>',
pixKeyType: '<string>',
metadata: {},
description: '<string>',
beneficiaryName: '<string>',
beneficiaryDocumentType: '<string>',
beneficiaryDocumentNumber: '<string>'
})
};
fetch('https://api.example.com/api/v1/cobranca/withdrawals', 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/api/v1/cobranca/withdrawals",
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,
'method' => '<string>',
'pixKey' => '<string>',
'pixKeyType' => '<string>',
'metadata' => [
],
'description' => '<string>',
'beneficiaryName' => '<string>',
'beneficiaryDocumentType' => '<string>',
'beneficiaryDocumentNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <x-api-key>"
],
]);
$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/api/v1/cobranca/withdrawals"
payload := strings.NewReader("{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/api/v1/cobranca/withdrawals")
.header("x-api-key", "<x-api-key>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/cobranca/withdrawals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"method\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"metadata\": {},\n \"description\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"beneficiaryDocumentType\": \"<string>\",\n \"beneficiaryDocumentNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"data.id": "<string>",
"data.amount": 123,
"data.status": "<string>"
}Cria uma solicitação de saque do seu saldo disponível. O header
Idempotency-Key é obrigatório. Saques acima de R$ 5.000 devem incluir dados do beneficiário (Travel Rule, compliance BACEN).
string
required
Sua API Key (
sk_live_...). Veja Autenticacao.string
required
Chave única para esta requisição (UUID v4, max 128 chars).Exemplo:
550e8400-e29b-41d4-a716-446655440000string
Token de confirmação 2FA. Obrigatório quando o usuário dono da credencial tem 2FA ativo — inclusive em chamadas via API Key. Sem ele, a API retorna
403 MFA_REQUIRED.integer
required
Valor do saque em centavos. Mínimo:
500 (R$ 5,00).Exemplo: 50000 (equivale a R$ 500,00)string
required
Método de saque. Valor aceito atualmente:
PIX (transferência instantânea via chave PIX, disponível 24/7).string
required
Chave PIX do destinatário. Aceita CPF, CNPJ, e-mail, telefone ou chave aleatória (EVP).Exemplo:
[email protected]string
required
Tipo da chave PIX. Valores:
CPF, CNPJ, PHONE, EMAIL, EVP.CPF: 11 dígitos (pontuação é ignorada)CNPJ: 14 caracteres — numérico ou alfanumérico (novo CNPJ, com letras nas 12 primeiras posições e 2 dígitos verificadores). Pontuação é ignorada.PHONE: telefone brasileiro. Recomendado o formato E.164+5511999999999, mas também aceitamos sem o+(5511999999999) ou só DDD + número (11999999999) — normalizamos para E.164 automaticamente.EMAIL: endereço de e-mail válidoEVP: chave aleatória UUID
object
Objeto JSON livre para dados do seu sistema.Exemplo:
{"order_id": "ORD-2024-001"}string
Descrição ou motivo do saque. Max 140 chars recomendado.Exemplo:
Repasse referente ao período de março/2024string
Nome completo do beneficiário. Obrigatório para compliance quando valor acima de R$ 5.000 (Travel Rule).
string
Tipo do documento do beneficiário. Valores:
CPF, CNPJ.string
Número do documento do beneficiário. CPF: 11 dígitos. CNPJ: 14 caracteres (numérico ou alfanumérico). Pontuação é ignorada.
Resposta
boolean
true quando o saque foi criado com sucesso.string
Identificador único do saque.
integer
Valor do saque em centavos. A tarifa do saque é debitada do saldo separadamente, conforme o plano contratado.
string
Status inicial:
PENDING.Novos valores podem ser adicionados a este campo. Trate valores
desconhecidos como fallback. Não faça switch exaustivo.
curl -X POST https://api.linkagateway.com/api/v1/cobranca/withdrawals \
-H "x-api-key: $API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"amount": 50000,
"method": "PIX",
"pixKey": "[email protected]",
"pixKeyType": "EMAIL"
}'
const apiKey = 'sk_live_...';
const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/withdrawals', {
method: 'POST',
headers: {
'x-api-key': apiKey,
'Idempotency-Key': crypto.randomUUID(),
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 50000,
method: 'PIX',
pixKey: '[email protected]',
pixKeyType: 'EMAIL'
})
});
const { data } = await response.json();
const apiKey = 'sk_live_...';
const response = await fetch('https://api.linkagateway.com/api/v1/cobranca/withdrawals', {
method: 'POST',
headers: {
'x-api-key': apiKey,
'Idempotency-Key': crypto.randomUUID(),
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 50000,
method: 'PIX',
pixKey: '[email protected]',
pixKeyType: 'EMAIL'
})
});
const { data } = await response.json();
import uuid
import requests
api_key = 'sk_live_...'
response = requests.post(
'https://api.linkagateway.com/api/v1/cobranca/withdrawals',
headers={
'x-api-key': api_key,
'Idempotency-Key': str(uuid.uuid4()),
'Content-Type': 'application/json'
},
json={
'amount': 50000,
'method': 'PIX',
'pixKey': '[email protected]',
'pixKeyType': 'EMAIL'
}
)
data = response.json()['data']
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"github.com/google/uuid"
)
func main() {
apiKey := "sk_live_..."
body, _ := json.Marshal(map[string]any{
"amount": 50000,
"method": "PIX",
"pixKey": "[email protected]",
"pixKeyType": "EMAIL",
})
req, _ := http.NewRequest("POST", "https://api.linkagateway.com/api/v1/cobranca/withdrawals", bytes.NewReader(body))
req.Header.Set("x-api-key", apiKey)
req.Header.Set("Idempotency-Key", uuid.New().String())
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
fmt.Println(resp.Status)
}
Exemplo de resposta
{
"status": true,
"data": {
"id": "clx1a2b3c4d5e6f7g8h9i0j",
"amount": 50000,
"method": "PIX",
"pixKey": "[email protected]",
"pixKeyType": "EMAIL",
"status": "PENDING",
"end2end": null,
"approvedAt": null,
"processedAt": null,
"metadata": null,
"createdAt": "2026-03-06T10:00:00.000Z"
}
}
Was this page helpful?