Skip to main content
GET
Listar extrato
Retorna todas as transações que movimentaram o saldo da sua conta, da mais recente para a mais antiga.
Requer a permissão BANK_STATEMENT:READ.
Use limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data. O formato de cada item está na referência do extrato. Os filtros status, method e kind aceitam um valor por vez e se aplicam à transação, não às movimentações dentro dela.
Sem status, o extrato esconde transações PENDING. Sem kind, esconde movimentações internas que não alteram o saldo disponível. Ao informar um desses filtros, a regra padrão correspondente deixa de valer: status=PENDING, por exemplo, retorna as transações pendentes.

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 (use o publicId retornado em pagination.next).

before
string

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

limit
integer
default:100

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

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

100

startDate
string<date>

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).

Example:

"2026-01-01"

endDate
string<date>

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).

Example:

"2026-01-31"

status
enum<string>

Filtrar pelo status da transação.

Available options:
PENDING,
APPROVED,
EXPIRED,
CANCELLED,
COMPLETE,
REFUNDED,
REDEEMED,
UNDER_DISPUTE,
FAILED
Example:

"COMPLETE"

method
enum<string>

Filtrar pelo meio da transação.

Available options:
PIX,
PIX_QRCODE,
CARD,
BOLETO,
TED,
INTERNAL
Example:

"PIX"

kind
string

Filtrar pelo tipo da transação. Os mais comuns são DEPOSIT (pagamento recebido), WITHDRAW (saque ou PIX enviado), REFUND (estorno), CARD_APPROVED (recebível de cartão aprovado), SWAP_INTERNAL_CREDIT_CARD_RECEIVED (liquidação do cartão), ANTICIPATION_CREDITED (antecipação creditada) e PLUGIN_FEE (taxa de plugin).

Example:

"DEPOSIT"

Busca pelo ID da transação. Aceita parte do ID e não diferencia maiúsculas de minúsculas.

Example:

"tran_abc123"

Response

Extrato retornado com sucesso.

data
object[]

Transações do extrato.

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.