...
The ReadTransactionsBasic or ReadTransactionsDetail (in addition to the appropriate ReadTransactionsCredits and/or ReadTransactionsDebits ) permission codes will be required. The ASPSP must apply the same access to GET /accounts/{AccountId}/statements/{StatementId}/transactions as GET /accounts/{AccountId}/transactions
If the ReadPAN permission is granted by the user/customer - the ASPSP may choose to populate the unmasked PAN - if the PAN is being populated in the response for these fields
OBReadTransaction/Data/Transaction/CreditorAgent/Identification
OBReadTransaction/Data/Transaction/DebtorAccount/Identification
OBReadTransaction /Data/Transaction/CardInstrument/Identification
4.1.6 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBReadStatement |
| OBReadStatement |
| OBReadStatement |
|
|
Data | 1..1 | OBReadStatement/Data |
| OBReadStatement/Data |
|
|
Statement | 0..n | OBReadStatement/Data/Statement | Provides further details on a statement resource | OBReadStatement/Data/Statement |
|
|
AccountId | 1..1 | OBReadStatement/Data/Statement/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner | String |
|
|
StatementId | 0..1 | OBReadStatement/Data/Statement/StatementId | Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable | String |
|
|
StatementReference | 0..1 | OBReadStatement/Data/Statement/StatementReference | Unique reference for the statement. This reference may be optionally populated if available | String |
|
|
Type | 1..1 | OBReadStatement/Data/Statement/Type | Statement type, in a coded form | String | Enum:
|
|
StartDateTime | 1..1 | OBReadStatement/Data/Statement/StartDateTime | Date and time at which the statement period starts | DateTime |
|
|
EndDateTime | 1..1 | OBReadStatement/Data/Statement/EndDateTime | Date and time at which the statement period ends | DateTime |
|
|
CreationDateTime | 1..1 | OBReadStatement/Data/Statement/CreationDateTime | Date and time at which the resource was created | DateTime |
|
|
StatementDescription | 0..n | OBReadStatement/Data/Statement/StatementDescription | Other descriptions that may be available for the statement resource | String |
|
|
StatementBenefit | 0..n | OBReadStatement/Data/Statement/StatementBenefit | Set of elements used to provide details of a benefit or reward amount for the statement resource | OBReadStatement/Data/Statement/StatementBenefit |
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementBenefit/Type | Benefit type, in a coded form | String |
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/StatementBenefit/Amount | Amount of money associated with the statement benefit type | OBReadStatement/Data/Statement/StatementBenefit/Amount |
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/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 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStatement/Data/Statement/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" | String |
| ^[A-Z]{3,3}$ |
StatementFee | 0..n | OBReadStatement/Data/Statement/StatementFee | Set of elements used to provide details of a fee for the statement resource | OBReadStatement/Data/Statement/StatementFee |
|
|
Description | 0..1 | OBReadStatement/Data/Statement/StatementFee/Description | Description that may be available for the statement fee | String |
|
|
CreditDebitIndicator | 1..1 | OBReadStatement/Data/Statement/StatementFee/CreditDebitIndicator1 | Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount | String | Enum:
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementFee/Type | Fee type, in a coded form | String | Enum: (Indicative)
|
|
Rate | 0..1 | OBReadStatement/Data/Statement/StatementFee/Rate | Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount) | Number |
|
|
RateType | 0..1 | OBReadStatement/Data/Statement/StatementFee/RateType | Description that may be available for the statement fee rate type | String | Enum:
|
|
Frequency | 0..1 | OBReadStatement/Data/Statement/StatementFee/Frequency | How frequently the fee is applied to the Account | String | Enum:
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/StatementFee/Amount | Amount of money associated with the statement fee type | OBReadStatement/Data/Statement/StatementFee/Amount |
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/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 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStatement/Data/Statement/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" | String |
| ^[A-Z]{3,3}$ |
StatementInterest | 0..n | OBReadStatement/Data/Statement/StatementInterest | Set of elements used to provide details of a generic interest amount related to the statement resource | OBReadStatement/Data/Statement/StatementInterest |
|
|
Description | 0..1 | OBReadStatement/Data/Statement/StatementInterest/Description | Description that may be available for the statement interest | String |
|
|
CreditDebitIndicator | 1..1 |
| Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount | String | Enum:
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementInterest/Type | Interest amount type, in a coded form | String | Enum: (Indicative)
|
|
Rate | 0..1 | OBReadStatement/Data/Statement/StatementInterest/Rate | Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount) | Number |
|
|
RateType | 0..1 | OBReadStatement/Data/Statement/StatementInterest/RateType | Description that may be available for the statement Interest rate type | String | Enum:
|
|
Frequency | 0..1 | OBReadStatement/Data/Statement/StatementInterest/Frequency | How frequently the Interest Rate is applied to the Account | String | Enum:
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/StatementInterest/Amount | Amount of money associated with the statement interest amount type | OBReadStatement/Data/Statement/StatementInterest/Amount |
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/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 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStatement/Data/Statement/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" | String |
| ^[A-Z]{3,3}$ |
StatementAmount | 0..n | OBReadStatement/Data/Statement/StatementAmount | Set of elements used to provide details of a generic amount for the statement resource | OBReadStatement/Data/Statement/StatementAmount |
|
|
CreditDebitIndicator | 1..1 | OBReadStatement/Data/Statement/StatementAmount/CreditDebitIndicator | Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount | String | Enum
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementAmount/Type | Amount type, in a coded form | String | Enum: (Indicative)
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/StatementAmount/Amount | Amount of money associated with the amount type | OBReadStatement/Data/Statement/StatementAmount/Amount |
|
|
Amount | 1..1 | OBReadStatement/Data/Statement/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 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStatement/Data/Statement/StatementAmount/Amount/Currency | A code allocated to 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" | String |
| ^[A-Z]{3,3}$ |
StatementDateTime | 0..n | OBReadStatement/Data/Statement/StatementDateTime | Set of elements used to provide details of a generic date time for the statement resource | OBReadStatement/Data/Statement/StatementDateTime |
|
|
DateTime | 1..1 | OBReadStatement/Data/Statement/StatementDateTime/DateTim | Date and time associated with the date time type | DateTime |
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementDateTime/Type
| Date time type, in a coded form | String | Enum: (Indicative)
|
|
StatementRate | 0..n | OBReadStatement/Data/Statement/StatementRate |
| OBReadStatement/Data/Statement/StatementRate |
|
|
Rate | 1..1 | OBReadStatement/Data/Statement/StatementRate/Rate
| Rate associated with the statement rate type | String |
| ^(-?\d{1,3}){1}(.\d{1,4}){0,1}$ |
Type | 1..1 | OBReadStatement/Data/Statement/StatementRate/Type | Statement rate type, in a coded form | String | Enum: (Indicative)
|
|
StatementValue | 0..n | OBReadStatement/Data/Statement/StatementValue | Set of elements used to provide details of a generic number value related to the statement resource | OBReadStatement/Data/Statement/StatementValue |
|
|
Value | 1..1 | OBReadStatement/Data/Statement/StatementValue/Value | Value associated with the statement value type | String |
|
|
Type | 1..1 | OBReadStatement/Data/Statement/StatementValue/Type | Statement value type, in a coded form | String | Enum: (Indicative)
|
|
...