Skip to main content
POST
/
withdraw
/
create
Criar um novo saque
curl --request POST \
  --url https://api.abacatepay.com/v1/withdraw/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "withdraw-1234",
  "method": "PIX",
  "amount": 5000,
  "pix": {
    "type": "CPF",
    "key": "123.456.789-01"
  },
  "description": "Saque para conta principal"
}
'
{
  "data": {
    "id": "tran_123456",
    "status": "PENDING",
    "devMode": true,
    "receiptUrl": "https://abacatepay.com/receipt/tran_123456",
    "kind": "WITHDRAW",
    "amount": 5000,
    "platformFee": 80,
    "createdAt": "2025-03-24T21:50:20.772Z",
    "updatedAt": "2025-03-24T21:50:20.772Z",
    "externalId": "withdraw-1234"
  },
  "error": null
}

Authorizations

​
Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <abacatepay-api-key> onde <abacatepay-api-key> é a sua chave de API.

Body

application/json

Dados necessários para criar um saque.

​
externalId
string
required

Identificador único do saque em seu sistema.

Example:

"withdraw-1234"

​
method
enum<string>
required

Método de saque disponível.

Available options:
PIX
Example:

"PIX"

​
amount
number
required

Valor do saque em centavos.

Required range: x >= 350
Example:

5000

​
pix
object
required

Dados da chave PIX para receber o saque.

​
description
string

Descrição opcional do saque.

Example:

"Saque para conta principal"

Response

Saque criado com sucesso.

​
data
object

Dados de uma transação (pagamento ou saque).

​
error
null
Example:

null