Skip to main content
POST
Sacar da subconta
Saca o saldo de uma subconta por Pix para a chave CPF/CNPJ do titular. Não há campo de chave Pix: o destino é sempre o documento da subconta.
Requer a permissão SUB_ACCOUNT:WITHDRAW.

Entenda as subcontas

Mínimo, taxa, limites, intervalo de 30 segundos por subconta, idempotência pelo externalId e eventos do saque.
Exemplo:
Erros comuns:

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
id
string
required

ID da subconta.

Pattern: ^sacc_
Example:

"sacc_9f8Kq2LmX4vTzR7pWn3bYc1H"

amount
integer
required

Valor em centavos, mínimo 100 (R$ 1,00). Sai do saldo da subconta; a taxa (platformFee) é descontada desse valor.

Required range: x >= 100
Example:

7000

externalId
string
required

Identificador do saque no seu sistema e chave de idempotência. Repetir o POST com o mesmo externalId e o mesmo amount devolve o saque que já existe, em qualquer status, sem mandar outro PIX. Com outro amount, ou já usado num saque ou envio de PIX da loja ou no saque de outra subconta, a API recusa.

Required string length: 1 - 100
Example:

"repasse-vendedor-42-out"

description
string

Descrição do PIX.

Maximum string length: 140
Example:

"Repasse de outubro"

Response

Saque criado.

data
object
error
string | null
Example:

null

success
boolean

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

Example:

true