BizKitHub
DocsAPI ReferenceBank Statement/bff/bank-statement/download
postBank StatementAdmin BFF

/bff/bank-statement/download

Idempotent per (bank account, year, month) — a second call returns already-exists. Wraps the same worker the daily cron uses. Useful after fixing a broken Fio connector or when a statement is missing for an edge-case periodicity. not-ready means Fio has not generated the PDF yet (retry on a later day); rate-limited means Fio's 30s/token throttle fired twice in a row.

Bank statementpostBffBank-statementDownload

Parameters

JSON body

Request body

application/json
bankAccountExternalIdstringRequired

16-char external id of the target bank account.

yearnumberRequired

Calendar year of the statement period.

monthnumberRequired

Calendar month (1-12) of the statement period.

Range: 1–12

Response schema

1 status code documented

200Success
object | object | object | object | object | object | object
One of 7:
Variant 1
status"downloaded"Required
byteSizenumberRequired
Variant 2
status"already-exists"Required
Variant 3
status"not-ready"Required
Variant 4
status"no-such-statement"Required
messagestringRequired
Variant 5
status"invalid"Required
messagestringRequired
Variant 6
status"rate-limited"Required
Variant 7
status"error"Required
messagestringRequired

Response example

application/json
{
  "status": "downloaded",
  "byteSize": 0
}

Request example

POST /bff/bank-statement/download

post
curl -X POST "https://api.bizkithub.com/bff/bank-statement/download" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "bankAccountExternalId": "example_bankAccountExternalId",
  "year": 0,
  "month": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key