1 Version Control
2 Definition
3 Endpoints
4 Data Model
- 4.1 UML Diagram
  - 4.1.1 OBStatement1
  - 4.1.2 OBReadStatement1
  - 4.1.3 OBReadStatement2
- 4.2 Notes
- 4.3 Filtering
  - 4.3.1 Filtering Examples
- 4.4 Permission Codes
- 4.5 Data Dictionary
  - 4.5.1 OBStatement1
  - 4.5.2 OBReadStatement1
  - 4.5.3 OBReadStatement2
- 4.6 Enumerations
5 Usage Examples
- 5.1 Specific Account
  - 5.1.1 Request
    - 5.1.1.1 Get Account Statements Request
  - 5.1.2 Response
    - 5.1.2.1 Get Account Statements Response
- 5.2 Bulk
  - 5.2.1 Request
    - 5.2.1.1 Get Statements Request
  - 5.2.2 Response
    - 5.2.2.1 Get Statements Response

Version Control

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 API Provider) must return all statements within the requested date range for all accounts selected during the authorisation of the account-access-consent.

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

Endpoints

Resource	Endpoint	Mandatory?	Scope	Grant Type	Idempotency Key	Parameters	Request Object	Response Object

Resource	Endpoint	Mandatory?	Scope	Grant Type	Idempotency Key	Parameters	Response Object
statements	GET /accounts/{AccountId}/statements	Mandatory	accounts	Redirect Flow; or Decoupled Flow	No	Pagination Filtering	OBReadStatement1
statements	GET /accounts/{AccountId}/statements/{StatementId}	Mandatory	accounts	Redirect Flow; or Decoupled Flow	No	Pagination Filtering	OBReadStatement2
statements	GET /accounts/{AccountId}/statements/{StatementId}/file	Mandatory	accounts	Redirect Flow; or Decoupled Flow	No
transactions	GET /accounts/{AccountId}/statements/{StatementId}/transactions	Mandatory	accounts	Redirect Flow; or Decoupled Flow	No	Pagination Filtering	OBReadTransaction2
statements	GET /statements	Optional	account	Redirect Flow; or Decoupled Flow	No	Pagination Filtering	OBReadStatement1

GET /accounts/{AccountId}/statements

The API endpoint allows a Third Party to retrieve the statements for a specific account identified by AccountId.

The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).

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

The API endpoint allows a Third Party to retrieve a specific statement identified by StatementId and specific account identified by AccountId.

The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).

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

The API endpoint allows a Third Party to retrieve a non-json representation of a specific statement identified by StatementId for a specific account identified by AccountId.

The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).

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

The API endpoint allows a Third Party to retrieve the transactions for a specific statement identified by StatementId and specific account identified by AccountId.

The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).
This retrieves the transactions that appear on the selected statement identified by StatementId.
The data model for the returned objects is documented in the transactions resource.

GET /statements

The API endpoint allows a Third Party to retrieve statements in bulk, if an API Provider has implemented the bulk retrieval endpoints.

The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).
This will retrieve the statements for all accounts linked to the account-access-consent.

Data Model

The OBReadStatement1 object will be used for the call to:

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

The OBReadStatement2 object will be used for the call to:

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

Both OBReadStatement1 and OBReadStatement2 use the OBStatement1 class. However, the OBReadStatement2 has a single OBStatement1 object within the Data object; whereas the OBReadStatement1 object allows for an array of OBStatement1 objects.

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. The format of the data 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

UML Diagram

OBStatement1

OBReadStatement1

OBReadStatement2

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.

Name	Occurrence	Enhanced Definition	Class

Name	Occurrence	Enhanced Definition	Class
fromStatementDateTime	0..1	Specifies start date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the start date will be open ended	ISODateTime
toStatementDateTime	0..1	Specifies end date and time for filtering of the Statements on the Statement/EndDateTimefield. If this is not populated, the end date will be open ended	ISODateTime

The API Provider 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
Timezone may be included in the filter request - but must be ignored by the API Provider

In the above situations, the API Provider 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 response 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:

OBStatement1/StatementAmount
Calls to GET /accounts/{AccountId}/statements/{StatementId}/file

