Skip to main content
O módulo de Saque permite que você transfira valores da sua conta AbacatePay para uma chave PIX de sua escolha. É uma funcionalidade essencial para gerenciar seus fundos e realizar transferências. Atualmente, o saque suporta apenas o método PIX, que é o método mais rápido e eficiente para transferências no Brasil.

​
Estrutura

Um saque é representado em nossa API pela seguinte estrutura de transação:
json
{
  "id": "tran_1234567890abcdef",
  "status": "PENDING",
  "devMode": true,
  "receiptUrl": "https://abacatepay.com/receipt/tran_1234567890abcdef",
  "kind": "WITHDRAW",
  "amount": 5000,
  "platformFee": 80,
  "externalId": "withdraw-1234",
  "createdAt": "2024-12-06T18:56:15.538Z",
  "updatedAt": "2024-12-06T18:56:15.538Z"
}

​
Atributos:

json
{
"id": "tran_1234567890abcdef",
}
id : string.
Id único da transação de saque na AbacatePay
json
{
"status": "PENDING",
}
status : string.
Status atual da transação de saque.
PENDINGSaque criado e aguardando processamento
EXPIREDSaque expirado e não pode mais ser processado
CANCELLEDSaque cancelado
COMPLETESaque processado e concluído com sucesso
REFUNDEDSaque reembolsado
json
{
"devMode": true,
}
devMode : boolean.
Indica se o saque foi criado em ambiente de desenvolvimento (sandbox) ou produção. Atualmente suportamos saques somente em produção.
json
{
"receiptUrl": "https://abacatepay.com/receipt/tran_1234567890abcdef",
}
receiptUrl : string.
URL do comprovante da transação de saque.
json
{
"kind": "WITHDRAW",
}
kind : string.
Tipo da transação. Para saques, sempre será WITHDRAW.
json
{
"amount": 5000,
}
amount : number.
Valor do saque em centavos. No exemplo, R$ 50,00.
json
{
"platformFee": 80,
}
platformFee : number.
Taxa da plataforma cobrada pelo saque em centavos. No exemplo, R$ 0,80.
json
{
"externalId": "withdraw-1234",
}
externalId : string.
Identificador único do saque em seu sistema. Opcional.
json
{
"createdAt": "2024-12-06T18:56:15.538Z",
}
createdAt : string.
Data e hora de criação do saque.
json
{
"updatedAt": "2024-12-06T18:56:15.538Z",
}
updatedAt : string.
Data e hora da última atualização do saque.

​
Tipos de Chave PIX

O saque suporta os seguintes tipos de chave PIX:
Chave PIX baseada no CPF (Cadastro de Pessoa Física) do beneficiário.Exemplo: 123.456.789-01
Chave PIX baseada no CNPJ (Cadastro Nacional da Pessoa Jurídica) do beneficiário.Exemplo: 12.345.678/0001-90
Chave PIX baseada no número de telefone celular do beneficiário.Exemplo: +5511999999999
Chave PIX baseada no endereço de e-mail do beneficiário.Exemplo: usuario@exemplo.com
Chave PIX aleatória (chave aleatória) do beneficiário.Exemplo: a1b2c3d4-e5f6-7890-abcd-ef1234567890

​
Limites e Taxas

  • Valor mínimo: R$ 3,50 (350 centavos)
  • Taxa da plataforma: R$ 0,80 centavos se estiver dentro dos limites descritos em nossos termos de uso
  • Processamento: Instantâneo
  • Disponibilidade: 24/7 caso os limites diários e noturnos da sua conta não tenham sido excedidos
  • Limite de uso: 1 saque por minuto. Tentativas em excesso resultarão em erro HTTP 429 (Too Many Requests). Para aumentar o limite entre em contato com nosso suporte

​
Segurança

  • Todos os saques são autenticados via Bearer Token
  • Validação automática das chaves PIX
  • Logs detalhados de todas as transações
  • Possibilidade de cancelamento em caso de erro
  • Abusos desta API podem resultar em suspensão da conta conforme descrito em nossos termos de uso
⌘I