Criar um Saque

Permite que você crie um novo payout para transferir valores da sua conta AbacatePay.

Você pode usar esta rota para:

• Realizar saques da sua conta para sua própria chave PIX
• Enviar dinheiro para outras contas
• Realizar pagamentos diretamente pela API
• Efetuar transferências para fornecedores, parceiros ou terceiros

Importante: A chave PIX de destino não precisa ter a mesma titularidade do CNPJ da sua conta. Você pode realizar payouts para qualquer chave PIX válida.

POST /payouts/create

Criar um payout

cURL

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"
}
'

200

{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "devMode": false,
    "receiptUrl": null,
    "amount": 10000,
    "platformFee": 100,
    "externalId": "saque-123",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}

Saca saldo da sua conta para uma chave PIX de sua titularidade.

Requer a permissão WITHDRAW:CREATE.

Saques vs PIX: use Saques para sua própria chave PIX. Para enviar a terceiros use Enviar PIX.

Exemplo:

{
  "amount": 10000,
  "description": "Saque semanal",
  "externalId": "saque-123",
  "pixKey": "[e-mail]",
  "pixKeyType": "EMAIL"
}

Limites:

• Valor mínimo: R$ 3,50
• Taxa: R$ 0,80 por saque
• Limite de frequência: 1 saque por minuto (HTTP 429 se excedido)

Authorizations

Authorization · string · header · required

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.

amount · number · required

Valor do payout em centavos.

Required range: x >= 350

Example:

10000

externalId · string · required

Identificador único do payout em seu sistema.

Example:

"saque-123"

description · string

Descrição opcional do payout.

Example:

"Saque para conta bancária"

Response

200

application/json

Payout criado com sucesso.

data · object

Dados da transação de payout criada.

Show child attributes

error · string | null

Example:

null

success · boolean

Se a requisição obteve sucesso ou não.

Example:

true