Skip to main content
GET
/
payouts
/
get
Buscar payout
curl --request GET \
  --url https://api.abacatepay.com/v2/payouts/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "txn_abc123xyz",
    "status": "COMPLETE",
    "devMode": false,
    "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"
  },
  "error": null,
  "success": true
}
Retorna os dados de um saque pelo seu id.

Requer a permissão WITHDRAW:READ.
Use para verificar o status de um saque após criá-lo. Quando status for COMPLETE, o campo receiptUrl estará disponível com o comprovante. Valores de status:
ValorSignificado
PENDINGAguardando processamento
COMPLETEConcluído — receiptUrl disponível
CANCELLEDCancelado
REFUNDEDReembolsado

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.

Query Parameters

​
externalId
string
required

Identificador único do payout em seu sistema.

Example:

"saque-123"

Response

Detalhes do payout retornados com sucesso.

​
data
object

Dados da transação de payout.

​
error
string | null
Example:

null

​
success
boolean

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

Example:

true