Skip to main content
POST
/
payouts
/
create
Criar um payout
curl --request POST \
  --url https://api.abacatepay.com/v2/payouts/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10000,
  "externalId": "saque-123"
}
'
{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "devMode": false,
    "receiptUrl": null,
    "amount": 10000,
    "platformFee": 100,
    "externalId": "saque-123",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}

Requer a permissão WITHDRAW:CREATE.

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

Dados necessários para criar um payout.

​
amount
number
required

Valor do payout em centavos.

Required range: x >= 350
Example:

10000

​
externalId
string
required

Identificador único do payout em seu sistema.

Example:

"saque-123"

​
description
string

Descrição opcional do payout.

Example:

"Saque para conta bancária"

Response

Payout criado com sucesso.

​
data
object

Dados da transação de payout criada.

​
error
string | null
Example:

null

​
success
boolean

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

Example:

true