If the ReadStatementsDetail is granted by the Customer:

OBStatement1/StatementAmount may be returned if applicable to the statement and API Provider (0..n)

For the call to GET /accounts/{AccountId}/statements/{StatementId}/transactions:

TheReadTransactionsBasic or ReadTransactionsDetail (in addition to the appropriate ReadTransactionsCredits and/or ReadTransactionsDebits) permission codes will be required. The API Provider must apply the same access to GET /accounts/{AccountId}/statements/{StatementId}/transactions as GET /accounts/{AccountId}/transactions

Data Dictionary

OBStatement1

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern
OBStatement1		OBStatement1	Provides further details on a statement resource.	OBStatement1
AccountId	1..1	OBStatement1/AccountId	A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.	Max40Text
StatementId	0..1	OBStatement1/StatementId	Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.	Max40Text
StatementReference	0..1	OBStatement1/StatementReference	Unique reference for the statement. This reference may be optionally populated if available.	Max35Text
Type	1..1	OBStatement1/Type	Statement type, in a coded form.	OBExternalStatementType1Code	AccountClosure AccountOpening Annual Interim RegularPeriodic
StartDateTime	1..1	OBStatement1/StartDateTime	Date and time at which the statement period starts.	ISODateTime
EndDateTime	1..1	OBStatement1/EndDateTime	Date and time at which the statement period ends.	ISODateTime
CreationDateTime	1..1	OBStatement1/CreationDateTime	Date and time at which the resource was created.	ISODateTime
StatementDescription	0..n	OBStatement1/StatementDescription	Other descriptions that may be available for the statement resource.	Max500Text
StatementBenefit	0..n	OBStatement1/StatementBenefit	Set of elements used to provide details of a benefit or reward amount for the statement resource.	OBStatementBenefit1
Type	1..1	OBStatement1/StatementBenefit/Type	Benefit type, in a coded form.	OBExternalStatementBenefitType1Code	Cashback Insurance TravelDiscount TravelInsurance
Amount	1..1	OBStatement1/StatementBenefit/Amount	Amount of money associated with the statement benefit type.	OBActiveOrHistoricCurrencyAndAmount
Amount	1..1	OBStatement1/StatementBenefit/Amount/Amount	A 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}$
Currency	1..1	OBStatement1/StatementBenefit/Amount/Currency	A 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}$
StatementFee	0..n	OBStatement1/StatementFee	Set of elements used to provide details of a fee for the statement resource.	OBStatementFee1
CreditDebitIndicator	1..1	OBStatement1/StatementFee/CreditDebitIndicator	Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.	OBCreditDebitCode	Credit Debit
Type	1..1	OBStatement1/StatementFee/Type	Fee type, in a coded form.	OBExternalStatementFeeType1Code	Annual BalanceTransfer CashAdvance CashTransaction ForeignTransaction Gambling LatePayment MoneyTransfer Monthly Overlimit PostalOrder PrizeEntry StatementCopy Total
Amount	1..1	OBStatement1/StatementFee/Amount	Amount of money associated with the statement fee type.	OBActiveOrHistoricCurrencyAndAmount
Amount	1..1	OBStatement1/StatementFee/Amount/Amount	A 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}$
Currency	1..1	OBStatement1/StatementFee/Amount/Currency	A 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}$
StatementInterest	0..n	OBStatement1/StatementInterest	Set of elements used to provide details of a generic interest amount related to the statement resource.	OBStatementInterest1
CreditDebitIndicator	1..1	OBStatement1/StatementInterest/CreditDebitIndicator	Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.	OBCreditDebitCode	Credit Debit
Type	1..1	OBStatement1/StatementInterest/Type	Interest amount type, in a coded form.	OBExternalStatementInterestType1Code	BalanceTransfer Cash EstimatedNext Purchase Total
Amount	1..1	OBStatement1/StatementInterest/Amount	Amount of money associated with the statement interest amount type.	OBActiveOrHistoricCurrencyAndAmount
Amount	1..1	OBStatement1/StatementInterest/Amount/Amount	A 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}$
Currency	1..1	OBStatement1/StatementInterest/Amount/Currency	A 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}$
StatementAmount	0..n	OBStatement1/StatementAmount	Set of elements used to provide details of a generic amount for the statement resource.	OBStatementAmount1
CreditDebitIndicator	1..1	OBStatement1/StatementAmount/CreditDebitIndicator	Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.	OBCreditDebitCode	Credit Debit
Type	1..1	OBStatement1/StatementAmount/Type	Amount type, in a coded form.	OBExternalStatementAmountType1Code	ArrearsClosingBalance AvailableBalance AverageBalanceWhenInCredit AverageBalanceWhenInDebit AverageDailyBalance BalanceTransferClosingBalance CashClosingBalance ClosingBalance CreditLimit CurrentPayment DirectDebitPaymentDue MinimumPaymentDue PreviousClosingBalance PreviousPayment PurchaseClosingBalance StartingBalance TotalAdjustments TotalCashAdvances TotalCharges TotalCredits TotalDebits TotalPurchases
Amount	1..1	OBStatement1/StatementAmount/Amount	Amount of money associated with the amount type.	OBActiveOrHistoricCurrencyAndAmount
Amount	1..1	OBStatement1/StatementAmount/Amount/Amount	A 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}$
Currency	1..1	OBStatement1/StatementAmount/Amount/Currency	A 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}$
StatementDateTime	0..n	OBStatement1/StatementDateTime	Set of elements used to provide details of a generic date time for the statement resource.	OBStatementDateTime1
DateTime	1..1	OBStatement1/StatementDateTime/DateTime	Date and time associated with the date time type.	ISODateTime
Type	1..1	OBStatement1/StatementDateTime/Type	Date time type, in a coded form.	OBExternalStatementDateTimeType1Code	BalanceTransferPromoEnd DirectDebitDue LastPayment LastStatement NextStatement PaymentDue PurchasePromoEnd StatementAvailable
StatementRate	0..n	OBStatement1/StatementRate	Set of elements used to provide details of a generic rate related to the statement resource.	OBStatementRate1
Rate	1..1	OBStatement1/StatementRate/Rate	Rate associated with the statement rate type.	Max10Text		^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
Type	1..1	OBStatement1/StatementRate/Type	Statement rate type, in a coded form.	OBExternalStatementRateType1Code	AnnualBalanceTransfer AnnualBalanceTransferAfterPromo AnnualBalanceTransferPromo AnnualCash AnnualPurchase AnnualPurchaseAfterPromo AnnualPurchasePromo MonthlyBalanceTransfer MonthlyCash MonthlyPurchase
StatementValue	0..n	OBStatement1/StatementValue	Set of elements used to provide details of a generic number value related to the statement resource.	OBStatementValue1
Value	1..1	OBStatement1/StatementValue/Value	Value associated with the statement value type.	Number
Type	1..1	OBStatement1/StatementValue/Type	Statement value type, in a coded form.	OBExternalStatementValueType1Code	AirMilesPoints AirMilesPointsBalance Credits Debits HotelPoints HotelPointsBalance RetailShoppingPoints RetailShoppingPointsBalance

