Skip to main content

📄 Consulta de Extrato

Endpoint para consulta de extrato/transações de uma conta.


Endpoint

GET https://api.intrapay.io/api/financial/v1/account/transactions

Query Parameters

Campos opcionais para filtro/paginação:

  • dateFrom (string, ISO 8601, opcional): Data inicial do filtro.
  • dateTo (string, ISO 8601, opcional): Data final do filtro.
  • limit (integer, opcional): Quantidade máxima de registros (default 10).
  • offset (integer, opcional): Offset para paginação (default 0).

Regras de validação de datas: se um dos campos dateFrom ou dateTo for informado, o outro também deve ser informado; dateFrom não pode ser maior que dateTo.

Cabeçalhos

NomeExemplo
AuthorizationBearer <token_de_acesso>

Exemplo de Response (200)

{
"total": 2,
"results": [
{
"id": "txn_1",
"type": "INCOME",
"amount": 1000.0,
"fee": 10.0,
"status": "CONFIRMED",
"method": "PIX",
"confirmedAt": "2025-02-10T10:00:00.000Z",
"creditor": {
"name": "Empresa XYZ",
"bank": "001",
"documentNumber": "12.345.678/0001-90"
}
},
{
"id": "txn_2",
"type": "OUTCOME",
"amount": -200.0,
"fee": 2.0,
"status": "CONFIRMED",
"method": "TED",
"confirmedAt": "2025-02-11T15:30:00.000Z",
"debtor": {
"name": "Fulano",
"bank": "237",
"documentNumber": "123.456.789-09"
}
}
]
}

Tabela de Erros

CódigoErro
401Token inválido ou expirado
400Requisição inválida (ex.: datas inválidas ou somente uma das datas informada)
404Conta não encontrada
500Erro interno do servidor