ABabacatepay

Criar um payout

Changed on

Saca o saldo da sua conta AbacatePay para uma chave PIX do mesmo CNPJ da conta. Para enviar dinheiro a terceiros, use POST /pix/send.

post/payouts/create

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/payouts/create
  • Auth
    HTTP bearer

Request body

amountnumber required

Valor do payout em centavos, mínimo 350 (R$ 3,50). A taxa (platformFee) é descontada desse valor.

descriptionstring

Descrição opcional do payout.

externalIdstring

Identificador do payout no seu sistema.

Example request

{
  "amount": 10000,
  "externalId": "saque-123",
  "pix": {
    "key": "11987654321",
    "type": "PHONE"
  }
}

Response

Payout criado com sucesso.

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "id": "tran_abc123xyz",
    "status": "COMPLETE",
    "receiptUrl": "https://app.abacatepay.com/receipt/tran_abc123xyz",
    "amount": 10000,
    "platformFee": 80,
    "externalId": "saque-123",
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}

Changes

  • 0ac54d6c2796Revision changes
    • warning

      added the new FAILED enum value to the / response property for the response status

    • info

      the request property became optional

    • info

      removed the CANCELLED enum value from the / response property for the response status

    • info

      removed the EXPIRED enum value from the / response property for the response status

    • info

      removed the PENDING enum value from the / response property for the response status

    • info

      removed the REFUNDED enum value from the / response property for the response status

  • ea8a72b04f2aRevision changes
    • breaking

      added the new required request property