Export transactions, a statement, a confirmation or a receipt

Without kind the filtered transaction list is exported as csv, xlsx or pdf. kind=statement and kind=confirmation need bankId and support pdf or xlsx; kind=receipt needs transactionId and answers pdf.

GET /transactions/export

Export transactions, a statement, a confirmation or a receipt

cURL

curl --request GET \
  --url https://api.hevn.finance/dapi/v1/transactions/export \
  --header 'Authorization: Bearer <token>'

200

"<string>"

Authorizations

Authorization · string · header · required

Platform access token from POST /auth/token, carrying the platform audience and the developer_key_id of the registration that minted it. It acts as your own account; name a client you created with X-Hevn-Account: cl_…. Every request re-checks that the registration is still active and that the caller's source IP is inside its allowlist. A token is valid only against the server that issued it, so sandbox tokens are refused in production and production tokens in the sandbox.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Query Parameters

format · enum<string> · default: csv

Available options: csv, xlsx, pdf

kind · enum<string> | null

Available options: statement, confirmation, receipt

bankId · string | null

transactionId · string | null

type · string | null

Comma-separated transaction types

status · string | null

Comma-separated statuses

tag · string | null

Comma-separated tags

contactId · string | null

incomeOnly · boolean | null

q · string | null

Minimum string length: 2

from · string<date-time> | null

to · string<date-time> | null

Response

200

text/csv

The rendered file, with a Content-Disposition naming it.

The response is of type file.