Download Statements

Download Statements

This endpoint retrieves financial statements for a customer's account within the Netevia Banking platform. Partners can request statements for a specific financial account and billing period, receiving the document content encoded in the response. Supported output formats include PDF, CSV, QBO, and OFX to accommodate a variety of reporting and accounting needs.

Endpoint

GET /netevia/statements

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a customer needs to download a record of their account activity for a specific period — for example, for tax preparation, expense reconciliation, or audit purposes. It is also useful for partners building reporting dashboards that surface statement history directly within their application. The response returns encoded file content that can be rendered, saved, or forwarded to end users.

Query Parameters

ParameterTypeRequiredDescription
profileIdinteger (int32)NoThe numeric identifier of the customer profile whose statement is being requested.
financialAccountIdstringNoThe unique identifier of the financial account for which the statement should be generated.
periodstring (date-time)NoThe billing period for the statement, formatted as an ISO 8601 date-time value (e.g., 2024-01-01T00:00:00Z).
fileFormatstring (enum)NoThe desired output format for the statement. Accepted values: PDF, CSV, QBO, OFX.

Response

200 OK

FieldTypeDescription
namestringThe filename of the generated statement document (e.g., statement_jan2024.pdf).
contentstringThe base64-encoded content of the statement file. Decode this value to obtain the raw file bytes.
contentTypestringThe MIME type of the returned file (e.g., application/pdf, text/csv).
{
  "name": "statement_2024-01.pdf",
  "content": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3Ro...",
  "contentType": "application/pdf"
}

Error Codes

CodeWhen it happens
400Missing required fields or validation error
401Token missing, expired, or invalid
403Insufficient permissions
404Resource not found
500Internal server error

Common Mistakes

  • Passing an incorrectly formatted period value — ensure it follows ISO 8601 date-time format (e.g., 2024-01-01T00:00:00Z), not a plain date string.
  • Requesting a fileFormat value outside the accepted enum (PDF, CSV, QBO, OFX) — any other value will result in a validation error.
  • Attempting to access a financialAccountId that does not belong to the specified profileId — always ensure the account is associated with the correct customer profile.
  • Failing to decode the content field — the returned file content is base64-encoded and must be decoded before saving or rendering.

Related Endpoints

  • GET /netevia/transactions — Retrieve a list of individual transactions for a financial account
  • GET /netevia/account — Retrieve details of a specific financial account
  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X GET "https://api.banking.netevia.dev/netevia/statements?profileId=100123&financialAccountId=fa_XXXXXXXXXX&period=2024-01-01T00%3A00%3A00Z&fileFormat=PDF" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
int32
string
date-time
string
enum
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json