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": "<unknown>"
}

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": "<unknown>"
}

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.

Show child attributes

pix.type

enum<string>

required

Tipo da chave PIX.

Available options:

CPF,

CNPJ,

PHONE,

EMAIL,

RANDOM,

BR_CODE

Example:

"CPF"

pix.key

string

required

Valor da chave PIX.

Example:

"123.456.789-01"

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).

Show child attributes

data.id

string

required

Identificador único da transação.

Example:

"tran_123456"

data.status

enum<string>

required

Status atual da transação.

Available options:

PENDING,

EXPIRED,

CANCELLED,

COMPLETE,

REFUNDED

Example:

"PENDING"

data.devMode

boolean

required

Indica se a transação foi criada em ambiente de testes.

Example:

true

data.receiptUrl

string<uri>

required

URL do comprovante da transação.

Example:

"https://abacatepay.com/receipt/tran_123456"

data.kind

enum<string>

default:WITHDRAW

required

Tipo da transação.

Available options:

PAYMENT,

WITHDRAW

Example:

"WITHDRAW"

data.amount

number

required

Valor da transação em centavos.

Example:

5000

data.platformFee

number

required

Taxa da plataforma em centavos.

Example:

80

data.createdAt

string<date-time>

required

Data de criação da transação.

Example:

"2025-03-24T21:50:20.772Z"

data.updatedAt

string<date-time>

required

Data de atualização da transação.

Example:

"2025-03-24T21:50:20.772Z"

data.externalId

string

Identificador externo da transação.

Example:

"withdraw-1234"

error

null

Simular Pagamento Buscar saque

⌘I

API Reference

Authorizations

Body

Response