AISP Resources and Data Models - v3.1.8

Resources accessed using the aisp PSD2 role are detailed here:

• Account Access Consents
• Accounts
• Balances
• Transactions
• Beneficiaries
• Direct Debits
• Standing Orders
• Products
  • BCA Product Data Model
  • PCA Product Data Model
  • Other Product Data Model
• Offers
• Parties
• Scheduled Payments
• Statements

Endpoints

The API endpoints for these resources, and their mandatory/conditional/optional status are given below.

Resource	Endpoints	Mandatory?
account-access-consents	POST /account-access-consents	Mandatory
account-access-consents	GET /account-access-consents/{ConsentId}	Mandatory
account-access-consents	DELETE /account-access-consents/{ConsentId}	Mandatory
accounts	GET /accounts	Mandatory
accounts	GET /accounts/{AccountId}	Mandatory
balances	GET /accounts/{AccountId}/balances	Mandatory
balances	GET /balances	Optional
transactions	GET /accounts/{AccountId}/transactions	Mandatory
transactions	GET /transactions	Optional
beneficiaries	GET /accounts/{AccountId}/beneficiaries	Conditional
beneficiaries	GET /beneficiaries	Optional
direct-debits	GET /accounts/{AccountId}/direct-debits	Conditional
direct-debits	GET /direct-debits	Optional
standing-orders	GET /accounts/{AccountId}/standing-orders	Conditional
standing-orders	GET /standing-orders	Optional
products	GET /accounts/{AccountId}/product	Conditional
products	GET /products	Optional
offers	GET /accounts/{AccountId}/offers	Conditional
offers	GET /offers	Optional
parties	GET /accounts/{AccountId}/parties	Conditional
parties	GET /accounts/{AccountId}/party	Conditional
parties	GET /party	Conditional
scheduled-payments	GET /accounts/{AccountId}/scheduled-payments	Conditional
scheduled-payments	GET /scheduled-payments	Optional
statements	GET /accounts/{AccountId}/statements	Conditional
statements	GET /accounts/{AccountId}/statements/{StatementId}	Conditional
statements	GET /accounts/{AccountId}/statements/{StatementId}/file	Optional
statements	GET /accounts/{AccountId}/statements/{StatementId}/transactions	Conditional
statements	GET /statements	Optional

Notes

Definitions for Mandatory, Conditional and Optional are given in the Read/Write Data API Profile.

Account and Transactionns Resource Compatibility

		Read-Write API Profile	Read-Write API Profile	Read-Write API Profile	Account and Transaction API Profile	Account and Transaction API Profile	Account and Transaction API Profile
		v3.1	v3.1.1	3.1.2	v3.1	v3.1.1	3.1.2
Account Access Consents	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Accounts	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Balances	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Beneficiaries	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Direct Debits	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Offers	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Parties	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Products	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Scheduled Payments	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Standing Orders	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Statements	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
Transactions	v3.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.1	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE
	v3.1.2	TRUE	TRUE	TRUE	TRUE	TRUE	TRUE