GRgriffin
Statements

Request bank account statement

Changed on

Requests a statement of the bank account's transactions from start-date to end-date, both inclusive. The end-date can't be before the start-date, and the period must have ended: the end-date must be before today in UK time (Europe/London).

Sandbox bank accounts can't have griffin-pdf statements. A griffin-pdf statement carries Griffin's branding, and sandbox activity is simulated, so we don't produce one that could be taken for a genuine bank statement. Sandbox accounts can request any other format, such as xero-csv.

The statement is created pending, and its document is generated in the background. Fetch the statement to see when it is ready to download.

post/v0/bank/accounts/{bank-account-id}/statements

Request

  • Base URL
    https://api.griffin.com
  • Auth
    API key in header Authorization

Path parameters

bank-account-idstring required

Request body

format'xero-csv' | 'griffin-pdf' required

The format of the statement's document.

start-datestring date required

The first day covered by the statement, inclusive.

end-datestring date required

The last day covered by the statement, inclusive.

Response

Created

format'xero-csv' | 'griffin-pdf' required

The format of the statement's document.

start-datestring date required

The first day covered by the statement, inclusive.

end-datestring date required

The last day covered by the statement, inclusive.

status'pending' | 'generated' | 'failed' required

pending while the document is being generated, then generated when it is ready to download.

created-atstring date-time required

When the statement was requested.

Changes