Download account statement PDF - HEVN

Download account statement PDF

curl --request GET \
  --url https://api.example.com/api/v1/transactions/export/account_statement/{bank_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/transactions/export/account_statement/{bank_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/transactions/export/account_statement/{bank_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

/

api

/

v1

/

transactions

/

export

/

account_statement

/

{bank_id}

Download account statement PDF

curl --request GET \
  --url https://api.example.com/api/v1/transactions/export/account_statement/{bank_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/transactions/export/account_statement/{bank_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/transactions/export/account_statement/{bank_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key

string | null

Path Parameters

bank_id

string<uuid>

required

Query Parameters

period_start

string<date-time> | null

period_end

string<date-time> | null

format

enum<string>

default:pdf

Output format for the formal account documents (statement / confirmation).

Available options:

pdf,

xlsx

bank_letter

boolean

default:false

Request a provider-issued the banking provider bank letter and return its status with a signed download URL when available.

Response

Successful Response