v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar payouts

Permite que você recupere uma lista de todos os payouts criados com suporte a paginação.

get/payouts/list

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

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

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:tran_123456

Filtrar por identificador único da transação

externalIdstring

Example:saque-123

Filtrar por identificador do payout no seu sistema

status'PENDING' | 'EXPIRED' | 'CANCELLED' | 'COMPLETE' | 'REFUNDED'

Filtrar por status da transação

Response

Lista de payouts retornada com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "data": [
    {
      "id": "tran_123456",
      "status": "PENDING",
      "devMode": true,
      "receiptUrl": "https://abacatepay.com/receipt/tran_123456",
      "kind": "WITHDRAW",
      "amount": 5000,
      "platformFee": 80,
      "externalId": "withdraw-1234",
      "createdAt": "2025-03-24T21:50:20.772Z",
      "updatedAt": "2025-03-24T21:50:20.772Z"
    }
  ],
  "success": true
}