Skip to main content
GET
Buscar payout
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:

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