OBReadStatement1

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern

Name	Occurrence	XPath	Class
OBReadStatement1		OBReadStatement1	OBReadStatement1
Data	1..1	OBReadStatement1/Data	OBReadDataStatement1
Statement	0..n	OBReadStatement1/Data/Statement	OBStatement1

OBReadStatement2

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern

Name	Occurrence	XPath	Class
OBReadStatement2		OBReadStatement2	OBReadStatement2
Data	1..1	OBReadStatement2/Data	OBReadDataStatement2
Statement	1..1	OBReadStatement2/Data/Statement	OBStatement1

Enumerations

This section gives the definitions for enumerations used.

Code Class	Name	Definition

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.

OBExternalStatementAmountType1Code	PreviousClosingBalance	The closing balance of the previous statement.
OBExternalStatementAmountType1Code	StartingBalance	The new balance or starting balance carried forward since last statement period.
OBExternalStatementAmountType1Code	AvailableBalance	The available balance is the difference between the credit limit and the account balance – how much is avaialble to spend.
OBExternalStatementAmountType1Code	ClosingBalance	The ending balance or closing balance at the end of the current statement period.
OBExternalStatementAmountType1Code	ArrearsClosingBalance	The balance that is in arrears at the end of the statement period.
OBExternalStatementAmountType1Code	CashClosingBalance	The component of balance that relates to cash at the end of the statement period.
OBExternalStatementAmountType1Code	PurchaseClosingBalance	The component of balance that relates to purchases at the end of the statement period.
OBExternalStatementAmountType1Code	BalanceTransferClosingBalance	The component of balance that relates to balance transfers at the end of the statement period.
OBExternalStatementAmountType1Code	CreditLimit	The credit limit is the total amount of credit available to a borrower, including any amount already borrowed.
OBExternalStatementAmountType1Code	PreviousPayment	The previous payment amount in the last statement period.
OBExternalStatementAmountType1Code	DirectDebitPaymentDue	The total direct debit payments due for current statement period.
OBExternalStatementAmountType1Code	CurrentPayment	The total payments received since the last period.
OBExternalStatementAmountType1Code	MinimumPaymentDue	The minimum payment required for the current statement period.
OBExternalStatementAmountType1Code	TotalPurchases	The total transactions made during that statement period.
OBExternalStatementAmountType1Code	TotalCredits	Total amount credited in the account during the statement period.
OBExternalStatementAmountType1Code	TotalDebits	Total amount debited (money taken out from account) from the account during the statement period.
OBExternalStatementAmountType1Code	TotalCashAdvances	A 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.
OBExternalStatementAmountType1Code	TotalAdjustments	Total adjustments to the account during the statement period.
OBExternalStatementAmountType1Code	TotalCharges	The total charges including interest, late payment fee during the statement period.
OBExternalStatementAmountType1Code	AverageBalanceWhenInCredit	The average daily balance when the account is in crebit during the statement period.
OBExternalStatementAmountType1Code	AverageBalanceWhenInDebit	The average daily balance when the account is in debit during the statement period.
OBExternalStatementAmountType1Code	AverageDailyBalance	The 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.

