|
Version | Date | Author | Comments |
---|---|---|---|
2.0-rc2 | Open Banking Read/Write API Team | This is the first Release Candidate with Split from One Page Specification.
| |
2.0-rc3 | Open Banking Read/Write API Team | This is the initial version for release candidate 3 Updates:
| |
2.0.0 | Open Banking Read/Write API Team | This is the baseline version. No changes from v2.0-rc3. |
Endpoints for the resource - and available methods.
Resource | HTTP Operation | Endpoint | Mandatory? | Scope | Grant Type | Idempotent | Parameters | Request Object | Response Object | |
---|---|---|---|---|---|---|---|---|---|---|
1 | products | GET | GET /accounts/{AccountId}/product | Conditional | accounts | Authorization Code | OBReadProduct2 | |||
2 | products | GET | GET /products | Optional | accounts | Authorization Code | Pagination | OBReadProduct2 |
An AISP may retrieve the account product information for a specific AccountId (which is retrieved in the call to GET /accounts).
While this endpoint is marked as Conditional, it will be Mandatory for ASPSPs and account types covered in the CMA Order.
If an ASPSP has implemented the bulk retrieval endpoints for products - an AISP may optionally retrieve the products information in bulk.
This endpoint will retrieve the products resources for all authorised accounts linked to a specific account-request.
The OBReadProduct2 object will be used for the call to:
A resource that contains a set of elements that describes the product details specific to the account (AccountId) - which will include any pricing, fees, interest rates and product features for the account.
An account (AccountId) must only have a single product.
Notes:
Notes:
The APIs are split in to 2 broad groups based on respective security requirements:-
Open Data includes an API which provides Marketed PCA/BCA/Other Information
Read-Write (aka “Closed Data”) includes an API which provides Operated PCA/BCA/Other Information.
Open Data Product information covers:- Core Product, Eligibility, Credit Interest, Overdraft, Features & Benefits, Other Fees & Charges
Data Dictionary for Common Payload between PCA, BCA and other product types.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBReadProduct2 | OBReadProduct2 | OBReadProduct2 | ||||
Data | 1..1 | OBReadProduct2/Data | OBReadDataProduct2 | |||
Product | 0..n | OBReadProduct2/Data/Product | OBProduct2 | |||
ProductName | 0..1 | OBReadProduct2/Data/Product/ProductName | The name of the product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. | xs:string | ||
ProductId | 0..1 | OBReadProduct2/Data/Product/ProductId | Identifier within the parent organisation for the product. Must be unique in the organisation. | xs:string | ||
AccountId | 1..1 | OBReadProduct2/Data/Product/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | Max40Text | ||
SecondaryProductId | 0..1 | OBReadProduct2/Data/Product/SecondaryProductId | Identifier within the parent organisation for the product. Must be unique in the organisation. | xs:string | ||
ProductType | 1..1 | OBReadProduct2/Data/Product/ProductType | Descriptive code for the product category. If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description for the ASPSP's | OBExternalProductType1Code | PersonalCurrentAccount BusinessCurrentAccount CommercialCreditCard SMELoan Other | |
MarketingStateId | 0..1 | OBReadProduct2/Data/Product/MarketingStateId | Unique and unambiguous identification of a Product Marketing State. | xs:ID | [\i-[:]][\c-[:]]* | |
OtherProductType | 0..1 | OBReadProduct2/Data/Product/OtherProductType | This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for ASPSP specific product type | OB_OtherProductType1 | ||
Name | 1..1 | OBReadProduct2/Data/Product/OtherProductType/Name | xs:string | |||
Description | 1..1 | OBReadProduct2/Data/Product/OtherProductType/Description | xs:string | |||
PCA | 0..1 | OBReadProduct2/Data/Product/PCA | OBPCAData1 | |||
BCA | 0..1 | OBReadProduct2/Data/Product/BCA | OBBCAData1 |
/wiki/spaces/WOR/pages/118096091
/wiki/spaces/WOR/pages/118194379
Detailed usage examples for PCA, and BCA can be found in the Message Implementation Guide section of PCA and BCA sub pages.
Request
GET /accounts/22289/product 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
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Product": [ { "AccountId": "22289", "ProductId": "51B", "ProductType": "PersonalCurrentAccount", "ProductName": "321 Product", "PCA": { .... } } ] }, "Links": { "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/22289/product" }, "Meta": { "TotalPages": 1 } } |
Request
GET /products 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
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Product": [ { "AccountId": "22289", "ProductId": "51B", "ProductType": "PersonalCurrentAccount", "ProductName": "321 Product", "PCA": { .. } }, { "AccountId": "31820", "ProductId": "001", "ProductType": "BusinessCurrentAccount", "ProductName": "123 Product", "BCA": { .. } } ] }, "Links": { "Self": "https://api.alphabank.com/open-banking/v2.0/products/" }, "Meta": { "TotalPages": 1 } } |