ABabacatepay

Listar extrato

Changed on

Retorna as transações que movimentaram o saldo da conta, da mais recente para a mais antiga. Cada item traz as movimentações geradas pela transação, como a entrada do valor e a saída da taxa.

Sem status, transações PENDING ficam de fora. Sem kind, movimentações internas que não alteram o saldo disponível ficam de fora. Informar um desses filtros substitui a regra padrão correspondente.

get/bank-statement/list

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/bank-statement/list
  • Auth
    HTTP bearer

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

status'PENDING' | 'APPROVED' | 'EXPIRED' | 'CANCELLED' | 'COMPLETE' | 'REFUNDED' | 'REDEEMED' | 'UNDER_DISPUTE' | 'FAILED'
Example:COMPLETE

Filtrar pelo status da transação.

method'PIX' | 'PIX_QRCODE' | 'CARD' | 'BOLETO' | 'TED' | 'INTERNAL'
Example:PIX

Filtrar pelo meio da transação.

kindstring
Example:DEPOSIT

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

searchstring
Example:tran_abc123

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

Response

Extrato retornado com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "data": [
    {
      "id": "tran_abc123xyz",
      "movements": [
        {
          "amount": 10000,
          "kind": "DEPOSIT",
          "method": "PIX",
          "description": "Pagamento PIX",
          "category": "transaction",
          "balanceEffect": "credit"
        }
      ],
      "currency": "BRL",
      "createdAt": "2026-09-29T14:32:10.000Z",
      "checkoutId": "bill_abc123xyz",
      "paymentIntentId": "char_abc123xyz",
      "customer": {
        "publicId": "cust_abc123xyz",
        "name": "Maria Silva",
        "email": "maria@exemplo.com",
        "taxId": "11144477735",
        "cellphone": "(11) 99999-9999",
        "zipCode": "01310-100"
      }
    }
  ],
  "success": true
}

Changes