OBExternalStatementDateTimeType1Code	PaymentDue	The date than an account holder must make the payment for the current statement period.
OBExternalStatementDateTimeType1Code	LastStatement	The date on which the last statement was made available to account holder.
OBExternalStatementDateTimeType1Code	LastPayment	The date than an account holder must make the payment for the previous statement period.
OBExternalStatementDateTimeType1Code	StatementAvailable	The date on which the current statement was made available to account holder.
OBExternalStatementDateTimeType1Code	PurchasePromoEnd	The date the purchase promo rate will end.
OBExternalStatementDateTimeType1Code	BalanceTransferPromoEnd	The date the balance transfer promo rate will end.
OBExternalStatementDateTimeType1Code	NextStatement	The date on which the next statement will be made available to account holder.
OBExternalStatementDateTimeType1Code	DirectDebitDue	The date that the direct debit payment is due for the current statement.

OBExternalStatementInterestType1Code	Cash	Interest on cash advances.
OBExternalStatementInterestType1Code	Purchase	Interest on purchases.
OBExternalStatementInterestType1Code	BalanceTransfer	Interest on balance transfers.
OBExternalStatementInterestType1Code	Total	Total interest charges during the statement period.
OBExternalStatementInterestType1Code	EstimatedNext	The estimated interest that will be charged if the closing balance is not paid in full.

OBExternalStatementRateType1Code	MonthlyPurchase	Monthly interest rate charged on purchases.
OBExternalStatementRateType1Code	AnnualPurchase	Annual interest rate charged on purchases.
OBExternalStatementRateType1Code	MonthlyCash	Monthly interest rate charged on cash advance.
OBExternalStatementRateType1Code	AnnualCash	Annual interest rate charged on cash advance.
OBExternalStatementRateType1Code	MonthlyBalanceTransfer	Monthly interest rate charged on balance transfer from other service provider.
OBExternalStatementRateType1Code	AnnualBalanceTransfer	Annual interest rate charged on balance transfer from other service provider.
OBExternalStatementRateType1Code	AnnualBalanceTransferPromo	Annual interest rate charged on balance transfer from other service provider during promotional period.
OBExternalStatementRateType1Code	AnnualPurchasePromo	Annual interest rate charged on purchases from during promotional period.
OBExternalStatementRateType1Code	AnnualBalanceTransferAfterPromo	Annual interest rate charged on balance transfer from other service provider after promotional period.
OBExternalStatementRateType1Code	AnnualPurchaseAfterPromo	Annual interest rate charged on purchases from after promotional period.

