Pix ProcessamentoPix Processamento Docs
Endpoints da APIRelatórios

Listar extrato

GET
/user/bank-statements

Autorização

BearerAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de query

createdAtFrom*string

Data inicial (obrigatória).

Formatodate-time
createdAtTo*string

Data final (obrigatória).

Formatodate-time
id?string
operation?string
Valor em"INCREMENT" | "DECREMENT"
reason?string
transactionId?string
amountFrom?number
amountTo?number
page?integer
Padrão1
Intervalo1 <= value
limit?integer
Padrão10
Intervalo1 <= value <= 100
sortBy?string
Padrão"createdAt"
Valor em"createdAt" | "amount"
sortDirection?string
Padrão"desc"
Valor em"asc" | "desc"

Corpo da resposta

application/json

curl --request GET \  --url 'https://api.exemplo.processamento.com/v1/user/bank-statements?createdAtFrom=2026-08-01T00%3A00%3A00Z&createdAtTo=2026-08-01T00%3A00%3A00Z' \  --header 'Authorization: Bearer $PIX_TOKEN'
{
  "pagination": {
    "page": 1,
    "limit": 10,
    "hasNextPage": true
  },
  "bankStatements": [
    {
      "id": "bs_1",
      "amount": 100,
      "operation": "INCREMENT",
      "reason": "PIX_DEPOSIT",
      "balanceType": "AVAILABLE",
      "previousBalanceAvailable": 400,
      "previousBalanceBlocked": 0,
      "newBalanceAvailable": 500,
      "newBalanceBlocked": 0,
      "transactionId": "PIX2025...",
      "infractionId": null,
      "createdAt": "2026-08-10T12:00:00.000Z",
      "updatedAt": "2026-08-10T12:00:00.000Z"
    }
  ]
}