Statements v1.0.0

Owned by Matthew Bell
Feb 28, 2019
12 min read

Contents

Version Control

Version
Date
Author
Comments
1.0.001 March 2019Payments NZ API Working GroupStatements specification

Endpoints

Endpoints for the resource - and available methods.


ResourceHTTP OperationEndpointMandatory?ScopeGrant TypeIdempotentParametersRequest ObjectResponse Object
1statementsGETGET /accounts/{AccountId}/statementsOptionalaccountsAuthorization Code

Pagination

Filtering


OBReadStatement1
2statementsGETGET /accounts/{AccountId}/statements/{StatementId}OptionalaccountsAuthorization Code

Pagination

Filtering


OBReadStatement1
3statementsGETGET /accounts/{AccountId}/statements/{StatementId}/fileOptionalaccountsAuthorization Code



4transactionsGETGET /accounts/{AccountId}/statements/{StatementId}/transactionsOptionalaccountsAuthorization Code

Pagination

Filtering


OBReadTransaction2
5statementsGETGET /statementsOptionalaccountAuthorization Code

Pagination

Filtering


OBReadStatement1

GET /accounts/{AccountId}/statements

A Financial Institution may provide this endpoint for a Third Party to retrieve the statements information resource for the AccountId (which is retrieved in the call to GET /accounts).

GET /accounts/{AccountId}/statements/{StatementId}

A Financial Institution may provide this endpoint for a Third Party to retrieve the statement information resource for a specific statement in the AccountId (which is retrieved in the call to GET /accounts).

GET /accounts/{AccountId}/statements/{StatementId}/file

A Financial Institution may provide this endpoint for a Third Party to retrieve a non-json representation of a specific statement.

GET /accounts/{AccountId}/statements/{StatementId}/transactions

A Financial Institution may provide this endpoint for a Third Party to retrieve transactions that appear on the selected statement.

The data model for the returned objects is documented in the transactions resource.

GET /statements

A Financial Institution may provide this endpoint for a Third Party to retrieve statement information for all accounts that the Customer has consented to. This will retrieve the statement resources for all authorised accounts linked to the account-request.

Data Model

The OBReadStatement1 object will be used for the call to:

  • GET /statements

  • GET /accounts/{AccountId}/statements

  • GET /accounts/{AccountId}/statements/{StatementId}

The call to

  • GET /accounts/{AccountId}/statements/{StatementId}/file

will return unstructured data in binary (e.g., pdf, doc) or text (e.g., csv) formats. This will be specified in the Accept header by the Third Party.

The OBReadTransactions2 object (documented in the transactions resource) will be used the call to:

  • GET /accounts/{AccountId}/statements/{StatementId}/transactions

Resource Definition

A resource that describes summary details for an account statement period.

For a specific date range - an account (AccountId) may have no statements, or may have multiple statements.

The /statements endpoint (if implemented by the Financial Institution) must return all statements within the requested date range for all accounts selected during the authorisation of the account-request.

If a Third Party would like to access a specific statement (StatementId) to retrieve a formal statement download or transactions for a specific statement - the Third Party must specify the account (the AccountId) via the URI request path - i.e., via:

  • GET /accounts/{AccountId}/statements/{StatementId}/file - to download the statement
  • GET /accounts/{AccountId}/statements/{StatementId}/transactions - to return the transactions relating to a statement

UML Diagram

Notes:

  • The statements resource must only be used for data that can be returned for a statement period.

Filtering

Limited support for filtering is provided on the statements resource.

Statements may be filtered based on their StartDateTime and EndDateTime using the fromStatementDateTime and toStatementDateTime parameters.

The Financial Institution must treat the following as valid input:

  • non-working days (e.g. a Sunday or a Public holiday) or any other days on which no transactions are recorded
  • dates that fall outside the range for which transaction information is provided through APIs
  • dates that fall outside the range for which a consent authorisation is available.

In the above situations, the Financial Institution must return statements where the StartDateTime and EndDateTime are both between the fromStatementDateTime and toStatementDateTime parameters.

Filtering Examples
// All statements from 1st Jan, 2015
GET /statements?fromStatementDateTime=2015-01-01T00:00:00
 
// All statements in 2016
GET /statements?fromStatementDateTime=2016-01-01T00:00:00&toStatementDateTime=2016-12-31T23:59:59
 
