Skip to main content
POST
/
withdrawals
Criar Saque
curl --request POST \
  --url https://api.example.com/withdrawals \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 123,
  "method": "<string>",
  "pixKey": "<string>",
  "pixKeyType": "<string>",
  "cryptoWalletAddress": "<string>",
  "withdrawFrom": "<string>",
  "metadata": {},
  "description": "<string>",
  "beneficiaryName": "<string>",
  "beneficiaryDocumentType": "<string>",
  "beneficiaryDocumentNumber": "<string>"
}
'
{
  "status": true,
  "data.id": "<string>",
  "data.amount": 123,
  "data.feeAmount": 123,
  "data.netAmount": 123,
  "data.status": "<string>"
}
Cria uma solicitacao de saque do saldo disponível do seller. O header Idempotency-Key e obrigatório. Saques acima de R$ 5.000 devem incluir dados do beneficiario (Travel Rule — compliance BACEN).
Authorization
string
required
API Key no formato Bearer sk_live_... ou Bearer sk_test_...
Idempotency-Key
string
required
Chave única para esta requisicao (UUID v4, max 128 chars).Exemplo: 550e8400-e29b-41d4-a716-446655440000
amount
integer
required
Valor do saque em centavos. Deve ser maior que zero.Exemplo: 50000 (equivale a R$ 500,00)
method
string
required
Método de saque. Valores: PIX, CRYPTO.
  • PIX: transferencia instantanea via chave PIX (disponível 24/7)
  • CRYPTO: transferencia para carteira de criptomoeda
pixKey
string
Chave PIX do destinatario. Obrigatório quando method = PIX. Aceita CPF, CNPJ, e-mail, telefone ou chave aleatoria (EVP).Exemplo: [email protected]
pixKeyType
string
Tipo da chave PIX. Obrigatório quando method = PIX. Valores: CPF, CNPJ, PHONE, EMAIL, EVP.
  • CPF: 11 digitos
  • CNPJ: 14 digitos
  • PHONE: formato +5511999999999
  • EMAIL: endereco de e-mail valido
  • EVP: chave aleatoria UUID
cryptoWalletAddress
string
Endereco da carteira de criptomoeda. Obrigatório quando method = CRYPTO.Exemplo: 0x742d35Cc6634C0532925a3b844Bc454e4438f44e
withdrawFrom
string
default:"PIX"
Fonte do saldo a utilizar. Valores: PIX, CARD, BOLETO.
metadata
object
Objeto JSON livre para dados do seu sistema.Exemplo: {"order_id": "ORD-2024-001"}
description
string
Descrição ou motivo do saque. Max 140 chars recomendado.Exemplo: Repasse referente ao período de marco/2024
beneficiaryName
string
Nome completo do beneficiario. Obrigatório para compliance quando valor acima de R$ 5.000 (Travel Rule).
beneficiaryDocumentType
string
Tipo do documento do beneficiario. Valores: CPF, CNPJ.
beneficiaryDocumentNumber
string
Número do documento do beneficiario, apenas digitos. CPF: 11 digitos. CNPJ: 14 digitos.

Resposta

status
boolean
true quando o saque foi criado com sucesso.
data.id
string
Identificador único do saque.
data.amount
integer
Valor do saque em centavos.
data.feeAmount
integer
Taxa cobrada em centavos.
data.netAmount
integer
Valor liquido que o beneficiario recebe (amount - feeAmount), em centavos.
data.status
string
Status inicial: PENDING.
curl -X POST https://api.linka.com/withdrawals \
  -H "Authorization: Bearer <token>" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440001" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "method": "PIX",
    "pixKey": "[email protected]",
    "pixKeyType": "EMAIL",
    "description": "Repasse de marco/2024"
  }'

Exemplo de resposta

{
  "status": true,
  "data": {
    "id": "clx1a2b3c4d5e6f7g8h9i0j",
    "amount": 50000,
    "feeAmount": 150,
    "netAmount": 49850,
    "method": "PIX",
    "pixKey": "[email protected]",
    "pixKeyType": "EMAIL",
    "status": "PENDING",
    "createdAt": "2026-03-06T10:00:00.000Z"
  }
}