v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Buscar payout

Permite que você recupere os detalhes de um payout específico usando o externalId.

get/payouts/get

Query parameters

externalIdstring required
Example:saque-123

Identificador único do payout em seu sistema.

Response

Detalhes do payout retornados com sucesso.

errorstring nullable
successboolean

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

Example response

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