Page Comparison

Permissions

Endpoints

Business Logic

Data Cluster Description

ReadAccountsBasic

/accounts
/accounts/{AccountId}

Ability to read basic account information

ReadAccountsDetail

/accounts
/accounts/{AccountId}

Access to additional elements in the payload

Ability to read account identification details

ReadBalances

/balances
/accounts/{AccountId}/balances

Ability to read all balance information

ReadBeneficiariesBasic

/beneficiaries
/accounts/{AccountId}/beneficiaries

Ability to read basic beneficiary details

ReadBeneficiariesDetail

/beneficiaries
/accounts/{AccountId}/beneficiaries

Access to additional elements in the payload

Ability to read account identification details for the beneficiary

ReadDirectDebits

/direct-debits
/accounts/{AccountId}/direct-debits

Ability to read all direct debit information

ReadTransactionsBasic

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

Permissions must also include at least one of:

• ReadTransactionsCredits

• ReadTransactionsDebits

Ability to read basic transaction information

ReadTransactionsDetail

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

Access to additional elements in the payload

Permissions must also include at least one of:

• ReadTransactionsCredits

• ReadTransactionsDebits

Ability to read transaction data elements which may hold silent party details

ReadTransactionsCredits

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

Access to credit transactions.

Permissions must also include one of:

• ReadTransactionsBasic

• ReadTransactionsDetail

Ability to read only credit transactions

ReadTransactionsDebits

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

Access to debit transactions.

Permissions must also include one of:

• ReadTransactionsBasic

• ReadTransactionsDetail

Ability to read only debit transactions

ReadStatementsBasic

/statements
/accounts/{AccountId}/statements

Ability to read basic statement details

ReadStatementsDetail

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

Access to additional elements in the payload

Access to download the statement file (if the ASPSP makes this available).

Ability to read statement data elements which may leak other information about the account

ReadProducts

/products
/accounts/{AccountId}/product

Ability to read all product information relating to the account

ReadOffers

/offers
/accounts/{AccountId}/offers

Ability to read all offer information

ReadParty

/accounts/{AccountId}/party
/accounts/{AccountId}/parties

Ability to read party information on the account owner.

ReadPartyCustomer

/party

Ability to read party information on the user/customer logged in.

ReadFutureDatedPaymentsBasic

/future-dated-payments
/accounts/{AccountId}/future-dated-payments

Ability to read basic statement details

ReadFutureDatedPaymentsDetail

/future-dated-payments
/accounts/{AccountId}/future-dated-payments

Access to additional elements in the payload

ReadPAN

All API endpoints where PAN is available as a structured field

Request to access to PAN in the clear

Request to access PAN in the clear across the available endpoints.

If this permission code is not in the account-access-consent, the AISP will receive a masked PAN.

While an AISP may request to access PAN in the clear, an ASPSP may still respond with a masked PAN if:

• The ASPSP does not display PAN in the clear in existing online channels

• The ASPSP takes a legal view to respond with only the masked PAN

• ASPSP should return last 4 digits unmasked, or

• ASPSP should return at max first 6 and last 4 digits unmasked. e.g. 5555 **** **** 4444, **** **** **** 4444 et

Permission - Detail Codes

Data Element Name

Occurrence

XPath

ReadAccountsDetail

Account

0..1

OBReadAccount/Data/Account/Account

ReadAccountsDetail

Servicer

0..1

OBReadAccount/Data/Account/Servicer

ReadBeneficiariesDetail

CreditorAgent

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAgent

ReadBeneficiariesDetail

CreditorAccount

0..1

OBReadBeneficiary/Data/Beneficiary/CreditorAccount

ReadStandingOrdersDetail

CreditorAgent

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgent

ReadStandingOrdersDetail

CreditorAccount

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount

ReadTransactionsDetail

TransactionInformation

0..1

OBReadTransaction/Data/Transaction/TransactionInformation

ReadTransactionsDetail

Balance

0..1

OBReadTransaction/Data/Transaction/Balance

ReadTransactionsDetail

MerchantDetails

0..1

OBReadTransaction/Data/Transaction/MerchantDetails