OBExternalStatementFeeType1Code	Overlimit	Over limit fees charged during the statement period..
OBExternalStatementFeeType1Code	LatePayment	Late payment fees charged during the statement period.
OBExternalStatementFeeType1Code	Total	Total fees charges during the statement period.
OBExternalStatementFeeType1Code	Monthly	Monthly account fees charged during the statement period.
OBExternalStatementFeeType1Code	BalanceTransfer	Balance transfer fees charged during the statement period.
OBExternalStatementFeeType1Code	CashAdvance	Cash advance fees charged during the statement period.
OBExternalStatementFeeType1Code	CashTransaction	Cash transaction fees charged during the statement period.
OBExternalStatementFeeType1Code	Gambling	Gambling transaction fees charged during the statement period.
OBExternalStatementFeeType1Code	PostalOrder	Postal order fees charged during the statement period.
OBExternalStatementFeeType1Code	PrizeEntry	Prize entry fees charged during the statement period.
OBExternalStatementFeeType1Code	ForeignTransaction	Foreign transaction fees charged during the statement period.
OBExternalStatementFeeType1Code	Annual	Annual fees charged during the statement period.
OBExternalStatementFeeType1Code	StatementCopy	Statement copy fees charged during the statement period.
OBExternalStatementFeeType1Code	MoneyTransfer	Money transfer fees charged during the statement period.

OBExternalStatementBenefitType1Code	Cashback	Cash back amount received during the statement period.
OBExternalStatementBenefitType1Code	TravelDiscount	Trave discound amount received during the statement period.
OBExternalStatementBenefitType1Code	TravelInsurance	Travel insurance amount during the statement period.
OBExternalStatementBenefitType1Code	Insurance	Insurance amount during the statement period.

OBExternalStatementValueType1Code	Credits	Total number of credits in statement period.
OBExternalStatementValueType1Code	Debits	Total number of debits in statement period.
OBExternalStatementValueType1Code	HotelPoints	Hotel points at the end of the statement period.
OBExternalStatementValueType1Code	AirMilesPoints	Air miles points at the end of the statement period.
OBExternalStatementValueType1Code	RetailShoppingPoints	Retail shopping points at the end of the statement period.
OBExternalStatementValueType1Code	HotelPointsBalance	Hotel points at the end of the statement period.
OBExternalStatementValueType1Code	AirMilesPointsBalance	Air miles points at the end of the statement period.
OBExternalStatementValueType1Code	RetailShoppingPointsBalance	Retail shopping points at the end of the statement period.

OBCreditDebitCode	Credit	Operation is a credit
OBCreditDebitCode	Debit	Operation is a debit

Usage Examples

Specific Account

Retrieving statements for a specific account.

Request

Get Account Statements Request

GET /accounts/22289/statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: 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/v2.1/accounts/22289/statements"
    },
    "Meta": {
      "TotalPages": 1
    }
  }
}

Bulk

Retrieving statements for all accounts linked to the account-access-consent.

Request

Get Statements Request

GET /statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  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/v2.1/statements"
    },
    "Meta": {
      "TotalPages": 1
    }
  }
}

Payments NZ API standards

Statements v2.3.3

Version Control

Definition

Endpoints

GET /accounts/{AccountId}/statements

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

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

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

GET /statements

Data Model

UML Diagram

OBStatement1

OBReadStatement1

OBReadStatement2

Notes

Filtering

Filtering Examples

Permission Codes

Data Dictionary

OBStatement1

OBReadStatement1

OBReadStatement2

Enumerations

Usage Examples

Specific Account

Request

Get Account Statements Request

Response

Get Account Statements Response

Bulk

Request

Get Statements Request

Response

Get Statements Response