Skip to main content
POST
Criar um payout
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:
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

Payout criado com sucesso.

data
object

Dados da transação de payout criada.

error
string | null
Example:

null

success
boolean

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

Example:

true