Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Statements

Get a statement

Gets a full statement by its ID.

get/statements/{statement_id}

Path parameters

statement_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique identifier of a statement

Response

statement

account_idstring uuid

The unique identifier of the account the statement belongs to

due_datestring date

The limit date when the due amount indicated on the statement should be paid

end_datestring date

The date indicating the ending of the time interval covered by the statement

idstring uuid

statement ID

issue_datestring date

The date when the statement has been issued

start_datestring date

The date indicating the beginning of the time interval covered by the statement

closing_balanceinteger

The account balance at the end of the statement period, in ISO 4217 minor currency units.

disclosurestring
opening_balanceinteger

The account balance at the start of the statement period, in ISO 4217 minor currency units.

transactions_omittedboolean

Only appears in statement.created webhook payloads. Indicates that the transactions attribute was emptied due to webhook size constraints. If this attribute returns true, you may use GET /v0/statements/{statement_id}/transactions to retrieve the full list.

Example response

{
  "savings_summary": {
    "apy": 5.5,
    "interest_earned": 150,
    "interest_earned_previous_month": 150,
    "interest_earned_previous_year": 10000,
    "interest_earned_ytd": 10000
  },
  "account_summary": {
    "currency": "USD"
  },
  "transactions": [
    {
      "data": {
        "lines": [
          {
            "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
          }
        ]
      }
    }
  ]
}