// All statements in a specific account up to 31-Mar-2017
GET /accounts/1/statements?toStatementDateTime=2017-03-31T23:59:59

Permission Codes

The resource differs depending on the permissions (ReadStatementsBasic and ReadStatementsDetail) used to access resource (the OBReadStatement1 object). In the event the resource is accessed with both ReadStatementsBasic and ReadStatementsDetail, the most detailed level (ReadStatementsDetail) must be used.

  • These objects must not be returned without the ReadStatementsDetail permission:
  • OBReadStatement1/Data/Statement/StatementAmount
  • Calls to GET /accounts/{AccountId}/statements/{StatementId}/file
  • If the ReadStatementsDetail is granted by the Customer:
    • OBReadStatement1/Data/Statement/StatementAmount may be returned if applicable to the statement and Financial Institution(0..n)

The access to GET /accounts/{AccountId}/statements/{StatementId}/transactions will require the ReadTransactionsBasic or ReadTransactionsDetail (in addition to the appropriate ReadTransactionsCredits and/or ReadTransactionsDebits) permission codes. The Financial Institution must apply the same access to GET /accounts/{AccountId}/statements/{StatementId}/transactions as GET /accounts/{AccountId}/transactions

Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern
OBReadStatement1
OBReadStatement1
OBReadStatement1

Data1..1OBReadStatement1/Data
OBReadDataStatement1

Statement0..nOBReadStatement1/Data/Statement
OBStatement1

AccountId1..1OBReadStatement1/Data/Statement/AccountIdA unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.Max40Text

StatementId0..1OBReadStatement1/Data/Statement/StatementIdUnique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.Max40Text

StatementReference0..1OBReadStatement1/Data/Statement/StatementReferenceUnique reference for the statement. This reference may be optionally populated if available.Max35Text

Type1..1OBReadStatement1/Data/Statement/TypeStatement type, in a coded form.OBExternalStatementType1CodeAccountClosure
AccountOpening
Annual
Interim
RegularPeriodic
StartDateTime1..1OBReadStatement1/Data/Statement/StartDateTimeDate and time at which the statement period starts.ISODateTime

EndDateTime1..1OBReadStatement1/Data/Statement/EndDateTimeDate and time at which the statement period ends.ISODateTime

CreationDateTime1..1OBReadStatement1/Data/Statement/CreationDateTimeDate and time at which the resource was created.ISODateTime

StatementDescription0..nOBReadStatement1/Data/Statement/StatementDescriptionOther descriptions that may be available for the statement resource.Max500Text

StatementBenefit0..nOBReadStatement1/Data/Statement/StatementBenefitSet of elements used to provide details of a benefit or reward amount for the statement resource.OBStatementBenefit1

Type1..1OBReadStatement1/Data/Statement/StatementBenefit/TypeBenefit type, in a coded form.OBExternalStatementBenefitType1CodeCashback
Insurance
TravelDiscount
TravelInsurance
Amount1..1OBReadStatement1/Data/Statement/StatementBenefit/AmountAmount of money associated with the statement benefit type.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStatement1/Data/Statement/StatementBenefit/Amount/AmountA number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.ActiveCurrencyAndAmount_SimpleType
^\d{1,13}\.\d{1,5}$
Currency1..1OBReadStatement1/Data/Statement/StatementBenefit/Amount/CurrencyA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".ActiveOrHistoricCurrencyCode
^[A-Z]{3,3}$
StatementFee0..nOBReadStatement1/Data/Statement/StatementFeeSet of elements used to provide details of a fee for the statement resource.OBStatementFee1

CreditDebitIndicator1..1OBReadStatement1/Data/Statement/StatementFee/CreditDebitIndicatorIndicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.		OBCreditDebitCodeCredit
Debit
Type1..1OBReadStatement1/Data/Statement/StatementFee/TypeFee type, in a coded form.OBExternalStatementFeeType1CodeAnnual
BalanceTransfer
CashAdvance
CashTransaction
ForeignTransaction
Gambling
LatePayment
MoneyTransfer
Monthly
Overlimit
PostalOrder
PrizeEntry
StatementCopy
Total
Amount1..1OBReadStatement1/Data/Statement/StatementFee/AmountAmount of money associated with the statement fee type.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStatement1/Data/Statement/StatementFee/Amount/AmountA number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.ActiveCurrencyAndAmount_SimpleType
^\d{1,13}\.\d{1,5}$
Currency1..1OBReadStatement1/Data/Statement/StatementFee/Amount/CurrencyA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".ActiveOrHistoricCurrencyCode
^[A-Z]{3,3}$
StatementInterest0..nOBReadStatement1/Data/Statement/StatementInterestSet of elements used to provide details of a generic interest amount related to the statement resource.OBStatementInterest1

