Sacar da subconta

Changed on

Saca o saldo de uma subconta por PIX. O destino é sempre a chave CPF/CNPJ igual ao taxId da subconta, por isso não há campo de chave.

post/sub-accounts/withdraw

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/sub-accounts/withdraw
  • Auth
    HTTP bearer

Request body

idstring required

ID da subconta.

amountinteger required

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

externalIdstring required

Identificador do saque no seu sistema.

descriptionstring

Descrição do PIX.

Example request

{
  "id": "sacc_9f8Kq2LmX4vTzR7pWn3bYc1H",
  "amount": 7000,
  "externalId": "repasse-vendedor-42-out"
}

Response

Saque criado.

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "id": "tran_abc123xyz",
    "subAccountId": "sacc_9f8Kq2LmX4vTzR7pWn3bYc1H",
    "status": "COMPLETE",
    "receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
    "amount": 7000,
    "platformFee": 80,
    "externalId": "repasse-vendedor-42-out",
    "createdAt": "2026-10-26T14:22:10.381Z",
    "updatedAt": "2026-10-26T14:22:10.381Z"
  },
  "success": true
}

Changes