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.
O destino é aninhado em pix, com as chaves key e type. Enviar pixKey/pixKeyType no topo falha com Property 'pix' is missing, e aninhar com esses nomes falha com Property 'pix.type' is missing.
Formato aceito pela API:
Limites:
  • Valor mínimo: R$ 3,50
  • Taxa: descontada do valor: a conta de destino recebe amount menos platformFee. Os valores estão na página de preços
  • 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, mínimo 350 (R$ 3,50). A taxa (platformFee) é descontada desse valor.

Required range: x >= 350
Example:

10000

pix
object
required

Chave PIX de destino do payout.

description
string

Descrição opcional do payout.

Example:

"Saque para conta bancária"

externalId
string

Identificador do payout no seu sistema.

Example:

"saque-123"

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