ReadTransactionsDetail

CreditorAgent

0..1

OBReadTransaction/Data/Transaction/CreditorAgent

ReadTransactionsDetail

CreditorAccount

0..1

OBReadTransaction/Data/Transaction/CreditorAccount

ReadTransactionsDetail

DebtorAgent

0..1

OBReadTransaction/Data/Transaction/DebtorAgent

ReadTransactionsDetail

DebtorAccount

0..1

OBReadTransaction/Data/Transaction/DebtorAccount

ReadStatementsDetail

StatementAmount

0..n

OBReadStatement/Data/Statement/StatementAmount

ReadFutureDatedPaymentsDetail

CreditorAgent

0..1

OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAgent

ReadFutureDatedPaymentsDetail

CreditorAccount

0..1

OBReadFutureDatedPayment/Data/FutureDatedPayment/CreditorAccount

 S. No.

Status

Description

1

Authorised

The account access consent has been successfully authorised

2

Rejected

The account access consent has been rejected

3

Revoked

The account access consent has been revoked via the ASPSP interface

Code Class

Name

Definition

OBAccountStatusCode

Enabled

Account can be used for its intended purpose.

OBAccountStatusCode

Disabled

Account cannot be used for its intended purpose, either temporarily or permanently.

OBAccountStatusCode

Revoked

Account cannot be used any longer.

OBAccountStatusCode

ProForma

Account is temporary and can be partially used for its intended purpose. The account will be fully available for use when the account servicer has received all relevant documents.

OBAccountStatusCode

Pending

Account change is pending approval.

OBAddressTypeCode

Business

Address is the business address.

OBAddressTypeCode

Correspondence

Address is the address where correspondence is sent.

OBAddressTypeCode

DeliveryTo

Address is the address to which delivery is to take place.

OBAddressTypeCode

MailTo

Address is the address to which mail is sent.

OBAddressTypeCode

POBox

Address is a postal office (PO) box.

OBAddressTypeCode

Postal

Address is the complete postal address.

OBAddressTypeCode

Residential

Address is the home address.

OBAddressTypeCode

Statement

Address is the address where statements are sent.

OBBalanceTypeCode

ClosingAvailable

Closing balance of amount of money that is at the disposal of the account owner on the date specified.

OBBalanceTypeCode

ClosingBooked

Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.

OBBalanceTypeCode

ClosingCleared

Closing balance of amount of money that is cleared on the date specified.

OBBalanceTypeCode

Expected

Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.

OBBalanceTypeCode

ForwardAvailable

Forward available balance of money that is at the disposal of the account owner on the date specified.

OBBalanceTypeCode

Information

Balance for informational purposes.

OBBalanceTypeCode

InterimAvailable

Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.

OBBalanceTypeCode

InterimBooked

Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.

OBBalanceTypeCode

InterimCleared

Cleared balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.

OBBalanceTypeCode

OpeningAvailable

Opening balance of amount of money that is at the disposal of the account owner on the date specified.

OBBalanceTypeCode

OpeningBooked

Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.

OBBalanceTypeCode

OpeningCleared

Opening balance of amount of money that is cleared on the date specified.

OBBalanceTypeCode

PreviouslyClosedBooked

Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.

OBCreditDebitCode

Credit

Operation is a credit

OBCreditDebitCode

Debit

Operation is a debit

OBEntryStatusCode

Booked

Booked means that the transfer of money has been completed between account servicer and account owner Usage: Status Booked does not necessarily imply finality of money as this depends on other factors such as the payment system used, the completion of the end- to-end transaction and the terms agreed between account servicer and owner. Status Booked is the only status that can be reversed.

OBEntryStatusCode

Pending

Booking on the account owner's account in the account servicer's ledger has not been completed. Usage: this can be used for expected items, or for items for which some conditions still need to be fulfilled before they can be booked. If booking takes place, the entry will be included with status Booked in subsequent account report or statement. Status Pending cannot be reversed.

OBEntryStatusCode

Interimpending

OBExternalAccountSubTypeCode

ChargeCard

Account sub-type is a Charge Card.

