Skip to main content
POST
Sacar da subconta
Saca o saldo de uma subconta por PIX para a chave CPF/CNPJ do titular.
Requer a permissão SUB_ACCOUNT:WITHDRAW.
Não há campo de chave PIX: o destino é sempre a chave CPF/CNPJ igual ao taxId da subconta, o que garante que o dinheiro vai para o próprio vendedor. Ele precisa ter essa chave cadastrada no banco dele. Formato aceito pela API:
O amount sai do saldo da subconta, e o titular recebe amount menos platformFee. A resposta tem o mesmo formato de Enviar PIX, com o campo subAccountId a mais. Valores de status: O resultado do envio chega pelos webhooks transfer.completed e transfer.failed, com o mesmo id e externalId da resposta do saque. Limites:
  • A taxa e os limites diários e noturnos de saque são os da sua conta, e os saques das subcontas contam no mesmo limite diário
  • Cada subconta pode fazer um saque a cada 30 segundos. Subcontas diferentes podem sacar em sequência
  • Os saques das subcontas não aparecem em Listar Saques nem no extrato da loja
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.

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