Skip to main content
POST
Criar um novo saque

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