OBExternalAccountSubTypeCode

CreditCard

Account sub-type is a Credit Card.

OBExternalAccountSubTypeCode

CurrentAccount

Account sub-type is a Current Account.

OBExternalAccountSubTypeCode

EWallet

Account sub-type is an EWallet

OBExternalAccountSubTypeCode

Loan

Account sub-type is a Loan.

OBExternalAccountSubTypeCode

Mortgage

Account sub-type is a Mortgage.

OBExternalAccountSubTypeCode

PrePaidCard

Account sub-type is a PrePaid Card.

OBExternalAccountSubTypeCode

Savings

Account sub-type is a Savings.

OBExternalAccountTypeCode

Business

Account type is for business.

OBExternalAccountTypeCode

Personal

Account type is for personal.

OBExternalCardAuthorisationTypeCode

ConsumerDevice

Card authorisation was via a Consumer Device Cardholder Verification Method (CDCVM)

OBExternalCardAuthorisationTypeCode

Contactless

Card authorisation was via Contactless.

OBExternalCardAuthorisationTypeCode

None

No card authorisation was used.

OBExternalCardAuthorisationTypeCode

PIN

Card authorisation was via PIN.

OBExternalCardSchemeTypeCode

AmericanExpress

AmericanExpress scheme.

OBExternalCardSchemeTypeCode

Diners

Diners scheme.

OBExternalCardSchemeTypeCode

Discover

Discover scheme.

OBExternalCardSchemeTypeCode

MasterCard

MasterCard scheme.

OBExternalCardSchemeTypeCode

VISA

VISA scheme.

OBExternalLimitTypeCode

Available

The amount of credit limit available to the account holder

OBExternalLimitTypeCode

Credit

The amount of a credit limit that has been agreed with the account holder

OBExternalLimitTypeCode

Emergency

The amount of an arranged lending limit that can be borrowed on top of pre-agreed lending, that has been agreed with the account holder

OBExternalLimitTypeCode

Pre-Agreed

The amount of an arranged lending limit that has been agreed with the account holder

OBExternalLimitTypeCode

Temporary

The amount of a temporary lending limit that has been agreed with the account holder

OBExternalOfferTypeCode

BalanceTransfer

Offer is a balance transfer.

OBExternalOfferTypeCode

LimitIncrease

Offer is a limit increase.

OBExternalOfferTypeCode

MoneyTransfer

Offer is a money transfer.

OBExternalOfferTypeCode

Other

Offer is of other type.

OBExternalOfferTypeCode

PromotionalRate

Offer is a promotional rate.

OBExternalPartyTypeCode

Delegate

Party that has delegated access.

OBExternalPartyTypeCode

Joint

Party is a joint owner of the account.

OBExternalPartyTypeCode

Sole

Party is a sole owner of the account.

OBExternalFutureDateTypeCode

Arrival

Future Dated payment date is specified as the arrival date for the recipient

OBExternalFutureDateTypeCode

Execution

Future Dated payment date is specified as the execution date

OBExternalStandingOrderStatusCode

Active

The standing order is active.

OBExternalStandingOrderStatusCode

Inactive

The standing order is inactive.

OBExternalStatementTypeCode

AccountClosure

Final account closure statement.

OBExternalStatementTypeCode

AccountOpening

First statement provided for an account.

OBExternalStatementTypeCode

Annual

Annual statement report.

OBExternalStatementTypeCode

Interim

Adhoc or customised statement period.

OBExternalStatementTypeCode

RegularPeriodic

Regular pre-agreed reporting statement

ISO Data Type

Fields

ISO Enumeration Values URL

Min3Max4Text

MerchantCategoryCode

https://www.iso.org/standard/33365.html

ActiveOrHistoricCurrencyCode

Currency

https://www.iso20022.org/external_code_list.page

CountryCode

Country

https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements

ExternalBankTransactionFamilyCode

BankTransactionCode/Code

https://www.iso20022.org/external_code_list.page

ExternalBankTransactionSubFamilyCode

BankTransactionCode/SubCode

https://www.iso20022.org/external_code_list.page