CreditDebitIndicator1..1OBReadStatement1/Data/Statement/StatementInterest/CreditDebitIndicatorIndicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.		OBCreditDebitCodeCredit
Debit
Type1..1OBReadStatement1/Data/Statement/StatementInterest/TypeInterest amount type, in a coded form.OBExternalStatementInterestType1CodeBalanceTransfer
Cash
EstimatedNext
Purchase
Total
Amount1..1OBReadStatement1/Data/Statement/StatementInterest/AmountAmount of money associated with the statement interest amount type.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStatement1/Data/Statement/StatementInterest/Amount/AmountA number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.ActiveCurrencyAndAmount_SimpleType
^\d{1,13}\.\d{1,5}$
Currency1..1OBReadStatement1/Data/Statement/StatementInterest/Amount/CurrencyA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".ActiveOrHistoricCurrencyCode
^[A-Z]{3,3}$
StatementAmount0..nOBReadStatement1/Data/Statement/StatementAmountSet of elements used to provide details of a generic amount for the statement resource.OBStatementAmount1

CreditDebitIndicator1..1OBReadStatement1/Data/Statement/StatementAmount/CreditDebitIndicatorIndicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.		OBCreditDebitCodeCredit
Debit
Type1..1OBReadStatement1/Data/Statement/StatementAmount/TypeAmount type, in a coded form.OBExternalStatementAmountType1CodeArrearsClosingBalance
AvailableBalance
AverageBalanceWhenInCredit
AverageBalanceWhenInDebit
AverageDailyBalance
BalanceTransferClosingBalance
CashClosingBalance
ClosingBalance
CreditLimit
CurrentPayment
DirectDebitPaymentDue
MinimumPaymentDue
PreviousClosingBalance
PreviousPayment
PurchaseClosingBalance
StartingBalance
TotalAdjustments
TotalCashAdvances
TotalCharges
TotalCredits
TotalDebits
TotalPurchases
Amount1..1OBReadStatement1/Data/Statement/StatementAmount/AmountAmount of money associated with the amount type.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStatement1/Data/Statement/StatementAmount/Amount/AmountA number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.ActiveCurrencyAndAmount_SimpleType
^\d{1,13}\.\d{1,5}$
Currency1..1OBReadStatement1/Data/Statement/StatementAmount/Amount/CurrencyA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".ActiveOrHistoricCurrencyCode
^[A-Z]{3,3}$
StatementDateTime0..nOBReadStatement1/Data/Statement/StatementDateTimeSet of elements used to provide details of a generic date time for the statement resource.OBStatementDateTime1

DateTime1..1OBReadStatement1/Data/Statement/StatementDateTime/DateTimeDate and time associated with the date time type.ISODateTime

Type1..1OBReadStatement1/Data/Statement/StatementDateTime/TypeDate time type, in a coded form.OBExternalStatementDateTimeType1CodeBalanceTransferPromoEnd
DirectDebitDue
LastPayment
LastStatement
NextStatement
PaymentDue
PurchasePromoEnd
StatementAvailable
StatementRate0..nOBReadStatement1/Data/Statement/StatementRateSet of elements used to provide details of a generic rate related to the statement resource.OBStatementRate1

Rate1..1OBReadStatement1/Data/Statement/StatementRate/RateRate associated with the statement rate type.Max10Text
^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
Type1..1OBReadStatement1/Data/Statement/StatementRate/TypeStatement rate type, in a coded form.OBExternalStatementRateType1CodeAnnualBalanceTransfer
AnnualBalanceTransferAfterPromo
AnnualBalanceTransferPromo
AnnualCash
AnnualPurchase
AnnualPurchaseAfterPromo
AnnualPurchasePromo
MonthlyBalanceTransfer
MonthlyCash
MonthlyPurchase
StatementValue0..nOBReadStatement1/Data/Statement/StatementValueSet of elements used to provide details of a generic number value related to the statement resource.OBStatementValue1

Value1..1OBReadStatement1/Data/Statement/StatementValue/ValueValue associated with the statement value type.Number

