Saque
Referência
Realize saques para chaves PIX
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.
Id único da transação de saque na AbacatePay
Status atual da transação de saque.
Indica se o saque foi criado em ambiente de desenvolvimento (sandbox) ou produção. Atualmente suportamos saques somente em produção.
URL do comprovante da transação de saque.
Tipo da transação. Para saques, sempre será
Valor do saque em centavos. No exemplo, R$ 50,00.
Taxa da plataforma cobrada pelo saque em centavos. No exemplo, R$ 0,80.
Identificador único do saque em seu sistema. Opcional.
Data e hora de criação do saque.
Data e hora da última atualização do saque.
Estrutura
Um saque é representado em nossa API pela seguinte estrutura de transação:json
Atributos:
id:
id:
json
id : string. Id único da transação de saque na AbacatePay
status:
status:
json
status : string. Status atual da transação de saque.
PENDING | Saque criado e aguardando processamento |
EXPIRED | Saque expirado e não pode mais ser processado |
CANCELLED | Saque cancelado |
COMPLETE | Saque processado e concluído com sucesso |
REFUNDED | Saque reembolsado |
devMode:
devMode:
json
devMode : boolean. Indica se o saque foi criado em ambiente de desenvolvimento (sandbox) ou produção. Atualmente suportamos saques somente em produção.
receiptUrl:
receiptUrl:
json
receiptUrl : string. URL do comprovante da transação de saque.
kind:
kind:
json
kind : string. Tipo da transação. Para saques, sempre será
WITHDRAW.amount:
amount:
json
amount : number. Valor do saque em centavos. No exemplo, R$ 50,00.
platformFee:
platformFee:
json
platformFee : number. Taxa da plataforma cobrada pelo saque em centavos. No exemplo, R$ 0,80.
externalId:
externalId:
json
externalId : string. Identificador único do saque em seu sistema. Opcional.
createdAt:
createdAt:
json
createdAt : string. Data e hora de criação do saque.
updatedAt:
updatedAt:
json
updatedAt : string. Data e hora da última atualização do saque.
Tipos de Chave PIX
O saque suporta os seguintes tipos de chave PIX:CPF:
CPF:
Chave PIX baseada no CPF (Cadastro de Pessoa Física) do beneficiário.Exemplo:
123.456.789-01CNPJ:
CNPJ:
Chave PIX baseada no CNPJ (Cadastro Nacional da Pessoa Jurídica) do beneficiário.Exemplo:
12.345.678/0001-90PHONE:
PHONE:
Chave PIX baseada no número de telefone celular do beneficiário.Exemplo:
+5511999999999EMAIL:
EMAIL:
Chave PIX baseada no endereço de e-mail do beneficiário.Exemplo:
usuario@exemplo.comRANDOM:
RANDOM:
Chave PIX aleatória (chave aleatória) do beneficiário.Exemplo:
a1b2c3d4-e5f6-7890-abcd-ef1234567890Limites 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