Statements

A guide on our statements endpoint

Generating accurate and timely statements for accounts is crucial for financial transparency and accountability. With the statement endpoint, users can generate statements asynchronously. A webhook can be configured to notify you when the statement is ready to be downloaded.

Invoking this endpoint, the server will initiate a file transfer, allowing your system or browser to prompt you to save the file. The statement is delivered as an excel sheet with the content type set as an attachment, triggering most HTTP clients or browsers to treat it as a file download.

Headers you might see include:

  • Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • Content-Disposition: attachment; filename="XXXXX.xlsx"

🚧

File Naming:

The default filename is structured as {COMPANY_NAME}__statement_[FROM_DATE]_{TO_DATE}.xlsx. Consider renaming the file upon download if you wish to adhere to specific naming conventions or add more context to the filename.

❗️

Note

Only statements in COMPLETED state can be downloaded else an error is returned when calling the Statement Download endpoint.