Type1..1OBReadStatement1/Data/Statement/StatementValue/TypeStatement value type, in a coded form.OBExternalStatementValueType1CodeAirMilesPoints
AirMilesPointsBalance
Credits
Debits
HotelPoints
HotelPointsBalance
RetailShoppingPoints
RetailShoppingPointsBalance

Enumerations

This section gives the definitions for enumerations used.

Code Class
Name
Definition
OBExternalStatementType1Code

AccountOpening

First statement provided for an account.

OBExternalStatementType1Code

RegularPeriodic

Regular pre-agreed reporting statement.

OBExternalStatementType1Code

Annual

Annual statement report.

OBExternalStatementType1Code

Interim

Adhoc or customised statement period.

OBExternalStatementType1Code

AccountClosure

Final account closure statement.




OBExternalStatementAmountType1CodePreviousClosingBalanceThe closing balance of the previous statement.
OBExternalStatementAmountType1CodeStartingBalanceThe new balance or starting balance carried forward since last statement period.
OBExternalStatementAmountType1CodeAvailableBalanceThe available balance is the difference between the credit limit and the account balance – how much is avaialble to spend.
OBExternalStatementAmountType1CodeClosingBalanceThe ending balance or closing balance at the end of the current statement period.
OBExternalStatementAmountType1CodeArrearsClosingBalanceThe balance that is in arrears at the end of the statement period.
OBExternalStatementAmountType1CodeCashClosingBalanceThe component of balance that relates to cash at the end of the statement period.
OBExternalStatementAmountType1CodePurchaseClosingBalanceThe component of balance that relates to purchases at the end of the statement period.
OBExternalStatementAmountType1CodeBalanceTransferClosingBalanceThe component of balance that relates to balance transfers at the end of the statement period.
OBExternalStatementAmountType1CodeCreditLimitThe credit limit is the total amount of credit available to a borrower, including any amount already borrowed.
OBExternalStatementAmountType1CodePreviousPaymentThe previous payment amount in the last statement period.
OBExternalStatementAmountType1Code

DirectDebitPaymentDue

The total direct debit payments due for current statement period.
OBExternalStatementAmountType1CodeCurrentPaymentThe total payments received since the last period.
OBExternalStatementAmountType1CodeMinimumPaymentDueThe minimum payment required for the current statement period.
OBExternalStatementAmountType1CodeTotalPurchasesThe total transactions made during that statement period.
OBExternalStatementAmountType1CodeTotalCreditsTotal amount credited in the account during the statement period.
OBExternalStatementAmountType1CodeTotalDebitsTotal amount debited (money taken out from account) from the account during the statement period.
OBExternalStatementAmountType1CodeTotalCashAdvancesA cash advance is a short-term loan from a bank or alternative lender. The term also refers to a service provided by many credit card issuers allowing cardholders to withdraw a certain amount of cash. 
OBExternalStatementAmountType1CodeTotalAdjustmentsTotal adjustments to the account during the statement period.
OBExternalStatementAmountType1CodeTotalChargesThe total charges including interest, late payment fee during the statement period.
OBExternalStatementAmountType1CodeAverageBalanceWhenInCreditThe average daily balance when the account is in crebit during the statement period.
OBExternalStatementAmountType1CodeAverageBalanceWhenInDebitThe average daily balance when the account is in debit during the statement period.
OBExternalStatementAmountType1CodeAverageDailyBalanceThe average daily balance during the statement period. An average daily balance adds the closing balances at the end of each day in a given period of time and divides the sum by the number of calendar days in that period.



OBExternalStatementDateTimeType1CodePaymentDueThe date than an account holder must make the payment for the current statement period. 
OBExternalStatementDateTimeType1CodeLastStatementThe date on which the last statement was made available to account holder.
OBExternalStatementDateTimeType1CodeLastPaymentThe date than an account holder must make the payment for the previous statement period. 
OBExternalStatementDateTimeType1CodeStatementAvailableThe date on which the current statement was made available to account holder.
OBExternalStatementDateTimeType1CodePurchasePromoEndThe date the purchase promo rate will end.
OBExternalStatementDateTimeType1CodeBalanceTransferPromoEndThe date the balance transfer promo rate will end.
OBExternalStatementDateTimeType1CodeNextStatementThe date on which the next statement will be made available to account holder.
OBExternalStatementDateTimeType1CodeDirectDebitDueThe date that the direct debit payment is due for the current statement. 



