v2

OpenAPI 3.1.02026-07-314524165.2 KB

Criar um payout

Permite que você crie um novo payout para transferir valores da sua conta AbacatePay.

Você pode usar esta rota para:

Realizar saques da sua conta para sua própria chave PIX
Enviar dinheiro para outras contas
Realizar pagamentos diretamente pela API
Efetuar transferências para fornecedores, parceiros ou terceiros

Importante: A chave PIX de destino não precisa ter a mesma titularidade do CNPJ da sua conta. Você pode realizar payouts para qualquer chave PIX válida.

post/payouts/create

Request body

amountnumber required

Valor do payout em centavos.

descriptionstring

Descrição opcional do payout.

externalIdstring required

Identificador único do payout em seu sistema.

Example request

{
  "amount": 10000,
  "externalId": "saque-123"
}

Response

Payout criado com sucesso.

errorstring nullable

successboolean

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

Example response

{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "amount": 10000,
    "platformFee": 100,
    "externalId": "saque-123",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}