Skip to main content
GET
/
payouts
/
list
Listar payouts
curl --request GET \
  --url https://api.abacatepay.com/v2/payouts/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "tran_123456",
      "status": "PENDING",
      "devMode": true,
      "receiptUrl": "https://abacatepay.com/receipt/tran_123456",
      "kind": "WITHDRAW",
      "amount": 5000,
      "platformFee": 80,
      "createdAt": "2025-03-24T21:50:20.772Z",
      "updatedAt": "2025-03-24T21:50:20.772Z",
      "externalId": "withdraw-1234"
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}

Requer a permissão WITHDRAW:READ.

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

​
after
string

Cursor para buscar itens após este ponto

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

Quantidade de itens por página (1-100)

Required range: 1 <= x <= 100
Example:

100

​
id
string

Filtrar por identificador único da transação

Example:

"tran_123456"

​
externalId
string

Filtrar por identificador do payout no seu sistema

Example:

"saque-123"

​
status
enum<string>

Filtrar por status da transação

Available options:
PENDING,
EXPIRED,
CANCELLED,
COMPLETE,
REFUNDED

Response

Lista de payouts retornada com sucesso.

​
data
object[]

Lista de saques criados.

​
success
boolean

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

Example:

true

​
error
string | null
Example:

null

​
pagination
object

Informações de paginação baseada em cursor.