OBExternalStatementInterestType1CodeCashInterest on cash advances.
OBExternalStatementInterestType1CodePurchaseInterest on purchases.
OBExternalStatementInterestType1CodeBalanceTransferInterest on balance transfers.
OBExternalStatementInterestType1CodeTotalTotal interest charges during the statement period.
OBExternalStatementInterestType1CodeEstimatedNextThe estimated interest that will be charged if the closing balance is not paid in full.



OBExternalStatementRateType1CodeMonthlyPurchaseMonthly interest rate charged on purchases.
OBExternalStatementRateType1CodeAnnualPurchaseAnnual interest rate charged on purchases.
OBExternalStatementRateType1CodeMonthlyCashMonthly interest rate charged on cash advance.
OBExternalStatementRateType1CodeAnnualCashAnnual interest rate charged on cash advance.
OBExternalStatementRateType1CodeMonthlyBalanceTransferMonthly interest rate charged on balance transfer from other service provider.
OBExternalStatementRateType1CodeAnnualBalanceTransferAnnual interest rate charged on balance transfer from other service provider.
OBExternalStatementRateType1CodeAnnualBalanceTransferPromoAnnual interest rate charged on balance transfer from other service provider during promotional period.
OBExternalStatementRateType1CodeAnnualPurchasePromoAnnual interest rate charged on purchases from during promotional period.
OBExternalStatementRateType1CodeAnnualBalanceTransferAfterPromoAnnual interest rate charged on balance transfer from other service provider after promotional period.
OBExternalStatementRateType1CodeAnnualPurchaseAfterPromoAnnual interest rate charged on purchases from after promotional period.



OBExternalStatementFeeType1CodeOverlimitOver limit fees charged during the statement period..
OBExternalStatementFeeType1CodeLatePaymentLate payment fees charged during the statement period.
OBExternalStatementFeeType1CodeTotalTotal fees charges during the statement period.
OBExternalStatementFeeType1CodeMonthlyMonthly account fees charged during the statement period.
OBExternalStatementFeeType1CodeBalanceTransferBalance transfer fees charged during the statement period.
OBExternalStatementFeeType1CodeCashAdvanceCash advance fees charged during the statement period.
OBExternalStatementFeeType1CodeCashTransactionCash transaction fees charged during the statement period.
OBExternalStatementFeeType1CodeGamblingGambling transaction fees charged during the statement period.
OBExternalStatementFeeType1CodePostalOrderPostal order fees charged during the statement period.
OBExternalStatementFeeType1CodePrizeEntryPrize entry fees charged during the statement period.
OBExternalStatementFeeType1CodeForeignTransactionForeign transaction fees charged during the statement period.
OBExternalStatementFeeType1CodeAnnualAnnual fees charged during the statement period.
OBExternalStatementFeeType1CodeStatementCopyStatement copy fees charged during the statement period.
OBExternalStatementFeeType1CodeMoneyTransferMoney transfer fees charged during the statement period.



OBExternalStatementBenefitType1CodeCashbackCash back amount received during the statement period.
OBExternalStatementBenefitType1CodeTravelDiscountTrave discound amount received during the statement period.
OBExternalStatementBenefitType1CodeTravelInsuranceTravel insurance amount during the statement period.
OBExternalStatementBenefitType1CodeInsuranceInsurance amount during the statement period.



OBExternalStatementValueType1CodeCreditsTotal number of credits in statement period.
OBExternalStatementValueType1CodeDebitsTotal number of debits in statement period.
OBExternalStatementValueType1CodeHotelPointsHotel points at the end of the statement period.
OBExternalStatementValueType1CodeAirMilesPointsAir miles points at the end of the statement period.
OBExternalStatementValueType1CodeRetailShoppingPointsRetail shopping points at the end of the statement period.
OBExternalStatementValueType1CodeHotelPointsBalanceHotel points at the end of the statement period.
OBExternalStatementValueType1CodeAirMilesPointsBalanceAir miles points at the end of the statement period.
OBExternalStatementValueType1CodeRetailShoppingPointsBalanceRetail shopping points at the end of the statement period.



OBCreditDebitCodeCreditOperation is a credit
OBCreditDebitCodeDebitOperation is a debit

Usage Examples

Specific Account

Request

Get Account Statements Request
GET /accounts/22289/statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Get Account Statements Response
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "Statement": [
    {
      "AccountId": "22289",
      "StatementId": "8sfhke-sifhkeuf-97813",
      "StatementReference": "002",
      "Type": "RegularPeriodic",
      "StartDateTime": "2017-08-01T00:00:00+00:00",
      "EndDateTime": "2017-08-31T23:59:59+00:00",
      "CreationDateTime": "2017-09-01T00:00:00+00:00",
      "StatementDescription": ["August 2017 Statement", "One Free Uber Ride"],
      "StatementAmount": [
      {
        "Amount": {
          "Amount": "400.00",
          "Currency": "NZD"
        },
		"CreditDebitIndicator": "Credit",        
		"Type": "ClosingBalance"        
      }, 
      {
        "Amount": {
          "Amount": "600.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      }
      ]
    }, 
    {
      "AccountId": "22289",
      "StatementId": "34hj24u-324h33-31i3p4",
      "StatementReference": "003",
      "Type": "RegularPeriodic",
      "StartDateTime": "2017-09-01T00:00:00+00:00",
      "EndDateTime": "2017-09-30T23:59:59+00:00",
      "CreationDateTime": "2017-10-01T00:00:00+00:00",
      "StatementDescription": ["September 2017 Statement"],
      "StatementAmount": [
      {
        "Amount": {
          "Amount": "200.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      },
      {
        "Amount": {
          "Amount": "400.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      }
      ]
    }],
    "Links": {
      "Self": "https://api.examplebank.co.nz/open-banking-nz/v1.0/accounts/22289/statements/"
    },
    "Meta": {
      "TotalPages": 1
    }
  }
}

Bulk

Request

Get Statements Request
GET /statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Get Statements Response
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
  "Data": {
    "Statement": [
    {
      "AccountId": "22289",
      "StatementId": "8sfhke-sifhkeuf-97813",
      "StatementReference": "002",
      "Type": "RegularPeriodic",
      "StartDateTime": "2017-08-01T00:00:00+00:00",
      "EndDateTime": "2017-08-31T23:59:59+00:00",
      "CreationDateTime": "2017-09-01T00:00:00+00:00",
      "StatementDescription": ["August 2017 Statement", "One Free Uber Ride"],
      "StatementAmount": [
      {
        "Amount": {
          "Amount": "400.00",
          "Currency": "NZD"
        },
		"CreditDebitIndicator": "Credit",        
		"Type": "ClosingBalance"        
      }, 
      {
        "Amount": {
          "Amount": "600.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      }
      ]
    }, 
    {
      "AccountId": "22289",
      "StatementId": "34hj24u-324h33-31i3p4",
      "StatementReference": "003",
      "Type": "RegularPeriodic",
      "StartDateTime": "2017-09-01T00:00:00+00:00",
      "EndDateTime": "2017-09-30T23:59:59+00:00",
      "CreationDateTime": "2017-10-01T00:00:00+00:00",
      "StatementDescription": ["September 2017 Statement"],
      "StatementAmount": [
      {
        "Amount": {
          "Amount": "200.00",
          "Currency": "NZD"
        },
		"CreditDebitIndicator": "Credit",        
		"Type": "ClosingBalance"        
      }, 
      {
        "Amount": {
          "Amount": "400.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      }
      ]
    }, 
    {
      "AccountId": "32389",
      "StatementId": "9034ee-4ewa4e-342er6",
      "StatementReference": "002",
      "Type": "RegularPeriodic",
      "StartDateTime": "2017-09-01T00:00:00+00:00",
      "EndDateTime": "2017-09-30T23:59:59+00:00",
      "CreationDateTime": "2017-10-01T00:00:00+00:00",
      "StatementAmount": [
      {
        "Amount": {
          "Amount": "2700.00",
          "Currency": "NZD"
        },
		"CreditDebitIndicator": "Credit",        
		"Type": "ClosingBalance"        
      }, 
      {
        "Amount": {
          "Amount": "4060.00",
          "Currency": "NZD"
        },
        "CreditDebitIndicator": "Credit",
        "Type": "PreviousClosingBalance"
      }
      ]
    }
    ],
    "Links": {
      "Self": "https://api.examplebank.co.nz/open-banking-nz/v1.0/statements/"
    },
    "Meta": {
      "TotalPages": 1
    }
  }
}