Bring Bank APIs to life with our reference apps.
\\r\\n\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
![\\"\\"](\\"/sites/default/files/openbank/pispapp.jpg\\") | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t\\tBigZ app (third-party payment initiation)\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t This scenario demonstrates a payment made through a PISP without using cash, credit card, or debit card: \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t Kathie is living in London and occupied with her work. She needs to buy a new cellphone. Laura logs on to BigZ online shopping mobile app,selects the product, and pays for it online without even stepping out of her workplace. \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t
\\r\\n\\r\\n
\\r\\n\\r\\n
| \\r\\n\\t\\t\\t \\r\\n\\t\\t\\t \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t \\r\\n\\t\\t\\taisp.jpg\\r\\n\\r\\n\\t\\t\\t![\\"\\"](\\"/sites/default/files/openbank/aispapp.jpg\\") | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t\\tPepperMint app (account information service provider)\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t Enjoy visibility of your funds across all your accounts, in one place. Advanced spendilytics at your finger tips: \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t Sam is living in California and would like to track and monitor his monthly spending across his accounts. He logs on to his new PepperMint app, which provides him a consolidated view of his accounts, financials and expenditure. \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t
\\r\\n\\r\\n
\\r\\n", + \'value\' => "
Bring Bank APIs to life with our reference apps.
\\r\\n\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
| \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t\\tBigZ app (third-party payment initiation)\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t This scenario demonstrates a payment made through a PISP without using cash, credit card, or debit card: \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t Kathie is living in London and occupied with her work. She needs to buy a new cellphone. Laura logs on to BigZ online shopping mobile app,selects the product, and pays for it online without even stepping out of her workplace. \\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t
| \\r\\n\\t\\t\\t \\r\\n\\t\\t\\t \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t \\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t\\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\r\\n\\t\\t\\t \\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t | \\r\\n\\t\\t
\\r\\n\\r\\n
\\r\\n", \'summary\' => \'\', \'format\' => \'full_html\', - \'safe_value\' => "
Bring Bank APIs to life with our reference apps.
\\nÂ
\\nÂ
\\n\\n\\n \\npispapp.jpg\\n \\n \\n\\n \\n\\n \\n | \\n  | \\n\\nBigZ app (third-party payment initiation)\\n \\nThis scenario demonstrates a payment made through a PISP without using cash, credit card, or debit card: \\n \\nKathie is living in London and occupied with her work. She needs to buy a new cellphone. Laura logs on to BigZ online shopping mobile app,selects the product, and pays for it online without even stepping out of her workplace. \\n \\n\\n \\n \\n \\n \\n | \\n\\nÂ\\n | \\n
Â
\\nÂ
\\n| \\n \\n \\n\\n \\naisp.jpg\\n | \\n  | \\n\\nPepperMint app (account information service provider)\\n \\nEnjoy visibility of your funds across all your accounts, in one place. Advanced spendilytics at your finger tips: \\n \\nSam is living in California and would like to track and monitor his monthly spending across his accounts. He logs on to his new PepperMint app, which provides him a consolidated view of his accounts, financials and expenditure. \\n\\n \\n \\n \\n \\n | \\n\\nÂ\\n | \\n
Â
\\nÂ
\\n", + \'safe_value\' => "Bring Bank APIs to life with our reference apps.
\\nÂ
\\nÂ
\\n | \\n  | \\n\\nBigZ app (third-party payment initiation)\\n \\nThis scenario demonstrates a payment made through a PISP without using cash, credit card, or debit card: \\n \\nKathie is living in London and occupied with her work. She needs to buy a new cellphone. Laura logs on to BigZ online shopping mobile app,selects the product, and pays for it online without even stepping out of her workplace. \\n \\n\\n \\n \\n \\n \\n | \\n\\nÂ\\n | \\n
| \\n \\n \\n\\n \\nÂ\\n \\n | \\n  | \\n\\nÂ\\n \\n \\n \\n \\n | \\n\\nÂ\\n | \\n
Â
\\nÂ
\\n", \'safe_summary\' => \'\', ), ), @@ -1905,10 +1905,10 @@ function all_component_features_node_export_features_default() { \'body\' => array( \'und\' => array( array( - \'value\' => "API Catalogue
\\r\\n\\r\\nAPI products are available through various subsciption plans. These plans will be made available after enrollment and verification. Once you've subscribed to a plan, you can use the APIs using the app credentials. APIs are categorized into these API products:
\\r\\n\\r\\n\\r\\n\\r\\n
Account information APIs
\\r\\n\\r\\nAccount information APIs provide information for accounts held by the bank customer. Information is categorized into:
\\r\\n\\r\\n- \\r\\n\\t
- Information \\r\\n\\t
- Balance \\r\\n\\t
- Transactions \\r\\n\\t
- Beneficiaries \\r\\n\\t
- Standing Orders \\r\\n\\t
- Direct Debits \\r\\n
An API end point is provided for each type of information.
\\r\\n\\r\\nBanking APIs provide developers with the information needed to create innovative fintech apps for consumers. While you probably have some use cases in mind, there are a few obvious ones worth mentioning:
\\r\\n\\r\\n- \\r\\n\\t
- Aggregation of financial metrics such as net worth and savings across multiple accounts \\r\\n\\t
- Analysis and recommendations for better money management \\r\\n\\t
- Reccomendation of products and deals based on monthly statements \\r\\n
\\r\\n\\r\\n
\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account information\\r\\n\\r\\n
\\r\\n/{AccountId}
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account transactions\\r\\n\\r\\n
\\r\\n/{AccountId}/transactions
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account Balance\\r\\n\\r\\n
\\r\\n/{AccountId}/balance
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account Beneficiaries\\r\\n\\r\\n
\\r\\n/{AccountId}/beneficiaries
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account Standing Orders\\r\\n\\r\\n
\\r\\n/{AccountId}/standing-orders
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nSingle Account Direct Debits\\r\\n\\r\\n
\\r\\n/{AccountId}/direct-debits
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Accounts information\\r\\n\\r\\n
\\r\\n/
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Accounts Balance\\r\\n\\r\\n
\\r\\n/balance
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Accounts Transactions\\r\\n\\r\\n
\\r\\n/transactions
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Accounts Beneficiaries\\r\\n\\r\\n
\\r\\n/beneficiaries
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Accounts Standing Orders\\r\\n\\r\\n
\\r\\n/standing-orders
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nCustomer's Account Direct Debits\\r\\n\\r\\n
\\r\\n/direct-betits
\\r\\n\\r\\n\\r\\n
Authorization APIs
\\r\\n\\r\\nFor accessing account access API end points and payment API end points, the app will first make a call to the OAuth API, so that it can get an access token. The OAuth APIs support the implicit grant flow wherein the access token is returned directly to the app once the user has been authenticated. To keep the authentication more secure (it should do this, unless the app is trusted), the app could also use the authorization code flow wherein a code is returned back to the app. The app should then exchange it for an access token.
\\r\\n\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\n\\r\\nThe app can then use this access token to make the calls to the accounts APIs, userinfo API, and payment APIs. When the API is called, the customer and request id is retrieved from the access token to proceed with the API call flow.
\\r\\n\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n\\r\\n
Payment APIs
\\r\\n\\r\\n
\\r\\nPayment APIs enable the transfer of funds from a consumer's account to a recipient. The initation of transfer is done by the consumer and the recipient's account number is provided by the third-party payment provider (TPPs or PISPs).
For initiating a transfer the user will have to provide the payment request Id and will have to authenticate using two-factor authentication following which an access token will be generated
\\r\\n\\r\\nUsing the Access token generated, one-time payment submission can be done. Take a look at some of the use cases:
\\r\\n\\r\\n- \\r\\n\\t
- Immediate payment transfers for online purchases, thus providing guaranteed services \\r\\n\\t
- Push payments providing merchant with immediate access to the transferred amount \\r\\n\\t
- Fast retail loans from third-party lenders \\r\\n
\\r\\n\\r\\n
\\r\\n
\\r\\n",
+ \'value\' => "\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nPOST
\\r\\nPayment Request\\r\\n\\r\\n
\\r\\n/payments
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nPayment Request\\r\\n\\r\\n
\\r\\n/payments
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nPOST
\\r\\nPayment Submission\\r\\n\\r\\n
\\r\\n/payment-submissions
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nPayment Submission\\r\\n\\r\\n
\\r\\n/payment-submissions
\\r\\n\\r\\n\\r\\n
Userinfo APIs
\\r\\n\\r\\n
\\r\\nUserindo APIs enable getting basic details of the customer.
For initiating this call, the user will have to authenticate using two-factor authentication following which an access token will be generated
\\r\\n\\r\\nUsing the Access token generated, user details can be fetched.
\\r\\n\\r\\n\\r\\n\\r\\n
\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nUser Information\\r\\n\\r\\n
\\r\\n/userinfo/acr:token
\\r\\n\\r\\n\\r\\n
Open Data APIs
\\r\\n\\r\\n
\\r\\nOpen Data APIs are a category of APIs that provide general information of a Bank. These are not customer-specific, but bank-specific: locations, products, URLs, and events, for example. These APIs are not subjected to user-level authentication, but are are protected to be used only by signed apps. A valid client credential is essential to invoke these APIs.
Using this category of APIs, a wide variety of new value-added solutions can be provided to consumers. Coupled with customer-specific information, potential new solutions include product and offer recommendations.
\\r\\n\\r\\n\\r\\n
\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\natms\\r\\n\\r\\n
\\r\\n/atms
\\r\\n\\r\\n
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nproducts\\r\\n\\r\\n
\\r\\n/products
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\nbranches\\r\\n\\r\\n
\\r\\n/branches
\\r\\nAPI Catalogue
\\r\\n\\r\\nAPI products are available through various subsciption plans. These plans will be made available after enrollment and verification. Once you\'ve subscribed to a plan, you can use the APIs using the app credentials. APIs are categorized into these API products:
\\r\\n\\r\\n
Account information APIs
\\r\\nAccount information APIs provide information for accounts held by the bank customer. Information is categorized into:
\\r\\n- \\r\\n
- Information \\r\\n
- Balance \\r\\n
- Transactions \\r\\n
- Beneficiaries \\r\\n
- Standing Orders \\r\\n
- Direct Debits \\r\\n
- Product \\r\\n
An API end point is provided for each type of information.
\\r\\nBanking APIs provide developers with the information needed to create innovative fintech apps for consumers. While you probably have some use cases in mind, there are a few obvious ones worth mentioning:
\\r\\n- \\r\\n
- Aggregation of financial metrics such as net worth and savings across multiple accounts \\r\\n
- Analysis and recommendations for better money management \\r\\n
- Reccomendation of products and deals based on monthly statements \\r\\n
\\r\\n
\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nPOST
\\r\\nAccount Request\\r\\n
\\r\\n/account-requests
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nAccount Request\\r\\n
\\r\\n/account-requests/{AccountRequestId}
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nDELETE
\\r\\nAccount Request\\r\\n
\\r\\n/account-requests/{AccountRequestId}
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account information\\r\\n
\\r\\n/accounts/{AccountId}
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account transactions\\r\\n
\\r\\n/accounts/{AccountId}/transactions
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account Balance\\r\\n
\\r\\n/accounts/{AccountId}/balances
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account Beneficiaries\\r\\n
\\r\\n/accounts/{AccountId}/beneficiaries
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account Standing Orders\\r\\n
\\r\\n/accounts/{AccountId}/standing-orders
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\nGET
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Accounts information\\r\\n
\\r\\n/accounts
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Accounts Balance\\r\\n
\\r\\n/balances
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Accounts Transactions\\r\\n
\\r\\n/transactions
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Accounts Beneficiaries\\r\\n
\\r\\n/beneficiaries
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Accounts Standing Orders\\r\\n
\\r\\n/standing-orders
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nSingle Account\'s Product\\r\\n
\\r\\n/accounts/{AccountId}/product
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nCustomer\'s Account Direct Debits\\r\\n
\\r\\n/direct-betits
\\r\\n\\r\\n
Authorization APIs
\\r\\nFor accessing account access API end points and payment API end points, the app will first make a call to the OAuth API, so that it can get an access token. The OAuth APIs support the implicit grant flow wherein the access token is returned directly to the app once the user has been authenticated. To keep the authentication more secure (it should do this, unless the app is trusted), the app could also use the authorization code flow wherein a code is returned back to the app. The app should then exchange it for an access token.
\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\nThe app can then use this access token to make the calls to the accounts APIs, userinfo API, and payment APIs. When the API is called, the customer and request id is retrieved from the access token to proceed with the API call flow.
\\r\\n\\r\\n\\r\\n
\\r\\n\\r\\n
Payment APIs
\\r\\n
Payment APIs enable the transfer of funds from a consumer\'s account to a recipient. The initation of transfer is done by the consumer and the recipient\'s account number is provided by the third-party payment provider (TPPs or PISPs).
For initiating a transfer the user will have to provide the payment request Id and will have to authenticate using two-factor authentication following which an access token will be generated
\\r\\nUsing the Access token generated, one-time payment submission can be done. Take a look at some of the use cases:
\\r\\n- \\r\\n
- Immediate payment transfers for online purchases, thus providing guaranteed services \\r\\n
- Push payments providing merchant with immediate access to the transferred amount \\r\\n
- Fast retail loans from third-party lenders \\r\\n
\\r\\n
\\r\\n
",
\'summary\' => \'\',
\'format\' => \'full_html\',
- \'safe_value\' => "\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nPOST
\\r\\nPayment Request\\r\\n
\\r\\n/payments
\\r\\n\\r\\n \\r\\n \\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nPayment Request\\r\\n
\\r\\n/payments
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nPOST
\\r\\nPayment Submission\\r\\n
\\r\\n/payment-submissions
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\n\\r\\n
\\r\\nGET
\\r\\nPayment Submission\\r\\n
\\r\\n/payment-submissions
\\r\\nAPI Catalogue
\\nAPI products are available through various subsciption plans. These plans will be made available after enrollment and verification. Once you\'ve subscribed to a plan, you can use the APIs using the app credentials. APIs are categorized into these API products:
\\nÂ
\\nAccount information APIs
\\nAccount information APIs provide information for accounts held by the bank customer. Information is categorized into:
\\n- Information \\n
- Balance \\n
- Transactions \\n
- Beneficiaries \\n
- Standing Orders \\n
- Direct Debits \\n
An API end point is provided for each type of information.
\\nBanking APIs provide developers with the information needed to create innovative fintech apps for consumers. While you probably have some use cases in mind, there are a few obvious ones worth mentioning:
\\n- Aggregation of financial metrics such as net worth and savings across multiple accounts \\n
- Analysis and recommendations for better money management \\n
- Reccomendation of products and deals based on monthly statements \\n
Â
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account information\\n
\\n/{AccountId}
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account transactions\\n
\\n/{AccountId}/transactions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Balance\\n
\\n/{AccountId}/balance
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Beneficiaries\\n
\\n/{AccountId}/beneficiaries
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Standing Orders\\n
\\n/{AccountId}/standing-orders
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Direct Debits\\n
\\n/{AccountId}/direct-debits
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\nGET
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Balance\\n
\\n/balance
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Transactions\\n
\\n/transactions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Beneficiaries\\n
\\n/beneficiaries
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Standing Orders\\n
\\n/standing-orders
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Account Direct Debits\\n
\\n/direct-betits
\\nÂ
\\nAuthorization APIs
\\nFor accessing account access API end points and payment API end points, the app will first make a call to the OAuth API, so that it can get an access token. The OAuth APIs support the implicit grant flow wherein the access token is returned directly to the app once the user has been authenticated. To keep the authentication more secure (it should do this, unless the app is trusted), the app could also use the authorization code flow wherein a code is returned back to the app. The app should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe app can then use this access token to make the calls to the accounts APIs, userinfo API, and payment APIs. When the API is called, the customer and request id is retrieved from the access token to proceed with the API call flow.
\\n\\n\\n
\\nÂ
\\nPayment APIs
\\n\\nPayment APIs enable the transfer of funds from a consumer\'s account to a recipient. The initation of transfer is done by the consumer and the recipient\'s account number is provided by the third-party payment provider (TPPs or PISPs).
\\nFor initiating a transfer the user will have to provide the payment request Id and will have to authenticate using two-factor authentication following which an access token will be generated
\\nUsing the Access token generated, one-time payment submission can be done. Take a look at some of the use cases:
\\n- Immediate payment transfers for online purchases, thus providing guaranteed services \\n
- Push payments providing merchant with immediate access to the transferred amount \\n
- Fast retail loans from third-party lenders \\n
Â
\\n\\n
\\n",
+ \'safe_value\' => "\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nPOST
\\nPayment Request\\n
\\n/payments
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nPayment Request\\n
\\n/payments
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nPOST
\\nPayment Submission\\n
\\n/payment-submissions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nPayment Submission\\n
\\n/payment-submissions
\\nÂ
\\nUserinfo APIs
\\n\\nUserindo APIs enable getting basic details of the customer.
\\nFor initiating this call, the user will have to authenticate using two-factor authentication following which an access token will be generated
\\nUsing the Access token generated, user details can be fetched.
\\nÂ
\\n\\n
\\n\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nUser Information\\n
\\n/userinfo/acr:token
\\nÂ
\\n Open Data APIs
\\n\\nOpen Data APIs are a category of APIs that provide general information of a Bank. These are not customer-specific, but bank-specific: locations, products, URLs, and events, for example. These APIs are not subjected to user-level authentication, but are are protected to be used only by signed apps. A valid client credential is essential to invoke these APIs.
\\nUsing this category of APIs, a wide variety of new value-added solutions can be provided to consumers. Coupled with customer-specific information, potential new solutions include product and offer recommendations.
\\nÂ
\\nAPI Catalogue
\\nAPI products are available through various subsciption plans. These plans will be made available after enrollment and verification. Once you\'ve subscribed to a plan, you can use the APIs using the app credentials. APIs are categorized into these API products:
\\nÂ
\\nAccount information APIs
\\nAccount information APIs provide information for accounts held by the bank customer. Information is categorized into:
\\n- Information \\n
- Balance \\n
- Transactions \\n
- Beneficiaries \\n
- Standing Orders \\n
- Direct Debits \\n
- Product \\n
An API end point is provided for each type of information.
\\nBanking APIs provide developers with the information needed to create innovative fintech apps for consumers. While you probably have some use cases in mind, there are a few obvious ones worth mentioning:
\\n- Aggregation of financial metrics such as net worth and savings across multiple accounts \\n
- Analysis and recommendations for better money management \\n
- Reccomendation of products and deals based on monthly statements \\n
Â
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nPOST
\\nAccount Request\\n
\\n/account-requests
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nAccount Request\\n
\\n/account-requests/{AccountRequestId}
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nDELETE
\\nAccount Request\\n
\\n/account-requests/{AccountRequestId}
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account information\\n
\\n/accounts/{AccountId}
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account transactions\\n
\\n/accounts/{AccountId}/transactions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Balance\\n
\\n/accounts/{AccountId}/balances
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Beneficiaries\\n
\\n/accounts/{AccountId}/beneficiaries
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account Standing Orders\\n
\\n/accounts/{AccountId}/standing-orders
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\nGET
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts information\\n
\\n/accounts
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Balance\\n
\\n/balances
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Transactions\\n
\\n/transactions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Beneficiaries\\n
\\n/beneficiaries
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Accounts Standing Orders\\n
\\n/standing-orders
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nSingle Account\'s Product\\n
\\n/accounts/{AccountId}/product
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nCustomer\'s Account Direct Debits\\n
\\n/direct-betits
\\nÂ
\\nAuthorization APIs
\\nFor accessing account access API end points and payment API end points, the app will first make a call to the OAuth API, so that it can get an access token. The OAuth APIs support the implicit grant flow wherein the access token is returned directly to the app once the user has been authenticated. To keep the authentication more secure (it should do this, unless the app is trusted), the app could also use the authorization code flow wherein a code is returned back to the app. The app should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe app can then use this access token to make the calls to the accounts APIs, userinfo API, and payment APIs. When the API is called, the customer and request id is retrieved from the access token to proceed with the API call flow.
\\n\\n\\n
\\nÂ
\\nPayment APIs
\\nPayment APIs enable the transfer of funds from a consumer\'s account to a recipient. The initation of transfer is done by the consumer and the recipient\'s account number is provided by the third-party payment provider (TPPs or PISPs).
\\nFor initiating a transfer the user will have to provide the payment request Id and will have to authenticate using two-factor authentication following which an access token will be generated
\\nUsing the Access token generated, one-time payment submission can be done. Take a look at some of the use cases:
\\n- Immediate payment transfers for online purchases, thus providing guaranteed services \\n
- Push payments providing merchant with immediate access to the transferred amount \\n
- Fast retail loans from third-party lenders \\n
Â
\\n\\n
\\n",
\'safe_summary\' => \'\',
),
),
@@ -3188,10 +3188,10 @@ function all_component_features_node_export_features_default() {
\'body\' => array(
\'und\' => array(
array(
- \'value\' => "\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nPOST
\\nPayment Request\\n
\\n/payments
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nPayment Request\\n
\\n/payments
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nPOST
\\nPayment Submission\\n
\\n/payment-submissions
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\n\\n
\\nGET
\\nPayment Submission\\n
\\n/payment-submissions
\\nÂ
\\nÂ
\\nCreate an app
\\r\\n\\r\\nStep 1) After your have registered and logged in, click the "Add a new app" button.
\\r\\n\\r\\n\\r\\n\\r\\n
[[{\\"fid\\":\\"168\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"428\\",\\"width\\":\\"1223\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\n\\r\\n\\r\\n
Step 2) Enter the name of your app and choose the API product you need. Refer to the API catalogue to learn more about the API products and the APIs bundled in the product. Redirect URI is the URL to which the authorize call will be redirected. The redirect URI needs to match what is entered here to return the auth code.
\\r\\n\\r\\n[[{\\"fid\\":\\"163\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"503\\",\\"width\\":\\"677\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\n\\r\\n\\r\\n
Step 3) Click on "Create app." You will see the message that says "app created" and see a link to your app.
\\r\\n\\r\\n\\r\\n\\r\\n
[[{\\"fid\\":\\"168\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"428\\",\\"width\\":\\"1223\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\n\\r\\n\\r\\n
Step 4) To get client credentials and click on your app. You will also see details and traffic dashboards.
\\r\\n\\r\\n\\r\\n\\r\\n
[[{\\"fid\\":\\"170\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"496\\",\\"width\\":\\"824\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\n\\r\\n\\r\\n
To view the analytics dashboards on traffic, errors, and other information, click on the analytics tab.
\\r\\n\\r\\n\\r\\n\\r\\n
[[{\\"fid\\":\\"167\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"491\\",\\"width\\":\\"1168\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n", + \'value\' => "Create an app
\\r\\n\\r\\nStep 1) After your have registered and logged in, click the \\"Add a new app\\" button.
\\r\\n\\r\\n
Step 2) Enter the name of your app and choose the API product you need. Refer to the API catalogue to learn more about the API products and the APIs bundled in the product. Redirect URI is the URL to which the authorize call will be redirected. The redirect URI needs to match what is entered here to return the auth code.
\\r\\n\\r\\n
Step 3) Click on \\"Create app.\\" You will see the message that says \\"app created\\" and see a link to your app.
\\r\\n\\r\\n
Step 4) To get client credentials and click on your app. You will also see details and traffic dashboards.
\\r\\n\\r\\n
To view the analytics dashboards on traffic, errors, and other information, click on the analytics tab.
", \'summary\' => \'\', \'format\' => \'full_html\', - \'safe_value\' => "Create an app
\\nStep 1) After your have registered and logged in, click the \\"Add a new app\\" button.
\\nÂ
\\n\\n\\n
\\n2addapp1.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/2addapp1.png\\")
\\n\\n \\n Â
\\nStep 2) Enter the name of your app and choose the API product you need. Refer to the API catalogue to learn more about the API products and the APIs bundled in the product. Redirect URI is the URL to which the authorize call will be redirected. The redirect URI needs to match what is entered here to return the auth code.
\\n\\n\\n
\\naddapp2.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/addapp2.png\\")
\\n\\n \\n Â
\\nStep 3) Click on \\"Create app.\\" You will see the message that says \\"app created\\" and see a link to your app.
\\nÂ
\\n\\n\\n
\\n2addapp1.png
\\n \\n \\n\\n
\\n\\n \\n Â
\\nStep 4) To get client credentials and click on your app. You will also see details and traffic dashboards.
\\nÂ
\\n\\n\\n
\\n2addapp3.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/2addapp3.png\\")
\\n\\n \\n Â
\\nTo view the analytics dashboards on traffic, errors, and other information, click on the analytics tab.
\\nÂ
\\n\\n\\n
\\naddapp4.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/addapp4_0.png\\")
\\n\\n \\n Create an app
\\nStep 1) After your have registered and logged in, click the \\"Add a new app\\" button.
\\nÂ
\\nStep 2) Enter the name of your app and choose the API product you need. Refer to the API catalogue to learn more about the API products and the APIs bundled in the product. Redirect URI is the URL to which the authorize call will be redirected. The redirect URI needs to match what is entered here to return the auth code.
\\nÂ
\\nStep 3) Click on \\"Create app.\\" You will see the message that says \\"app created\\" and see a link to your app.
\\nÂ
\\nStep 4) To get client credentials and click on your app. You will also see details and traffic dashboards.
\\nÂ
\\nTo view the analytics dashboards on traffic, errors, and other information, click on the analytics tab.
\\n", \'safe_summary\' => \'\', ), ), @@ -3806,10 +3806,10 @@ function all_component_features_node_export_features_default() { \'body\' => array( \'und\' => array( array( - \'value\' => "Authentication
\\r\\n\\r\\nAuthentication is based on OpenID Connect, which is based on OAuth 2.0.
\\r\\n\\r\\nThe user will have to authenticate with the bank using two-factor authentication, which will then provide the client application with a unique and time-bound access token. The client app can use this unique token to make calls to the bank on the behalf of the user.
\\r\\n\\r\\nGenerally, these access tokens are specific to a single account of a user and are valid over a longer duration (up to 30 days, for example).
\\r\\n\\r\\nFor the payment API, users need to authenticate their accounts each time a transfer is made because these API calls need to meet higher security requirements.
\\r\\n\\r\\nThe end user authenticates the account and provides access to the app to carry out the transaction via a two-step verification on the bank site. The following steps are done to provide authentication:
\\r\\n\\r\\n- \\r\\n\\t
- The user is shown a consent page from the bank where the user logs in with a customer ID and password \\r\\n\\t
- The bank then requests the user to verify this with an OTP, which is sent to the user’s registered mobile number \\r\\n\\t
- Once the user enters the OTP, the user is shown the accounts; this generates an access token specific to that account, which the app can then use to make calls on behalf of the user \\r\\n
\\r\\n\\r\\n
Using APIs in your app
\\r\\n\\r\\nYou will create the app and provide the required details to enable support for the OAuth 2.0 three-legged flows, such as the callback/redirect url.
\\r\\n\\r\\nIn order for the app to make any API calls, it will have to present its client ID and secret. This is to ensure that only authenticated apps can make API calls.
\\r\\n\\r\\nFor accessing the accounts API, the app will first make a call to the OAuth API, so that the app can get an access token to access a single account on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should, unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app. It should then exchange it for an access token.
\\r\\n\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\n\\r\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\r\\n\\r\\nIn the case of transfers, the app can directly make a call to the payment API wherein the bank will directly request for authentication information from the user including OTP verification and asking for consent after which the bank allows the app to make a one-time transfer on behalf of the user. In order to initiate the transfer the app has to provide information related to the payee as a JWT token. More details about how this JWT token is created is provided in the Payments API section.
\\r\\n\\r\\n\\r\\n\\r\\n
Account Access APIs
\\r\\n\\r\\nFor accessing this API endpoint, the app will first make a call to the OAuth API, so that the app can get an access token to access a single account on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\r\\n\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\n\\r\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\r\\n\\r\\n\\r\\n\\r\\n
Payment transfer APIs
\\r\\n\\r\\nAssume a hypothetical scenario where the user has made a purchase from an online merchant. The user now wishes to make a payment via the payment provider (PISP) supported by this online merchant.
\\r\\n\\r\\nThe merchant has provided the transaction-related information to the PISP and the PISP now initiates a call to the payment API. The transfer details are sent to the API in the form of a signed JWT. The JWT is signed with the client secret of the app; the API will then verify this JWT by comparing it with the signature of the app that made this request. This ensures that the token has not been tampered with. The payment information is also shown to the user while requesting consent so that the user can verify the details.
\\r\\n\\r\\nThe JWT is composed of three sections: header, payload, and signature
\\r\\n\\r\\nA sample header shown below. It indicates that it is a JWT token and specified the signature used for encoding the payload.
\\r\\n\\r\\n{
\\r\\n\\r\\n"alg": "HS256",
\\r\\n\\r\\n"typ": "JWT"
\\r\\n\\r\\n}
\\r\\n\\r\\nThe payload contains the payee information as a set of payment claims. The token contains some reserved claims that are supposed to be in a JWT payload and some private claims that specify the payment details.
\\r\\n\\r\\n\\r\\n{\\r\\n "iss": "https://accenture.co.uk", //url of the JWT issuer\\r\\n "aud": "https://apis-bank-dev.apigee.net", //url of the party it is intended for\\r\\n "client_id": "grOmvYA89jsdhkshdIYhGtpvztofAAjz", //client id of the registered app\\r\\n "redirect_uri": "http://localhost/", //redirect uri of the app\\r\\n "scope": "openid accounts payment", //requested scopes for this call\\r\\n "state": "af0ifjsldkj", //unique state to connect request and response\\r\\n "acr_values": "3", // request acr_values; 2 for only authentication, and 3 for OTP flow\\r\\n "claims": {\\r\\n "paymentinfo": {\\r\\n "type": "sepa_credit_transfer", //transfer type\\r\\n "to": {\\r\\n "account_number": "62136000", //receiver account id\\r\\n "remote_bic": "RBOSGB2109H", //receiver remote bic code\\r\\n "remote_IBAN": "GB32ESSE40486562136016", //receiver remote iban code\\r\\n "remote_name": "BigZ online store" //receiver name\\r\\n },\\r\\n "value": {\\r\\n "currency": "GBP", //transfer currency\\r\\n "amount": "200" //transfer amount\\r\\n },\\r\\n "additional": {\\r\\n "subject": "Online Purchase", //transfer description\\r\\n "booking_code": "2SFBJ28553", //transfer booking code\\r\\n "booking_date": "1462517645809", //transfer booking date\\r\\n "value_date": "1462517645809" //transfer value date\\r\\n },\\r\\n "challenge_type": "SANDBOX_TAN" //challenge for additional security\\r\\n }\\r\\n }\\r\\n}\\r\\n\\r\\nThen, the JWT token is signed with the client secret of the registered app to ensure that it isn't tampered with.
\\r\\n\\r\\nTo form the full token, the header and the payload is Base64Url encoded and concatenated, separated by a dot (.). This string is signed in the following way using a JWS library. There are libraries available for many languages in order to sign a JWT.
\\r\\n\\r\\nHMACSHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload), secret)
\\r\\n\\r\\nFinally the following JWT token is obtained.
\\r\\n\\r\\n\\r\\n\\r\\n
\\r\\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FjY2VudHVyZS5jby51ayIsImF1ZCI6Imh0dHBzOi8vYXBpcy1iYW5rLWRldi5hcGlnZWUubmV0IiwiY2xpZW50X2lkIjoiZ3JPbXZZQWVpOGFCQVJ6RVZJWWhHdHB2enRvZkFBanoiLCJyZWRpcmVjdF91cmkiOiJodHRwOi8vbG9jYWxob3N0LyIsInNjb3BlIjoib3BlbmlkIGFjY291bnRzIHBheW1lbnQiLCJzdGF0ZSI6ImFmMGlmanNsZGtqIiwiYWNyX3ZhbHVlcyI6IjMiLCJjbGFpbXMiOnsicGF5bWVudGluZm8iOnsidHlwZSI6InNlcGFfY3JlZGl0X3RyYW5zZmVyIiwidG8iOnsiYWNjb3VudF9pZCI6IjYyMTM2MDAwIiwicmVtb3RlX2JpYyI6IlJCT1NHQjIxMDlIIiwicmVtb3RlX0lCQU4iOiJHQjMyRVNTRTQwNDg2NTYyMTM2MDE2IiwicmVtb3RlX25hbWUiOiJCaWdaIG9ubGluZSBzdG9yZSJ9LCJ2YWx1ZSI6eyJjdXJyZW5jeSI6IkdCUCIsImFtb3VudCI6IjIwMCJ9LCJhZGRpdGlvbmFsIjp7InN1YmplY3QiOiJPbmxpbmUgUHVyY2hhc2UiLCJib29raW5nX2NvZGUiOiIyU0ZCSjI4NTUzIiwiYm9va2luZ19kYXRlIjoiMTQ2MjUxNzY0NTgwOSIsInZhbHVlX2RhdGUiOiIxNDYyNTE3NjQ1ODA5In0sImNoYWxsZW5nZV90eXBlIjoiU0FOREJPWF9UQU4ifX0sImlhdCI6MTQ2MjUxODk4NH0.iD7jP_l8lBxnExWWSXAcI48n6urvvmd-goNSRwGwJYg\\r\\n\\r\\n
\\r\\n\\r\\n
Please refer to https://jwt.io/introduction/ to read more about the JWT specification, how to construct a token and the available libraries.
\\r\\n\\r\\n\\r\\n\\r\\n
Open data APIs
\\r\\n\\r\\nOpen data APIs are a category of APIs that provide non-customer specific information from a bank. These offer bank-specific information, such as ATM locations, products, URLs, and events. These APIs are not subjected to user-level authenication, but are protected to be used only by signed apps. A valid client credential is essential to make these API calls.
\\r\\n", + \'value\' => "Authentication
\\r\\n\\r\\nAuthentication is based on OpenID Connect, which is based on OAuth 2.0.
\\r\\nThe user will have to authenticate with the bank using two-factor authentication, which will then provide the client application with a unique and time-bound access token. The client app can use this unique token to make calls to the bank on the behalf of the user.
\\r\\nGenerally, these access tokens are specific to a single account of a user and are valid over a longer duration (up to 30 days, for example).
\\r\\nFor the accounts and payment APIs, users need to authenticate their accounts each time an API call is made because these API calls need to meet higher security requirements.
\\r\\nThe end user authenticates the account and provides access to the app to carry out the transaction via a two-step verification on the bank site. The following steps are done to provide authentication:
\\r\\n- \\r\\n
- The user is shown a consent page from the bank where the user logs in with a customer ID and password \\r\\n
- The user is shown the consent page for providing consent for accounts information / payment details. \\r\\n
- The bank then requests the user to verify this with an OTP, which is sent to the user’s registered mobile number \\r\\n
- Once the user enters the OTP, an access token specific to that account is generated, which the app can then use to make calls on behalf of the user \\r\\n
\\r\\n
Using APIs in your app
\\r\\nYou will create the app and provide the required details to enable support for the OAuth 2.0 three-legged flows, such as the callback/redirect url.
\\r\\nIn order for the app to make any API calls, it will have to present its client ID and secret. This is to ensure that only authenticated apps can make API calls.
\\r\\nFor accessing the accounts and payments APIs, the app will first make a call to the OAuth API, so that the app can get an access token to access account(s) on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should, unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app. It should then exchange it for an access token.
\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\nThe App can then use this access token to make the calls to the accounts/payments APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\r\\nAccount Access APIs
\\r\\nFor accessing this API endpoint, the app will first make a call to the OAuth API to get a client_credential access token, then create an account request which will have the details of the access required.
\\r\\nThe account request contains the information like account information permissions, the permission expiration time etc.
\\r\\nOnce the Account request is created, the app requests for an access token for the account request created. While providing the consent, the user selects the list of accounts it wants the app to get access to.
\\r\\nThe app now gets an access token to access account(s) on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer information is retrieved from the access token and the account information is then presented to the user.
\\r\\n\\r\\n
Payment transfer APIs
\\r\\nFor accessing this API endpoint, the app will first make a call to the OAuth API to get a client_credential access token, then create a payment request which will have the details of the payment initiation.
\\r\\nThe payment request contains the information like creditor details, debitor details, the amount to be transfered, merchant details etc.
\\r\\nOnce the payment request is created, the app requests for an access token for the payment request made by the app. While providing the consent, the user selects the debit account through which the payment has to be made.
\\r\\nThe app now gets an access token to submit one time single payment on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\r\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\r\\nThe App can then use this access token to submit the payment. When the API is called, the payment is submitted according to the payment request Id for which the access token was generated.
\\r\\n\\r\\n
Open data APIs
\\r\\nOpen data APIs are a category of APIs that provide non-customer specific information from a bank. These offer bank-specific information, such as ATM locations, products, URLs, and events. These APIs are not subjected to user-level authenication, but are protected to be used only by signed apps. A valid client credential is essential to make these API calls.
", \'summary\' => \'\', \'format\' => \'full_html\', - \'safe_value\' => "Authentication
\\nAuthentication is based on OpenID Connect, which is based on OAuth 2.0.Â
\\nThe user will have to authenticate with the bank using two-factor authentication, which will then provide the client application with a unique and time-bound access token. The client app can use this unique token to make calls to the bank on the behalf of the user.
\\nGenerally, these access tokens are specific to a single account of a user and are valid over a longer duration (up to 30 days, for example).
\\nFor the payment API, users need to authenticate their accounts each time a transfer is made because these API calls need to meet higher security requirements.
\\nThe end user authenticates the account and provides access to the app to carry out the transaction via a two-step verification on the bank site. The following steps are done to provide authentication:
\\n- The user is shown a consent page from the bank where the user logs in with a customer ID and password \\n
- The bank then requests the user to verify this with an OTP, which is sent to the user’s registered mobile number \\n
- Once the user enters the OTP, the user is shown the accounts; this generates an access token specific to that account, which the app can then use to make calls on behalf of the user \\n
Â
\\nUsing APIs in your app
\\nYou will create the app and provide the required details to enable support for the OAuth 2.0 three-legged flows, such as the callback/redirect url.
\\nIn order for the app to make any API calls, it will have to present its client ID and secret. This is to ensure that only authenticated apps can make API calls.Â
\\nFor accessing the accounts API, the app will first make a call to the OAuth API, so that the app can get an access token to access a single account on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should, unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app. Â It should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\nIn the case of transfers, the app can directly make a call to the payment API wherein the bank will directly request for authentication information from the user including OTP verification and asking for consent after which the bank allows the app to make a one-time transfer on behalf of the user. In order to initiate the transfer the app has to provide information related to the payee as a JWT token. More details about how this JWT token is created is provided in the Payments API section.
\\nÂ
\\nAccount Access APIs
\\nFor accessing this API endpoint, the app will first make a call to the OAuth API, so that the app can get an access token to access a single account on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\nÂ
\\nPayment transfer APIs
\\nAssume a hypothetical scenario where the user has made a purchase from an online merchant. The user now wishes to make a payment via the payment provider (PISP) supported by this online merchant.Â
\\nThe merchant has provided the transaction-related information to the PISP and the PISP now initiates a call to the payment API. The transfer details are sent to the API in the form of a signed JWT. The JWT is signed with the client secret of the app; the API will then verify this JWT by comparing it with the signature of the app that made this request. This ensures that the token has not been tampered with. The payment information is also shown to the user while requesting consent so that the user can verify the details.
\\nThe JWT is composed of three sections: header, payload, and signature
\\nA sample header shown below. It indicates that it is a JWT token and specified the signature used for encoding the payload.
\\n{
\\n  \\"alg\\": \\"HS256\\",
\\n  \\"typ\\": \\"JWT\\"
\\n}
\\nThe payload contains the payee information as a set of payment claims. The token contains some reserved claims that are supposed to be in a JWT payload and some private claims that specify the payment details.
\\n\\n{\\n \\"iss\\": \\"https://accenture.co.uk\\", //url of the JWT issuer\\n \\"aud\\": \\"https://apis-bank-dev.apigee.net\\", //url of the party it is intended for\\n \\"client_id\\": \\"grOmvYA89jsdhkshdIYhGtpvztofAAjz\\", //client id of the registered app\\n \\"redirect_uri\\": \\"http://localhost/\\", //redirect uri of the app\\n \\"scope\\": \\"openid accounts payment\\", //requested scopes for this call\\n \\"state\\": \\"af0ifjsldkj\\", //unique state to connect request and response\\n \\"acr_values\\": \\"3\\", // request acr_values; 2 for only authentication, and 3 for OTP flow\\n \\"claims\\": {\\n \\"paymentinfo\\": {\\n \\"type\\": \\"sepa_credit_transfer\\", //transfer type\\n \\"to\\": {\\n \\"account_number\\": \\"62136000\\", //receiver account id\\n \\"remote_bic\\": \\"RBOSGB2109H\\", //receiver remote bic code\\n \\"remote_IBAN\\": \\"GB32ESSE40486562136016\\", //receiver remote iban code\\n \\"remote_name\\": \\"BigZ online store\\" //receiver name\\n },\\n \\"value\\": {\\n \\"currency\\": \\"GBP\\", //transfer currency\\n \\"amount\\": \\"200\\" //transfer amount\\n },\\n \\"additional\\": {\\n \\"subject\\": \\"Online Purchase\\", //transfer description\\n \\"booking_code\\": \\"2SFBJ28553\\", //transfer booking code\\n \\"booking_date\\": \\"1462517645809\\", //transfer booking date\\n \\"value_date\\": \\"1462517645809\\" //transfer value date\\n },\\n \\"challenge_type\\": \\"SANDBOX_TAN\\" //challenge for additional security\\n }\\n }\\n}Then, the JWT token is signed with the client secret of the registered app to ensure that it isn\'t tampered with.
\\nTo form the full token, the header and the payload is Base64Url encoded and concatenated, separated by a dot (.). This string is signed in the following way using a JWS library. There are libraries available for many languages in order to sign a JWT.
\\nHMACSHA256( base64UrlEncode(header) + \\".\\" + base64UrlEncode(payload), secret)
\\nFinally the following JWT token is obtained.
\\nÂ
\\n\\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FjY2VudHVyZS5jby51ayIsImF1ZCI6Imh0dHBzOi8vYXBpcy1iYW5rLWRldi5hcGlnZWUubmV0IiwiY2xpZW50X2lkIjoiZ3JPbXZZQWVpOGFCQVJ6RVZJWWhHdHB2enRvZkFBanoiLCJyZWRpcmVjdF91cmkiOiJodHRwOi8vbG9jYWxob3N0LyIsInNjb3BlIjoib3BlbmlkIGFjY291bnRzIHBheW1lbnQiLCJzdGF0ZSI6ImFmMGlmanNsZGtqIiwiYWNyX3ZhbHVlcyI6IjMiLCJjbGFpbXMiOnsicGF5bWVudGluZm8iOnsidHlwZSI6InNlcGFfY3JlZGl0X3RyYW5zZmVyIiwidG8iOnsiYWNjb3VudF9pZCI6IjYyMTM2MDAwIiwicmVtb3RlX2JpYyI6IlJCT1NHQjIxMDlIIiwicmVtb3RlX0lCQU4iOiJHQjMyRVNTRTQwNDg2NTYyMTM2MDE2IiwicmVtb3RlX25hbWUiOiJCaWdaIG9ubGluZSBzdG9yZSJ9LCJ2YWx1ZSI6eyJjdXJyZW5jeSI6IkdCUCIsImFtb3VudCI6IjIwMCJ9LCJhZGRpdGlvbmFsIjp7InN1YmplY3QiOiJPbmxpbmUgUHVyY2hhc2UiLCJib29raW5nX2NvZGUiOiIyU0ZCSjI4NTUzIiwiYm9va2luZ19kYXRlIjoiMTQ2MjUxNzY0NTgwOSIsInZhbHVlX2RhdGUiOiIxNDYyNTE3NjQ1ODA5In0sImNoYWxsZW5nZV90eXBlIjoiU0FOREJPWF9UQU4ifX0sImlhdCI6MTQ2MjUxODk4NH0.iD7jP_l8lBxnExWWSXAcI48n6urvvmd-goNSRwGwJYg
Â
\\nPlease refer to https://jwt.io/introduction/ to read more about the JWT specification, how to construct a token and the available libraries.
\\nÂ
\\nOpen data APIs
\\nOpen data APIs are a category of APIs that provide non-customer specific information from a bank. These offer bank-specific information, such as ATM locations, products, URLs, and events. These APIs are not subjected to user-level authenication, but are protected to be used only by signed apps. A valid client credential is essential to make these API calls.
\\n", + \'safe_value\' => "Authentication
\\nAuthentication is based on OpenID Connect, which is based on OAuth 2.0.Â
\\nThe user will have to authenticate with the bank using two-factor authentication, which will then provide the client application with a unique and time-bound access token. The client app can use this unique token to make calls to the bank on the behalf of the user.
\\nGenerally, these access tokens are specific to a single account of a user and are valid over a longer duration (up to 30 days, for example).
\\nFor the accounts and payment APIs, users need to authenticate their accounts each time an API call is made because these API calls need to meet higher security requirements.
\\nThe end user authenticates the account and provides access to the app to carry out the transaction via a two-step verification on the bank site. The following steps are done to provide authentication:
\\n- The user is shown a consent page from the bank where the user logs in with a customer ID and password \\n
- The user is shown the consent page for providing consent for accounts information / payment details. \\n
- The bank then requests the user to verify this with an OTP, which is sent to the user’s registered mobile number \\n
- Once the user enters the OTP, an access token specific to that account is generated, which the app can then use to make calls on behalf of the user \\n
Â
\\nUsing APIs in your app
\\nYou will create the app and provide the required details to enable support for the OAuth 2.0 three-legged flows, such as the callback/redirect url.
\\nIn order for the app to make any API calls, it will have to present its client ID and secret. This is to ensure that only authenticated apps can make API calls.Â
\\nFor accessing the accounts and payments APIs, the app will first make a call to the OAuth API, so that the app can get an access token to access account(s) on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should, unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app. Â It should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe App can then use this access token to make the calls to the accounts/payments APIs. When the API is called, the customer and account information is retrieved from the access token and the account information is then presented to the user.
\\nAccount Access APIs
\\nFor accessing this API endpoint, the app will first make a call to the OAuth API to get a client_credential access token, then create an account request which will have the details of the access required.
\\nThe account request contains the information like account information permissions, the permission expiration time etc.Â
\\nOnce the Account request is created, the app requests for an access token for the account request created. While providing the consent, the user selects the list of accounts it wants the app to get access to.
\\nThe app now gets an access token to access account(s) on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe App can then use this access token to make the calls to the accounts APIs. When the API is called, the customer information is retrieved from the access token and the account information is then presented to the user.
\\nÂ
\\nPayment transfer APIs
\\nFor accessing this API endpoint, the app will first make a call to the OAuth API to get a client_credential access token, then create a payment request which will have the details of the payment initiation.
\\nThe payment request contains the information like creditor details, debitor details, the amount to be transfered, merchant details etc.Â
\\nOnce the payment request is created, the app requests for an access token for the payment request made by the app. While providing the consent, the user selects the debit account through which the payment has to be made.
\\nThe app now gets an access token to submit one time single payment on behalf of the user. The OAuth APIs support both the implicit grant flow wherein the access token is returned directly to the app once the user has authenticated. If the app wishes to keep the authentication more secure (which it should unless it is a trusted app), then the app could also use the authorization code flow wherein a code is returned back to the app and it should then exchange it for an access token.
\\nThe two flows are differentiated by specifying the response_code parameter as ‘code’ for the three-legged authorization code flow and as ‘token’ for the implicit grant.
\\nThe App can then use this access token to submit the payment. When the API is called, the payment is submitted according to the payment request Id for which the access token was generated.
\\nÂ
\\nOpen data APIs
\\nOpen data APIs are a category of APIs that provide non-customer specific information from a bank. These offer bank-specific information, such as ATM locations, products, URLs, and events. These APIs are not subjected to user-level authenication, but are protected to be used only by signed apps. A valid client credential is essential to make these API calls.
\\n", \'safe_summary\' => \'\', ), ), @@ -8098,10 +8098,10 @@ function all_component_features_node_export_features_default() { \'body\' => array( \'und\' => array( array( - \'value\' => "Overview
\\r\\n\\r\\nWe have created a sandbox environment that behaves like the APIs of a live bank. We offer all the APIs that are listed in the catalogue and data of two sample banks. Here is some key sample data that you can use in your app.
\\r\\n\\r\\n\\r\\n\\r\\n
Sample data
\\r\\n\\r\\nSandbox is preloaded with two banks and customers and accounts.
\\r\\n\\r\\n| Bank | \\r\\n\\t\\t\\tCustomer | \\r\\n\\t\\t\\tAccount | \\r\\n\\t\\t
| Bank | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t 123456789 \\r\\n\\r\\n\\t\\t\\t46582398 \\r\\n\\r\\n\\t\\t\\t62936395 \\r\\n\\r\\n\\t\\t\\t84487942 \\r\\n\\t\\t\\t | \\r\\n\\t\\t\\t\\r\\n\\t\\t\\t 2139531801 \\r\\n\\r\\n\\t\\t\\t1039531801 \\r\\n\\r\\n\\t\\t\\t17109552631 \\r\\n\\r\\n\\t\\t\\t74379891646 \\r\\n\\t\\t\\t | \\r\\n\\t\\t
\\r\\n\\r\\n
Note: Some customer numbers are marked in blue. These customer numbers are not configured with registered mobile numbers, so during the consent flow you can enter a mobile number to receive the OTP. This enables the user to experience the complete flow without having to update the customer number with phone numbers. During a real flow the OTP is sent to the registered mobile number only and the mobile number is confidential and known only to the bank.
\\r\\n\\r\\nTrying the APIs
\\r\\n\\r\\nEach API can be tried using the API explorer. You can use the sample data mentioned above and to try and test the APIs. To try the APIs, click on the particular API in the menu. You will see a tab that says "Try it." This section describes the APIs and provides the ability to make API calls.
\\r\\n\\r\\n\\r\\n\\r\\n
Authentication and consent
\\r\\n\\r\\nTo enable live interaction with APIs in the sandbox, we've provided an implementation of the authentication and consent app. APIs such as account information or payment transfer require explicit end-user consent. Follow these steps to authorize before you can fire the APIs.
\\r\\n\\r\\nNote: Autho​rization calls require a client ID. In this case, however, we have preconfigured the flow with a client ID, so the consent app flow is demonstrated without using a client ID.
\\r\\n\\r\\n\\r\\n\\r\\n
Step 1) Initiate authorization
\\r\\n\\r\\nEach API is provided with a section under API explorer where you can run the API and see the results. When an API is configured to have authorization completed (i.e. to present an access token), you will see a button titled "OAuth 2.0 Set." Clicking on this button will start the OAuth flow and consent app flow.
\\r\\n\\r\\n[[{\\"fid\\":\\"150\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"295\\",\\"width\\":\\"420\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\nStep 2) Enter credentials
\\r\\n\\r\\nEnter the customer number given the sample data section above. You can type any password.
\\r\\n\\r\\n[[{\\"fid\\":\\"171\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"386\\",\\"width\\":\\"488\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\nStep 3) Provide a mobile phone for two-factor authentication
\\r\\n\\r\\nTwo-factor authentication is mandatory to secure an API. You can enter your mobile number in +<country code><mobile number> format to receive an OTP. The OTP is sent as a text message to the mobile phone. Please note that you may not receive the OTP if DND or any other such feature is enabled in your country.
\\r\\n\\r\\nNote: This step does not occur in real scenarios. The mobile number to which the OTP is sent is known to the consent app and is kept confidential. An OTP will be directly sent the registered mobile number. However, to try the APIs easily and for the purposes of the sandbox we have modified the flow to accept the mobile number as input.
\\r\\n\\r\\n[[{\\"fid\\":\\"172\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"420\\",\\"width\\":\\"481\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\nStep 4) Enter the OTP
\\r\\n\\r\\nEnter the OTP received on your mobile.
\\r\\n\\r\\n[[{\\"fid\\":\\"173\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"411\\",\\"width\\":\\"486\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\nStep 5) Give consent on the account ID
\\r\\n\\r\\nAt this time all account IDs that this customer owns with the bank will be presented. You will need to choose one of them. Consent will be given only for account access or payment.
\\r\\n\\r\\n[[{\\"fid\\":\\"174\\",\\"view_mode\\":\\"default\\",\\"type\\":\\"media\\",\\"attributes\\":{\\"height\\":\\"448\\",\\"width\\":\\"482\\",\\"class\\":\\"media-element file-default\\"}}]]
\\r\\n\\r\\nAfter the completion of this flow you will see the button "OAuth 2.0 Set" turn into "OAuth 2.0 Authenticated." This means the API explorer has the access token that it will present when you fire the APIs. To remove the authentication click on the "x" on this button.
\\r\\n", + \'value\' => "Overview
\\r\\n\\r\\nWe have created a sandbox environment that behaves like the APIs of a live bank. We offer all the APIs that are listed in the catalogue and data of two sample banks. Here is some key sample data that you can use in your app.
\\r\\n\\r\\n
Sample data
\\r\\nSandbox is preloaded with two banks and customers and accounts.
\\r\\n| Bank | \\r\\nCustomerId | \\r\\nAccount | \\r\\n
| Bank | \\r\\n\\r\\n 10203040 \\r\\n10203040 \\r\\n10203040 \\r\\n | \\r\\n\\r\\n 987654321 \\r\\n111111111 \\r\\n123459876 \\r\\n | \\r\\n
\\r\\n
Note: Customer numbers are marked in blue. These customer numbers are not configured with registered mobile numbers. So the OTP entered during the consent flow can be any random number. During a real flow the OTP is sent to the registered mobile number only and the mobile number is confidential and known only to the bank.
\\r\\nTrying the APIs
\\r\\nEach API can be tried using the API explorer. You can use the sample data mentioned above and to try and test the APIs. To try the APIs, click on the particular API in the menu. You will see a tab that says \\"Try it.\\" This section describes the APIs and provides the ability to make API calls.
\\r\\n\\r\\n
Authentication and consent
\\r\\nTo enable live interaction with APIs in the sandbox, we\'ve provided an implementation of the authentication and consent app. APIs such as account information or payment transfer require explicit end-user consent. Follow these steps to authorize before you can fire the APIs.
\\r\\nNote: Autho​rization calls require a client ID. In this case, however, we have preconfigured the flow with a client ID, so the consent app flow is demonstrated without using a client ID.
\\r\\n\\r\\n
Step 1) Initiate authorization
\\r\\nEach API is provided with a section under API explorer where you can run the API and see the results. When an API is configured to have authorization completed (i.e. to present an access token), you will see a button titled \\"OAuth 2.0 Set.\\" Clicking on this button will start the OAuth flow and consent app flow.
\\r\\nStep 2) Enter credentials
\\r\\nEnter the customer number and password.
\\r\\n\\r\\n
Step 3) Give consent on the account ID
\\r\\nAt this time all account IDs that this customer owns with the bank will be presented. You will need to choose one of them. Consent will be given only for account access or payment.
\\r\\nAfter the completion of this flow you will see the button \\"OAuth 2.0 Set\\" turn into \\"OAuth 2.0 Authenticated.\\" This means the API explorer has the access token that it will present when you fire the APIs. To remove the authentication click on the \\"x\\" on this button.
\\r\\nStep 4) Enter the OTP
\\r\\nEnter the OTP (any random nuber) .
\\r\\n", \'summary\' => \'\', \'format\' => \'full_html\', - \'safe_value\' => "
Overview
\\nWe have created a sandbox environment that behaves like the APIs of a live bank. We offer all the APIs that are listed in the catalogue and data of two sample banks. Here is some key sample data that you can use in your app.
\\nÂ
\\nSample data
\\nSandbox is preloaded with two banks and customers and accounts.
\\n| Bank | \\nCustomer | \\nAccount | \\n
| Bank | \\n\\n 123456789 \\n46582398 \\n62936395 \\n84487942 \\n | \\n\\n 2139531801 \\n1039531801 \\n17109552631 \\n74379891646 \\n | \\n
Â
\\nNote: Some customer numbers are marked in blue. These customer numbers are not configured with registered mobile numbers, so during the consent flow you can enter a mobile number to receive the OTP. This enables the user to experience the complete flow without having to update the customer number with phone numbers. During a real flow the OTP is sent to the registered mobile number only and the mobile number is confidential and known only to the bank.
\\nTrying the APIs
\\nEach API can be tried using the API explorer. You can use the sample data mentioned above and to try and test the APIs. To try the APIs, click on the particular API in the menu. You will see a tab that says \\"Try it.\\" This section describes the APIs and provides the ability to make API calls.
\\nÂ
\\nAuthentication and consent
\\nTo enable live interaction with APIs in the sandbox, we\'ve provided an implementation of the authentication and consent app. APIs such as account information or payment transfer require explicit end-user consent. Follow these steps to authorize before you can fire the APIs.Â
\\nNote: Autho​rization calls require a client ID. In this case, however, we have preconfigured the flow with a client ID, so the consent app flow is demonstrated without using a client ID.
\\nÂ
\\nStep 1) Initiate authorization
\\nEach API is provided with a section under API explorer where you can run the API and see the results. When an API is configured to have authorization completed (i.e. to present an access token), you will see a button titled \\"OAuth 2.0 Set.\\" Clicking on this button will start the OAuth flow and consent app flow.
\\n\\n\\n
\\n2consent-0.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/2consent-0.png\\")
\\n\\n \\n Step 2) Enter credentials
\\nEnter the customer number given the sample data section above. You can type any password.
\\n\\n\\n
\\n4consent.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/4consent.png\\")
\\n\\n \\n Step 3) Provide a mobile phone for two-factor authentication
\\nTwo-factor authentication is mandatory to secure an API. You can enter your mobile number in +<country code><mobile number> format to receive an OTP. The OTP is sent as a text message to the mobile phone. Please note that you may not receive the OTP if DND or any other such feature is enabled in your country.
\\nNote: This step does not occur in real scenarios. The mobile number to which the OTP is sent is known to the consent app and is kept confidential. An OTP will be directly sent the registered mobile number. However, to try the APIs easily and for the purposes of the sandbox we have modified the flow to accept the mobile number as input.
\\n\\n\\n
\\n4consent2.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/4consent2.png\\")
\\n\\n \\n Step 4) Enter the OTP
\\nEnter the OTP received on your mobile.
\\n\\n\\n
\\n4consent3.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/4consent3.png\\")
\\n\\n \\n Step 5) Give consent on the account ID
\\nAt this time all account IDs that this customer owns with the bank will be presented. You will need to choose one of them. Consent will be given only for account access or payment.
\\n\\n\\n
\\n4consent4.png
\\n \\n \\n\\n ![\\"\\"](\\"https://openbank.apigee.com/sites/default/files/4consent4.png\\")
\\n\\n \\n After the completion of this flow you will see the button \\"OAuth 2.0 Set\\" turn into \\"OAuth 2.0 Authenticated.\\" This means the API explorer has the access token that it will present when you fire the APIs. To remove the authentication click on the \\"x\\" on this button.Â
\\n", + \'safe_value\' => "Overview
\\nWe have created a sandbox environment that behaves like the APIs of a live bank. We offer all the APIs that are listed in the catalogue and data of two sample banks. Here is some key sample data that you can use in your app.
\\nÂ
\\nSample data
\\nSandbox is preloaded with two banks and customers and accounts.
\\n| Bank | \\nCustomerId | \\nAccount | \\n
| Bank | \\n\\n 10203040 \\n10203040 \\n10203040 \\n | \\n\\n 987654321 \\n111111111 \\n123459876 \\n | \\n
Â
\\nNote: Customer numbers are marked in blue. These customer numbers are not configured with registered mobile numbers. So the OTP entered during the consent flow can be any random number. During a real flow the OTP is sent to the registered mobile number only and the mobile number is confidential and known only to the bank.
\\nTrying the APIs
\\nEach API can be tried using the API explorer. You can use the sample data mentioned above and to try and test the APIs. To try the APIs, click on the particular API in the menu. You will see a tab that says \\"Try it.\\" This section describes the APIs and provides the ability to make API calls.
\\nÂ
\\nAuthentication and consent
\\nTo enable live interaction with APIs in the sandbox, we\'ve provided an implementation of the authentication and consent app. APIs such as account information or payment transfer require explicit end-user consent. Follow these steps to authorize before you can fire the APIs.Â
\\nNote: Autho​rization calls require a client ID. In this case, however, we have preconfigured the flow with a client ID, so the consent app flow is demonstrated without using a client ID.
\\nÂ
\\nStep 1) Initiate authorization
\\nEach API is provided with a section under API explorer where you can run the API and see the results. When an API is configured to have authorization completed (i.e. to present an access token), you will see a button titled \\"OAuth 2.0 Set.\\" Clicking on this button will start the OAuth flow and consent app flow.
\\nStep 2) Enter credentials
\\nEnter the customer number and password.
\\nÂ
\\nStep 3)Â Give consent on the account ID
\\nAt this time all account IDs that this customer owns with the bank will be presented. You will need to choose one of them. Consent will be given only for account access or payment.
\\nAfter the completion of this flow you will see the button \\"OAuth 2.0 Set\\" turn into \\"OAuth 2.0 Authenticated.\\" This means the API explorer has the access token that it will present when you fire the APIs. To remove the authentication click on the \\"x\\" on this button.Â
\\nStep 4) Enter the OTP
\\nEnter the OTP (any random nuber) .
\\nÂ
\\n", \'safe_summary\' => \'\', ), ), diff --git a/src/devportal/all/modules/all_component_features/all_component_features.quicktabs.inc b/src/devportal/all/modules/all_component_features/all_component_features.quicktabs.inc index 639b4ce6..9eba04cd 100644 --- a/src/devportal/all/modules/all_component_features/all_component_features.quicktabs.inc +++ b/src/devportal/all/modules/all_component_features/all_component_features.quicktabs.inc @@ -20,7 +20,7 @@ function all_component_features_quicktabs_default_quicktabs() { $quicktabs->title = 'API Documentation'; $quicktabs->tabs = array( 0 => array( - 'vid' => 'oauthapisv2_methods', + 'vid' => 'oauth-apis-v1-0_methods', 'display' => 'frontpage', 'args' => '', 'title' => 'OAuth 2.0', @@ -28,45 +28,21 @@ function all_component_features_quicktabs_default_quicktabs() { 'type' => 'view', ), 1 => array( - 'vid' => 'accountsapisv2_methods', + 'vid' => 'accounts-apis-v1-0_methods', 'display' => 'frontpage', 'args' => '', - 'title' => 'Account Access', + 'title' => 'Accounts APIs', 'weight' => '-99', 'type' => 'view', ), 2 => array( - 'vid' => 'paymentsapisv2_methods', + 'vid' => 'payments-apis-v1-0_methods', 'display' => 'frontpage', 'args' => '', - 'title' => 'Payment Transfer', + 'title' => 'Payments APIs', 'weight' => '-98', 'type' => 'view', ), - 3 => array( - 'vid' => 'open-dataapis_methods', - 'display' => 'frontpage', - 'args' => '', - 'title' => 'Open Data', - 'weight' => '-97', - 'type' => 'view', - ), - 4 => array( - 'vid' => 'userinfoapis_methods', - 'display' => 'frontpage', - 'args' => '', - 'title' => 'User Info', - 'weight' => '-96', - 'type' => 'view', - ), - 5 => array( - 'vid' => 'productapis_methods', - 'display' => 'frontpage', - 'args' => '', - 'title' => 'Products', - 'weight' => '-95', - 'type' => 'view', - ), ); $quicktabs->renderer = 'accordion'; $quicktabs->style = 'default'; diff --git a/src/devportal/all/modules/custom/openbank_swagger/openbank_swagger.module b/src/devportal/all/modules/custom/openbank_swagger/openbank_swagger.module index 02b206db..475045ee 100755 --- a/src/devportal/all/modules/custom/openbank_swagger/openbank_swagger.module +++ b/src/devportal/all/modules/custom/openbank_swagger/openbank_swagger.module @@ -4,12 +4,13 @@ require_once DRUPAL_ROOT . '/profiles/apigee/modules/custom/devconnect/lib/Crypt //define('SMARTDOCS_SAMPLE_PETSTORE_MODEL', 'petstore example'); //define('SMARTDOCS_SAMPLE_WEATHER_MODEL', 'weather example'); -define('SMARTDOCS_OAUTH_MODEL', 'oauthapisv2'); -define('SMARTDOCS_ACCOUNTS_MODEL', 'accountsapisv2'); -define('SMARTDOCS_OPENDATA_MODEL', 'open-dataapis'); -define('SMARTDOCS_PAYMENT_MODEL', 'paymentsapisv2'); +define('SMARTDOCS_OAUTH_MODEL', 'oauth-apis-v1-0'); +define('SMARTDOCS_ACCOUNTS_MODEL', 'accounts-apis-v1-0'); +define('SMARTDOCS_PAYMENT_MODEL', 'payments-apis-v1-0'); + +/*define('SMARTDOCS_OPENDATA_MODEL', 'open-dataapis'); define('SMARTDOCS_USERINFO_MODEL', 'userinfoapis'); -define('SMARTDOCS_PRODUCTS_MODEL', 'productapis'); +define('SMARTDOCS_PRODUCTS_MODEL', 'productapis');*/ ini_set('arg_separator.output', '&'); @@ -89,7 +90,8 @@ function custom_apigee_smartdocs_import_model_content() { ); */ - $model_display_name = 'oauthapisv2'; + // oauth APIs + $model_display_name = 'OAuth APIs V1.0'; $model_description = 'OAuth API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -100,7 +102,7 @@ function custom_apigee_smartdocs_import_model_content() { ), ); - $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/authv2.json'; + $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/oauthv1-0.json'; $operations[] = array( 'custom_apigee_batch_smartdocs_import_model', array( @@ -114,7 +116,7 @@ function custom_apigee_smartdocs_import_model_content() { // Account APIs - $model_display_name = 'accountsapisv2'; + $model_display_name = 'Accounts APIs V1.0'; $model_description = 'Accounts API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -125,7 +127,7 @@ function custom_apigee_smartdocs_import_model_content() { ), ); - $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/accountsinfov2.json'; + $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/accountv1-0.json'; $operations[] = array( 'custom_apigee_batch_smartdocs_import_model', array( @@ -139,7 +141,7 @@ function custom_apigee_smartdocs_import_model_content() { // Opendata APIS - $model_display_name = 'open-dataapis'; + /*$model_display_name = 'open-dataapis'; $model_description = 'OpenData API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -159,11 +161,11 @@ function custom_apigee_smartdocs_import_model_content() { 'swagger', 'application/json', ), - ); + );*/ // Payment APIs - $model_display_name = 'paymentsapisv2'; + $model_display_name = 'Payments APIs V1.0'; $model_description = 'Payment API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -174,7 +176,7 @@ function custom_apigee_smartdocs_import_model_content() { ), ); - $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/paymentsV2.json'; + $model_import_file = drupal_get_path('module', 'openbank_swagger') . '/swaggers/paymentv1-0.json'; $operations[] = array( 'custom_apigee_batch_smartdocs_import_model', array( @@ -186,7 +188,7 @@ function custom_apigee_smartdocs_import_model_content() { ); // UserInfo APIs - $model_display_name = 'userinfoapis'; + /*$model_display_name = 'userinfoapis'; $model_description = 'User information API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -206,11 +208,11 @@ function custom_apigee_smartdocs_import_model_content() { 'swagger', 'application/json', ), - ); + );*/ //products model - $model_display_name = 'productapis'; + /*$model_display_name = 'productapis'; $model_description = 'User information API documentation.'; $operations[] = array( 'custom_apigee_batch_smartdocs_create_model', @@ -230,7 +232,7 @@ function custom_apigee_smartdocs_import_model_content() { 'swagger', 'application/json', ), - ); + );*/ @@ -270,9 +272,9 @@ function custom_apigee_smartdocs_render_model_content() { $batch_oauth = custom_get_smartdocs_render_batch(SMARTDOCS_OAUTH_MODEL); $batch_accounts = custom_get_smartdocs_render_batch(SMARTDOCS_ACCOUNTS_MODEL); $batch_payment = custom_get_smartdocs_render_batch(SMARTDOCS_PAYMENT_MODEL); - $batch_opendata = custom_get_smartdocs_render_batch(SMARTDOCS_OPENDATA_MODEL); - $batch_userinfo = custom_get_smartdocs_render_batch(SMARTDOCS_USERINFO_MODEL); - $batch_products = custom_get_smartdocs_render_batch(SMARTDOCS_PRODUCTS_MODEL); + // $batch_opendata = custom_get_smartdocs_render_batch(SMARTDOCS_OPENDATA_MODEL); + //$batch_userinfo = custom_get_smartdocs_render_batch(SMARTDOCS_USERINFO_MODEL); + //$batch_products = custom_get_smartdocs_render_batch(SMARTDOCS_PRODUCTS_MODEL); $operations = array(); @@ -291,7 +293,9 @@ function custom_apigee_smartdocs_render_model_content() { if ($batch_payment != NULL) { $operations = array_merge($operations, $batch_payment['operations']); } - if ($batch_opendata != NULL) { + + + /*if ($batch_opendata != NULL) { $operations = array_merge($operations, $batch_opendata['operations']); } if ($batch_userinfo != NULL) { @@ -299,7 +303,7 @@ function custom_apigee_smartdocs_render_model_content() { } if ($batch_products != NULL) { $operations = array_merge($operations, $batch_products['operations']); - } + }*/ // Get batches to render model nodes complete. ############################################################# // Merge batches to return. diff --git a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json deleted file mode 100644 index 9920791d..00000000 --- a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json +++ /dev/null @@ -1,1297 +0,0 @@ -{ - "swagger": "2.0", - "host": "testdemorrai-test.apigee.net", - "schemes": [ - "https" - ], - "info": { - "description": "Customer Bank Account Information", - "title": "Account Information", - "version": "0.0.1", - "termsOfService": "http://example.com/about/terms", - "contact": { - "name": "API Docs", - "url": "http://example.com/contact", - "email": "solution-ninjas@google.com" - }, - "license": { - "name": "Apache 2.0", - "url": "http://example.com" - } - }, - "basePath": "/apis/v2/accounts", - "paths": { - "/accounts-requests": { - "post": { - "description": "Create a new account Request
", - "summary": "Create a new Account Request", - "operationId": "Create AccountRequest", - "tags": [ - "Create AccountRequest" - ], - "consumes": ["application/json"], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccReqResponse" - } - }, - "400": { - "description": "Bad Request" - }, - "401": { - "description": "Unauthorized access" - } - }, - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "This is Mandatory parameter. Authorization Bearer {token}; token obtained using grant_type as 'client_credentials' (App credential based authorization) using Oauth API", - "type": "string", - "required": true - }, - { - "name": "Content-Type", - "in": "header", - "description": "Content-Type application/json", - "type": "string", - "default": "application/json", - "required": true - }, - { - "name": "AccountRequest", - "in": "body", - "description": "Account Request details", - "schema": { - "$ref": "#/definitions/NewAccountRequest" - }, - "required": true - } - ] - } - }, - "/accounts-requests/{accountRequestId}": { - "get": { - "description": "This will return the account request details related to a specific account request Id provided in the path parameter
", - "summary": "get Account Request ", - "operationId": "Get Account Request", - "tags": [ - "Get AccountRequest" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccReqResponse" - } - }, - "400": { - "description": "Bad Request" - } - }, - - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string", - "required": true - }, - { - "name": "accountRequestId", - "in": "path", - "description": "Account Request Id ", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/balance": { - "get": { - "description": "This will return the account balance of a specific account of the user provided in the path parameter
", - "summary": "Account Balance ", - "operationId": "Account Balance", - "tags": [ - "AccountBalance" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBalance" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}": { - "get": { - "description": "This will return the account Information of a specific account of the user provided in the path parameter
", - "summary": "Account Information ", - "operationId": "Account Information", - "tags": [ - "AccountInformation" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountInformation" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/transactions": { - "get": { - "description": "This will return list of all the transactions of a specific account of the user provided in the path parameter
", - "summary": "Account Transactions ", - "operationId": "Account Transactions", - "tags": [ - "AccountTransactions" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountTransactions" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/beneficiaries": { - "get": { - "description": "This will return list of all the beneficiaries of a specific account of the customer provided in the path parameter
", - "summary": "Account Beneficiaries ", - "operationId": "Account Beneficiaries", - "tags": [ - "AccountBeneficiaries" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBeneficiaries" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/standing-orders": { - "get": { - "description": "This will return list of all the standing orders of a specific account of the user provided in the path parameter
", - "summary": "Account StandingOrders ", - "operationId": "Account StandingOrders", - "tags": [ - "AccountStandingOrders" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountStandingOrders" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/direct-debits": { - "get": { - "description": "This will return list of all the direct debits of a specific account of the user provided in the path parameter
", - "summary": "Account DirectDebits ", - "operationId": "Account DirectDebits", - "tags": [ - "AccountDirectDebits" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountDirectDebits" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/": { - "get": { - "description": "This will return account information of all accounts of the user provided in the account request
", - "summary": "Customer Info ", - "operationId": "Customer Info", - "tags": [ - "CustomerInfo" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CustomerInfo" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/balance": { - "get": { - "description": "This will return balance information of all accounts of the user provided in the account request
", - "summary": "Customer Balance ", - "operationId": "Customer Balance", - "tags": [ - "CustomerBalance" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBalance" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/transactions": { - "get": { - "description": "This will return list of transactions of all accounts of the user provided in the account request
", - "summary": "Customer Transactions ", - "operationId": "Customer Transactions", - "tags": [ - "CustomerTransactions" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountTransactions" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/beneficiaries": { - "get": { - "description": "This will return list of beneficiaries associated with all accounts of the user provided in the account request
", - "summary": "Customer Beneficiaries ", - "operationId": "Customer Beneficiaries", - "tags": [ - "CustomerBeneficiaries" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBeneficiaries" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/standing-orders": { - "get": { - "description": "This will return list of standing orders associated with all accounts of the user provided in the account request
", - "summary": "Customer StandingOrders ", - "operationId": "Customer StandingOrders", - "tags": [ - "CustomerStandingOrders" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountStandingOrders" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/direct-debits": { - "get": { - "description": "This will return list of direct debits associated with all accounts of the user provided in the account request
", - "summary": "Customer DirectDebits ", - "operationId": "Customer DirectDebits", - "tags": [ - "CustomerDirectDebits" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountDirectDebits" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - } - }, - - "securityDefinitions": { - "aisp_auth": { - "type": "oauth2", - "authorizationUrl": "https://testdemorrai-test.apigee.net/apis/v2/oauth/authorize?client_id=bkJ2TvlHG2xw0kg59WLDTxzJrXPi8mHh&redirect_uri=http://localhost/&response_type=code&state=af0ifjsldkj&scope=accounts&acr_values=2&request_id=firstaccountrequest", - "tokenUrl": "https://testdemorrai-test.apigee.net/apis/v2/oauth/token", - "flow": "accessCode", - "scopes": { - "accounts": "AISP apis" - } - } - }, - "definitions": { - "NewAccountRequest": { - "type": "object", - "description": "New Accounts Request", - "properties": { - "ExpiresAt": { - "type": "string", - "description": "Determines what time the Request Expires" - }, - "Permissions": { - "type": "array", - "items" : - { - "type": "string" - }, - "description": "Permissions being Requested" - }, - "PermissionsExpirationDateTime": { - "type": "string", - "description": "Expiritaion Time for Permissions" - }, - "TransactionFromDateTime": { - "type": "string", - "description": "Transaction From DateTime" - }, - "TransactionToDateTime": { - "type": "string", - "description": "Transaction To DateTime" - }, - - "SelectedAccounts": { - "type": "array", - "description": "Accounts for which Account Request is made", - "items": { - "type": "object", - "properties": { - "Account": { - "type": "object", - "description": "Accounts Details", - "properties": { - "Name": { - "type": "string", - "description": "Name of account" - }, - "SchemeName": { - "type": "string", - "description": "SchemeName of account" - }, - "Identification": { - "type": "string", - "description": "Identification of account" - }, - "SecondaryIdentification": { - "type": "string", - "description": "Secondary Identification of account" - } - - } - }, - "Servicer": { - "type": "object", - "description": "Servicer", - "properties": { - "SchemeName": { - "type": "string", - "description": "Scheme Name of Servicer" - }, - "Identification": { - "type": "string", - "description": "Identification of Servicer" - } - - } - - } - } - } - } - } - }, - "CustomerInfo": { - "description": "Account Information Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner" - }, - "Currency": { - "type": "string", - "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account." - }, - "Nickname": { - "type": "string", - "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account." - }, - "Account": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - "xml": { - "name": "CustomerInfo" - } - }, - "AccountInformation": { - "description": "Account Information Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner" - }, - "Currency": { - "type": "string", - "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account." - }, - "Nickname": { - "type": "string", - "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account." - }, - "Account": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - "xml": { - "name": "CustomerInfo" - } - }, - "AccountBalance": { - "description": "Account Balance Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner." - }, - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance." - }, - "Type": { - "type": "string", - "description": "Balance type, in a coded form." - }, - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "Date": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "CreditLine": { - "type": "object", - "properties": { - "Included": { - "type": "boolean", - "description": "Indicates whether or not the credit line is included in the balance of the account" - }, - "Type": { - "type": "string", - "description": "Limit type, in a coded form." - }, - - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - } - } - }, - "xml": { - "name": "AccountBalance" - } - }, - "AccountTransactions": { - "description": "Account Transaction Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "TransactionId": { - "type": "string", - "description": "maxLength 40 text" - }, - "TransactionReference": { - "type": "string", - "description": "Unique reference for the transaction" - }, - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the entry is a credit or a debit entry" - }, - "Status": { - "type": "string", - "description": "Status of an entry on the books of the account servicer." - }, - "TransactionInformation": { - "type": "string", - "description": "Further details of the transaction" - }, - "AddressLine": { - "type": "string", - "description": "Information that locates and identifies a specific address" - }, - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "BookingDate": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "ValueDate": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "BankTransactionCode": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "description": "Proprietary bank transaction code to identify the underlying transaction." - }, - "SubCode": { - "type": "string", - "description": "Identification of the issuer of the proprietary bank transaction code" - } - } - }, - "Balance": { - "type": "object", - "properties": { - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the balance is a credit or a debit balance" - }, - "Type": { - "type": "string", - "description": "Balance type, in a coded form." - }, - - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - } - }, - "ProprietaryBankTransactionCode": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "description": "Proprietary bank transaction code to identify the underlying transaction." - }, - "Issuer": { - "type": "string", - "description": "Identification of the issuer of the proprietary bank transaction code." - } - } - }, - "MerchantDetails": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "Name by which the merchant is known." - }, - "MerchantCategoryCode": { - "type": "string", - "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction." - } - } - } - }, - "xml": { - "name": "AccountTransactions" - } - }, - "AccountBeneficiaries": { - "description": "Account Beneficiary Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "BeneficiaryId": { - "type": "string", - "description": "maxLength 40 text" - }, - "CreditorReferenceInformation": { - "type": "string", - "description": "Unique reference for the transaction" - }, - "CreditorAccount": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - - "xml": { - "name": "AccountBeneficiaries" - } - }, - "AccReqResponse": { - "description": "Account-Request Response Object", - "type": "object", - "properties": { - "AccountRequestId": { - "type": "string", - "description": "Unique identification as assigned to identify the account request resource." - }, - "Status": { - "type": "string", - "description": "Specifies the status of the account request resource in code form." - }, - "PermissionsExpirationDateTime": { - "type": "string", - "description": "Specified date and time the permissions will expire." - }, - "TransactionFromDateTime": { - "type": "string", - "description": "Specified start date and time for the transaction query period." - }, - "TransactionToDateTime": { - "type": "string", - "description": "Specified end date and time for the transaction query period." - }, - "Permissions": { - "type": "array", - "items" : { - "type" : "string" - }, - "description": "Specified Permissions" - - }, - "SelectedAccounts": { - "type": "array", - "description": "Accounts for which Account Request is made", - "items": { - "type": "object", - "properties": { - "Account": { - "type": "object", - "description": "Accounts Details", - "properties": { - "Name": { - "type": "string", - "description": "Name of account" - }, - "SchemeName": { - "type": "string", - "description": "Scheme Name of account" - }, - "Identification": { - "type": "string", - "description": "Identification of account" - }, - "SecondaryIdentification": { - "type": "string", - "description": "Secondary Identification of account" - } - - } - }, - "Servicer": { - "type": "object", - "description": "Servicer", - "properties": { - "SchemeName": { - "type": "string", - "description": "Scheme Name of Servicer" - }, - "Identification": { - "type": "string", - "description": "Identification of Servicer" - } - - } - - } - } - } - } - }, - - "xml": { - "name": "AccReqResponse" - } - }, - "AccountStandingOrders": { - "description": "Account Standing Orders Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "StandingOrderId": { - "type": "string", - "description": "A unique and immutable identifier used to identify the standing order resource." - }, - "Currency": { - "type": "string", - "description": "Identification of the currency of the standing order" - }, - "Frequency": { - "type": "string", - "description": "Frequency Of the standing order" - }, - "CreditorReferenceInformation": { - "type": "string", - "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction." - }, - "FirstPaymentDate": { - "type": "string", - "description": "The date on which the first payment for a Standing Order schedule will be made." - }, - "NextPaymentDate": { - "type": "string", - "description": "The date on which the next payment for a Standing Order schedule will be made." - }, - "FinalPaymentDate": { - "type": "string", - "description": "The date on which the final payment for a Standing Order schedule will be made" - }, - "CreditorAccount": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - }, - "FirstPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "NextPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "FinalPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - - }, - - "xml": { - "name": "AccountStandingOrders" - } - - }, - "AccountDirectDebits": { - "description": "Account Direct Debits Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "DirectDebitId": { - "type": "string", - "description": "A unique and immutable identifier used to identify the direct debit resource." - }, - "MandateIdentification": { - "type": "string", - "description": "Direct Debit reference" - }, - "DirectDebitStatusCode": { - "type": "string", - "description": "Specifies the status of the direct debit in code form" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme" - }, - "Name": { - "type": "string", - "description": "Name of Service User" - }, - "PreviousPaymentDate": { - "type": "string", - "description": "Date of most recent direct debit collection." - }, - "PreviousPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - - }, - - "xml": { - "name": "AccountDirectDebits" - } - } - - } -} diff --git a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json.template b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json.template deleted file mode 100644 index 83e8c794..00000000 --- a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountsinfov2.json.template +++ /dev/null @@ -1,1297 +0,0 @@ -{ - "swagger": "2.0", - "host": "{{ host }}", - "schemes": [ - "https" - ], - "info": { - "description": "Customer Bank Account Information", - "title": "Account Information", - "version": "0.0.1", - "termsOfService": "http://example.com/about/terms", - "contact": { - "name": "API Docs", - "url": "http://example.com/contact", - "email": "solution-ninjas@google.com" - }, - "license": { - "name": "Apache 2.0", - "url": "http://example.com" - } - }, - "basePath": "/apis/v2/accounts", - "paths": { - "/accounts-requests": { - "post": { - "description": "Create a new account Request
", - "summary": "Create a new Account Request", - "operationId": "Create AccountRequest", - "tags": [ - "Create AccountRequest" - ], - "consumes": ["application/json"], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccReqResponse" - } - }, - "400": { - "description": "Bad Request" - }, - "401": { - "description": "Unauthorized access" - } - }, - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "This is Mandatory parameter. Authorization Bearer {token}; token obtained using grant_type as 'client_credentials' (App credential based authorization) using Oauth API", - "type": "string", - "required": true - }, - { - "name": "Content-Type", - "in": "header", - "description": "Content-Type application/json", - "type": "string", - "default": "application/json", - "required": true - }, - { - "name": "AccountRequest", - "in": "body", - "description": "Account Request details", - "schema": { - "$ref": "#/definitions/NewAccountRequest" - }, - "required": true - } - ] - } - }, - "/accounts-requests/{accountRequestId}": { - "get": { - "description": "This will return the account request details related to a specific account request Id provided in the path parameter
", - "summary": "get Account Request ", - "operationId": "Get Account Request", - "tags": [ - "Get AccountRequest" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccReqResponse" - } - }, - "400": { - "description": "Bad Request" - } - }, - - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string", - "required": true - }, - { - "name": "accountRequestId", - "in": "path", - "description": "Account Request Id ", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/balance": { - "get": { - "description": "This will return the account balance of a specific account of the user provided in the path parameter
", - "summary": "Account Balance ", - "operationId": "Account Balance", - "tags": [ - "AccountBalance" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBalance" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}": { - "get": { - "description": "This will return the account Information of a specific account of the user provided in the path parameter
", - "summary": "Account Information ", - "operationId": "Account Information", - "tags": [ - "AccountInformation" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountInformation" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/transactions": { - "get": { - "description": "This will return list of all the transactions of a specific account of the user provided in the path parameter
", - "summary": "Account Transactions ", - "operationId": "Account Transactions", - "tags": [ - "AccountTransactions" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountTransactions" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/beneficiaries": { - "get": { - "description": "This will return list of all the beneficiaries of a specific account of the customer provided in the path parameter
", - "summary": "Account Beneficiaries ", - "operationId": "Account Beneficiaries", - "tags": [ - "AccountBeneficiaries" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBeneficiaries" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/standing-orders": { - "get": { - "description": "This will return list of all the standing orders of a specific account of the user provided in the path parameter
", - "summary": "Account StandingOrders ", - "operationId": "Account StandingOrders", - "tags": [ - "AccountStandingOrders" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountStandingOrders" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/{AccountId}/direct-debits": { - "get": { - "description": "This will return list of all the direct debits of a specific account of the user provided in the path parameter
", - "summary": "Account DirectDebits ", - "operationId": "Account DirectDebits", - "tags": [ - "AccountDirectDebits" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountDirectDebits" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }, - { - "name": "AccountId", - "in": "path", - "description": "Account Id of the customer", - "type": "string", - "required": true - } - ] - } - }, - "/": { - "get": { - "description": "This will return account information of all accounts of the user provided in the account request
", - "summary": "Customer Info ", - "operationId": "Customer Info", - "tags": [ - "CustomerInfo" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CustomerInfo" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/balance": { - "get": { - "description": "This will return balance information of all accounts of the user provided in the account request
", - "summary": "Customer Balance ", - "operationId": "Customer Balance", - "tags": [ - "CustomerBalance" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBalance" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/transactions": { - "get": { - "description": "This will return list of transactions of all accounts of the user provided in the account request
", - "summary": "Customer Transactions ", - "operationId": "Customer Transactions", - "tags": [ - "CustomerTransactions" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountTransactions" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/beneficiaries": { - "get": { - "description": "This will return list of beneficiaries associated with all accounts of the user provided in the account request
", - "summary": "Customer Beneficiaries ", - "operationId": "Customer Beneficiaries", - "tags": [ - "CustomerBeneficiaries" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountBeneficiaries" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/standing-orders": { - "get": { - "description": "This will return list of standing orders associated with all accounts of the user provided in the account request
", - "summary": "Customer StandingOrders ", - "operationId": "Customer StandingOrders", - "tags": [ - "CustomerStandingOrders" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountStandingOrders" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - }, - "/direct-debits": { - "get": { - "description": "This will return list of direct debits associated with all accounts of the user provided in the account request
", - "summary": "Customer DirectDebits ", - "operationId": "Customer DirectDebits", - "tags": [ - "CustomerDirectDebits" - ], - "produces": [ - "application/json; charset=utf-8" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountDirectDebits" - } - }, - "400": { - "description": "Bad Request" - } - }, - "security": [{ - "aisp_auth": ["accounts"] - }], - "parameters": [{ - "name": "Authorization", - "in": "header", - "description": "Authorization Bearer Token", - "type": "string" - }] - } - } - }, - - "securityDefinitions": { - "aisp_auth": { - "type": "oauth2", - "authorizationUrl": "{{ host_withprotocol }}/apis/v2/oauth/authorize?client_id={{ client_id_aisp }}&redirect_uri={{ edge_host }}/v1/o/{{ org }}/apimodels/accountsapisv2/templateauths/aisp_auth/callback&response_type=code&state=af0ifjsldkj&scope=accounts&acr_values=2&request_id=firstaccountrequest", - "tokenUrl": "{{ host_withprotocol }}/apis/v2/oauth/token", - "flow": "accessCode", - "scopes": { - "accounts": "AISP apis" - } - } - }, - "definitions": { - "NewAccountRequest": { - "type": "object", - "description": "New Accounts Request", - "properties": { - "ExpiresAt": { - "type": "string", - "description": "Determines what time the Request Expires" - }, - "Permissions": { - "type": "array", - "items" : - { - "type": "string" - }, - "description": "Permissions being Requested" - }, - "PermissionsExpirationDateTime": { - "type": "string", - "description": "Expiritaion Time for Permissions" - }, - "TransactionFromDateTime": { - "type": "string", - "description": "Transaction From DateTime" - }, - "TransactionToDateTime": { - "type": "string", - "description": "Transaction To DateTime" - }, - - "SelectedAccounts": { - "type": "array", - "description": "Accounts for which Account Request is made", - "items": { - "type": "object", - "properties": { - "Account": { - "type": "object", - "description": "Accounts Details", - "properties": { - "Name": { - "type": "string", - "description": "Name of account" - }, - "SchemeName": { - "type": "string", - "description": "SchemeName of account" - }, - "Identification": { - "type": "string", - "description": "Identification of account" - }, - "SecondaryIdentification": { - "type": "string", - "description": "Secondary Identification of account" - } - - } - }, - "Servicer": { - "type": "object", - "description": "Servicer", - "properties": { - "SchemeName": { - "type": "string", - "description": "Scheme Name of Servicer" - }, - "Identification": { - "type": "string", - "description": "Identification of Servicer" - } - - } - - } - } - } - } - } - }, - "CustomerInfo": { - "description": "Account Information Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner" - }, - "Currency": { - "type": "string", - "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account." - }, - "Nickname": { - "type": "string", - "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account." - }, - "Account": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - "xml": { - "name": "CustomerInfo" - } - }, - "AccountInformation": { - "description": "Account Information Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner" - }, - "Currency": { - "type": "string", - "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account." - }, - "Nickname": { - "type": "string", - "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account." - }, - "Account": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - "xml": { - "name": "CustomerInfo" - } - }, - "AccountBalance": { - "description": "Account Balance Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "A unique identifier used to identify the account resource. This identifier has no meaning to the account owner." - }, - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance." - }, - "Type": { - "type": "string", - "description": "Balance type, in a coded form." - }, - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "Date": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "CreditLine": { - "type": "object", - "properties": { - "Included": { - "type": "boolean", - "description": "Indicates whether or not the credit line is included in the balance of the account" - }, - "Type": { - "type": "string", - "description": "Limit type, in a coded form." - }, - - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - } - } - }, - "xml": { - "name": "AccountBalance" - } - }, - "AccountTransactions": { - "description": "Account Transaction Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "TransactionId": { - "type": "string", - "description": "maxLength 40 text" - }, - "TransactionReference": { - "type": "string", - "description": "Unique reference for the transaction" - }, - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the entry is a credit or a debit entry" - }, - "Status": { - "type": "string", - "description": "Status of an entry on the books of the account servicer." - }, - "TransactionInformation": { - "type": "string", - "description": "Further details of the transaction" - }, - "AddressLine": { - "type": "string", - "description": "Information that locates and identifies a specific address" - }, - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "BookingDate": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "ValueDate": { - "type": "object", - "properties": { - "Date": { - "type": "string", - "description": "ISO Date YYYY-MM-DD" - }, - "DateTime": { - "type": "string", - "description": "1SO Date YYYY-MM-DD hh:mm:ss" - } - } - }, - "BankTransactionCode": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "description": "Proprietary bank transaction code to identify the underlying transaction." - }, - "SubCode": { - "type": "string", - "description": "Identification of the issuer of the proprietary bank transaction code" - } - } - }, - "Balance": { - "type": "object", - "properties": { - "CreditDebitIndicator": { - "type": "string", - "description": "Indicates whether the balance is a credit or a debit balance" - }, - "Type": { - "type": "string", - "description": "Balance type, in a coded form." - }, - - "Amount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - } - }, - "ProprietaryBankTransactionCode": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "description": "Proprietary bank transaction code to identify the underlying transaction." - }, - "Issuer": { - "type": "string", - "description": "Identification of the issuer of the proprietary bank transaction code." - } - } - }, - "MerchantDetails": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "Name by which the merchant is known." - }, - "MerchantCategoryCode": { - "type": "string", - "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction." - } - } - } - }, - "xml": { - "name": "AccountTransactions" - } - }, - "AccountBeneficiaries": { - "description": "Account Beneficiary Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "BeneficiaryId": { - "type": "string", - "description": "maxLength 40 text" - }, - "CreditorReferenceInformation": { - "type": "string", - "description": "Unique reference for the transaction" - }, - "CreditorAccount": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - } - }, - - "xml": { - "name": "AccountBeneficiaries" - } - }, - "AccReqResponse": { - "description": "Account-Request Response Object", - "type": "object", - "properties": { - "AccountRequestId": { - "type": "string", - "description": "Unique identification as assigned to identify the account request resource." - }, - "Status": { - "type": "string", - "description": "Specifies the status of the account request resource in code form." - }, - "PermissionsExpirationDateTime": { - "type": "string", - "description": "Specified date and time the permissions will expire." - }, - "TransactionFromDateTime": { - "type": "string", - "description": "Specified start date and time for the transaction query period." - }, - "TransactionToDateTime": { - "type": "string", - "description": "Specified end date and time for the transaction query period." - }, - "Permissions": { - "type": "array", - "items" : { - "type" : "string" - }, - "description": "Specified Permissions" - - }, - "SelectedAccounts": { - "type": "array", - "description": "Accounts for which Account Request is made", - "items": { - "type": "object", - "properties": { - "Account": { - "type": "object", - "description": "Accounts Details", - "properties": { - "Name": { - "type": "string", - "description": "Name of account" - }, - "SchemeName": { - "type": "string", - "description": "Scheme Name of account" - }, - "Identification": { - "type": "string", - "description": "Identification of account" - }, - "SecondaryIdentification": { - "type": "string", - "description": "Secondary Identification of account" - } - - } - }, - "Servicer": { - "type": "object", - "description": "Servicer", - "properties": { - "SchemeName": { - "type": "string", - "description": "Scheme Name of Servicer" - }, - "Identification": { - "type": "string", - "description": "Identification of Servicer" - } - - } - - } - } - } - } - }, - - "xml": { - "name": "AccReqResponse" - } - }, - "AccountStandingOrders": { - "description": "Account Standing Orders Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "StandingOrderId": { - "type": "string", - "description": "A unique and immutable identifier used to identify the standing order resource." - }, - "Currency": { - "type": "string", - "description": "Identification of the currency of the standing order" - }, - "Frequency": { - "type": "string", - "description": "Frequency Of the standing order" - }, - "CreditorReferenceInformation": { - "type": "string", - "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction." - }, - "FirstPaymentDate": { - "type": "string", - "description": "The date on which the first payment for a Standing Order schedule will be made." - }, - "NextPaymentDate": { - "type": "string", - "description": "The date on which the next payment for a Standing Order schedule will be made." - }, - "FinalPaymentDate": { - "type": "string", - "description": "The date on which the final payment for a Standing Order schedule will be made" - }, - "CreditorAccount": { - "type": "object", - "properties": { - "SecondaryIdentification": { - "type": "string", - "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number" - }, - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - }, - "Name": { - "type": "string", - "description": "Name of the account, as assigned by the account servicing institution" - } - } - - }, - "Servicer": { - "type": "object", - "properties": { - "Identification": { - "type": "string", - "description": "Unique and unambiguous identification of the servicing institution." - }, - "SchemeName": { - "type": "string", - "description": "Name of the identification scheme, in a coded form as published in an external list." - } - } - }, - "FirstPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "NextPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - }, - "FinalPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - - }, - - "xml": { - "name": "AccountStandingOrders" - } - - }, - "AccountDirectDebits": { - "description": "Account Direct Debits Object", - "type": "object", - "properties": { - "AccountId": { - "type": "string", - "description": "Account number to be used for the purposes of display. It does not give the complete account number but an obfuscated version only showing last 4 digits. Leading digits are replaced by ‘X’." - }, - "DirectDebitId": { - "type": "string", - "description": "A unique and immutable identifier used to identify the direct debit resource." - }, - "MandateIdentification": { - "type": "string", - "description": "Direct Debit reference" - }, - "DirectDebitStatusCode": { - "type": "string", - "description": "Specifies the status of the direct debit in code form" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme" - }, - "Name": { - "type": "string", - "description": "Name of Service User" - }, - "PreviousPaymentDate": { - "type": "string", - "description": "Date of most recent direct debit collection." - }, - "PreviousPaymentAmount": { - "type": "object", - "properties": { - "Amount": { - "type": "string", - "description": "Amount To be transferred" - }, - "Currency": { - "type": "string", - "description": "A code allocated to a currency by a Maintenance Agency " - } - } - } - - }, - - "xml": { - "name": "AccountDirectDebits" - } - } - - } -} diff --git a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json new file mode 100644 index 00000000..2e66c13e --- /dev/null +++ b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json @@ -0,0 +1,2864 @@ +{ + "swagger": "2.0", + "host": "testdemorrai-test.apigee.net", + "info": { + "title": "Account Information APIs", + "description": "Swagger specification for Account Information APIs", + "termsOfService": "https://www.openbanking.org.uk/terms", + "contact": { + "name": "Craig Greenhouse", + "email": "Craig.Greenhouse@openbanking.org.uk" + }, + "license": { + "name": "open-licence", + "url": "https://www.openbanking.org.uk/open-licence" + }, + "version": "v1.0.0" + }, + "basePath": "/ais/open-banking/v1.0", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/account-requests": { + "post": { + "summary": "Create an account request", + "description": "Create an account request", + "operationId": "CreateAccountRequest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Create an Account Request", + "required": true, + "schema": { + + "$ref": "#/definitions/AccountRequest" + + } + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "header", + "name": "x-jws-signature", + "type": "string", + "required": true, + "description": "Header containig a detached JWS signature of the body of the payload." + } + ], + "responses": { + "201": { + "description": "Account Request resource successfully created", + "schema": { + "$ref": "#/definitions/CreateAccountRequest" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containig a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + } + }, + "/account-requests/{AccountRequestId}": { + "get": { + "summary": "Get an account request", + "description": "Get an account request", + "operationId": "GetAccountRequest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountRequestId", + "in": "path", + "description": "Unique identification as assigned by the ASPSP to uniquely identify the account request resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Request resource successfully retrieved", + "schema": { + "$ref": "#/definitions/CreateAccountRequest" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + }, + "delete": { + "summary": "Delete an account request", + "description": "Delete an account request", + "operationId": "DeleteAccountRequest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountRequestId", + "in": "path", + "description": "Unique identification as assigned by the ASPSP to uniquely identify the account request resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + } + ], + "responses": { + "204": { + "description": "Account Request resource successfully deleted", + "headers": { + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + } + }, + "/accounts": { + "get": { + "summary": "Get Accounts", + "description": "Get a list of accounts", + "operationId": "GetAccounts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Accounts successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountInfo" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}": { + "get": { + "summary": "Get Account", + "description": "Get an account", + "operationId": "GetAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account resource successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountInfo" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/transactions": { + "get": { + "summary": "Get Account Transactions", + "description": "Get transactions related to an account", + "operationId": "GetAccountTransactions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fromBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions FROM - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "query", + "name": "toBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions TO - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Transactions successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountTransactions" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/beneficiaries": { + "get": { + "summary": "Get Account Beneficiaries", + "description": "Get Beneficiaries related to an account", + "operationId": "GetAccountBeneficiaries", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBeneficiaries" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/balances": { + "get": { + "summary": "Get Account Balances", + "description": "Get Balances related to an account", + "operationId": "GetAccountBalances", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBalance" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/direct-debits": { + "get": { + "summary": "Get Account Direct Debits", + "description": "Get Direct Debits related to an account", + "operationId": "GetAccountDirectDebits", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Direct Debits successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountDirectDebits" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/standing-orders": { + "get": { + "summary": "Get Account Standing Orders", + "description": "Get Standing Orders related to an account", + "operationId": "GetAccountStandingOrders", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Standing Orders successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountStandingOrders" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/product": { + "get": { + "summary": "Get Account Product", + "description": "Get Product related to an account", + "operationId": "GetAccountProduct", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Product successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountProduct" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/standing-orders": { + "get": { + "summary": "Get Standing Orders", + "description": "Get Standing Orders", + "operationId": "GetStandingOrders", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Standing Orders successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountStandingOrders" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/direct-debits": { + "get": { + "summary": "Get Direct Debits", + "description": "Get Direct Debits", + "operationId": "GetDirectDebits", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Direct Debits successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountDirectDebits" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/beneficiaries": { + "get": { + "summary": "Get Beneficiaries", + "description": "Get Beneficiaries", + "operationId": "GetBeneficiaries", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBeneficiaries" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/transactions": { + "get": { + "summary": "Get Transactions", + "description": "Get Transactions", + "operationId": "GetTransactions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "query", + "name": "fromBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions FROM - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "query", + "name": "toBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions TO - NB Time component is optional - set to 00:00:00 for just Date" + } + ], + "responses": { + "200": { + "description": "Transactions successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountTransactions" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/balances": { + "get": { + "summary": "Get Balances", + "description": "Get Balances", + "operationId": "GetBalances", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Balances successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBalance" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + } + }, + "responses": { + "400ErrorResponse": { + "description": "Bad Request" + }, + "401ErrorResponse": { + "description": "Unauthorized" + }, + "403ErrorResponse": { + "description": "Forbidden" + }, + "429ErrorResponse": { + "description": "Too Many Requests" + } + }, + "securityDefinitions": { + "PSUOAuth2Security": { + "type": "oauth2", + "flow": "accessCode", + "tokenUrl": "https://testdemorrai-test.apigee.net/apis/v1.0/oauth/token", + "authorizationUrl": "https://testdemorrai-test.apigee.net/apis/v1.0/oauth/authorize?response_type=code&client_id=zPq1BGV4OlLV7hJR1DsbfTI1t3orbDmD&state=abcd1234&scope=openid accounts&redirect_uri=https://api.enterprise.apigee.com/v1/o/testdemorrai/apimodels/accounts-apis-v1-0/templateauths/PSUOAuth2Security/callback", + "scopes": { + "accounts": "Ability to read Accounts information", + "openid" : "openId" + }, + "description": "OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU" + } + }, + "definitions": + { + "CreateAccountRequest" : + { + "title": "Account Request POST response", + "type": "object", + "properties": { + "Data": { + "title": "Data", + "type": "object", + "properties": { + "AccountRequestId": { + "description": "Unique identification as assigned to identify the account request resource.", + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "Status": { + "description": "Specifies the status of the account request resource.", + "type": "string", + "enum": [ + "Authorised", + "AwaitingAuthorisation", + "Rejected", + "Revoked" + ] + }, + "CreationDateTime": { + "description": "Date and time at which the resource was created.", + "type": "string", + "format": "date-time" + }, + "Permissions": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "array", + "items": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "string", + "enum": [ + "ReadAccountsBasic", + "ReadAccountsDetail", + "ReadBalances", + "ReadBeneficiariesBasic", + "ReadBeneficiariesDetail", + "ReadDirectDebits", + "ReadProducts", + "ReadStandingOrdersBasic", + "ReadStandingOrdersDetail", + "ReadTransactionsBasic", + "ReadTransactionsCredits", + "ReadTransactionsDebits", + "ReadTransactionsDetail" + ] + }, + "minProperties": 1, + "additionalProperties": false + }, + "ExpirationDateTime": { + "description": "Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.", + "type": "string", + "format": "date-time" + }, + "TransactionFromDateTime": { + "description": "Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.", + "type": "string", + "format": "date-time" + }, + "TransactionToDateTime": { + "description": "Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.", + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "required": [ + "AccountRequestId", + "CreationDateTime", + "Permissions" + ] + }, + "Risk": { + "title": "Risk", + "type": "object", + "description": "The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Risk" + ] + }, + "AccountInfo": + { + "title": "Account GET response", + "type": "object", + "properties": { + "Data": { + "title": "Account", + "type": "array", + "items": { + "type": "object", + "title": "Account", + "description": "Account", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Currency": { + "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.", + "type": "string", + "pattern": "^[A-Z]{3}$" + }, + "Nickname": { + "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "Account": { + "description": "Provides the details to identify an account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Currency" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountTransactions" : + { + "title": "Account Transactions GET response", + "type": "object", + "properties": { + "Data": { + "title": "Transaction", + "description": "Data Section of the Payload", + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "TransactionId": { + "description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "TransactionReference": { + "description": "Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Amount": { + "description": "Amount of money in the cash entry.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the transaction is a credit or a debit entry.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Status": { + "description": "Status of a transaction entry on the books of the account servicer.", + "type": "string", + "enum": [ + "Booked", + "Pending" + ] + }, + "BookingDateTime": { + "description": "Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.", + "type": "string", + "format": "date-time" + }, + "ValueDateTime": { + "description": "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date. For entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.", + "type": "string", + "format": "date-time" + }, + "TransactionInformation": { + "description": "Further details of the transaction. This is the transaction narrative, which is unstructured text.", + "type": "string", + "minLength": 1, + "maxLength": 500 + }, + "AddressLine": { + "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "BankTransactionCode": { + "description": "Set of elements used to fully identify the type of underlying transaction resulting in an entry.", + "type": "object", + "properties": { + "Code": { + "description": "Specifies the family within a domain.", + "type": "string" + }, + "SubCode": { + "description": "Specifies the sub-product family within a specific family.", + "type": "string" + } + }, + "required": [ + "Code", + "SubCode" + ], + "additionalProperties": false + }, + "ProprietaryBankTransactionCode": { + "description": "Set of elements to fully identify a proprietary bank transaction code.", + "type": "object", + "properties": { + "Code": { + "description": "Proprietary bank transaction code to identify the underlying transaction.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Issuer": { + "description": "Identification of the issuer of the proprietary bank transaction code.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "Code" + ], + "additionalProperties": false + }, + "Balance": { + "description": "Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.", + "type": "object", + "properties": { + "Amount": { + "description": "Amount of money of the cash balance after a transaction entry is applied to the account..", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Type": { + "description": "Balance type, in a coded form.", + "type": "string", + "enum": [ + "ClosingAvailable", + "ClosingBooked", + "Expected", + "ForwardAvailable", + "Information", + "InterimAvailable", + "InterimBooked", + "OpeningAvailable", + "OpeningBooked", + "PreviouslyClosedBooked" + ] + } + }, + "additionalProperties": false, + "required": [ + "Amount", + "CreditDebitIndicator", + "Type" + ] + }, + "MerchantDetails": { + "description": "Details of the merchant involved in the transaction.", + "type": "object", + "properties": { + "MerchantName": { + "description": "Name by which the merchant is known.", + "type": "string", + "minLength": 1, + "maxLength": 350 + }, + "MerchantCategoryCode": { + "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.", + "type": "string", + "minLength": 3, + "maxLength": 4 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Amount", + "CreditDebitIndicator", + "Status", + "BookingDateTime" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountBeneficiaries" : + { + "title": "Beneficiaries GET response", + "type": "object", + "properties": { + "Data": { + "title": "Beneficiary", + "type": "array", + "items": { + "type": "object", + "title": "Beneficiary", + "description": "Beneficiary", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "BeneficiaryId": { + "description": "A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Reference": { + "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "CreditorAccount": { + "description": "Provides the details to identify the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountBalance": + { + "title": "Balances GET response", + "type": "object", + "properties": { + "Data": { + "title": "Balance", + "type": "array", + "items": { + "type": "object", + "title": "Balance", + "description": "Balance", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Amount": { + "description": "Amount of money of the cash balance.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Type": { + "description": "Balance type, in a coded form.", + "type": "string", + "enum": [ + "ClosingAvailable", + "ClosingBooked", + "Expected", + "ForwardAvailable", + "Information", + "InterimAvailable", + "InterimBooked", + "OpeningAvailable", + "OpeningBooked", + "PreviouslyClosedBooked" + ] + }, + "DateTime": { + "description": "Indicates the date (and time) of the balance.", + "type": "string", + "format": "date-time" + }, + "CreditLine": { + "type": "object", + "properties": { + "Included": { + "description": "Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.", + "type": "boolean" + }, + "Amount": { + "description": "Active Or Historic Currency Code and Amount", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "Type": { + "description": "Limit type, in a coded form.", + "type": "string", + "enum": [ + "Pre-Agreed", + "Emergency", + "Temporary" + ] + } + }, + "additionalProperties": false, + "required": [ + "Included" + ] + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Amount", + "CreditDebitIndicator", + "DateTime", + "Type" + ] + }, + "minItems": 1 + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountDirectDebits": + {"title": "Account GET response", + "type": "object", + "properties": { + "Data": { + "title": "DirectDebit", + "type": "array", + "items": { + "type": "object", + "title": "Direct Debit", + "description": "Direct Debit", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "DirectDebitId": { + "description": "A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "MandateIdentification": { + "description": "Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "DirectDebitStatusCode": { + "description": "Specifies the status of the direct debit in code form.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ] + }, + "Name": { + "description": "Name of Service User", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "PreviousPaymentDateTime": { + "description": "Date of most recent direct debit collection.", + "type": "string", + "format": "date-time" + }, + "PreviousPaymentAmount": { + "description": "The amount of the most recent direct debit collection.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + } + }, + "required": [ + "AccountId", + "MandateIdentification", + "Name" + ], + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountStandingOrders" : + { + "title": "Standing Orders GET response", + "type": "object", + "properties": { + "Data": { + "title": "StandingOrder", + "type": "array", + "items": { + "type": "object", + "title": "Standing Order", + "description": "Standing Order", + "properties": { + "AccountId": { + "description": "The date on which the first payment for a Standing Order schedule will be made.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "StandingOrderId": { + "description": "A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Frequency": { + "description": "EvryWorkgDay - PSC070 IntrvlWkDay:PSC110:PSC080 (PSC070 code + PSC110 + PSC080) WkInMnthDay:PSC100:PSC080 (PSC070 code + PSC100 + PSC080) IntrvlMnthDay:PSC120:PSC090 (PSC070 code + PSC120 + PSC090) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) PSC070 + PSC130 The following response codes may be generated by this data element: PSC070: T221 - Schedule code must be a valid enumeration value. PSC070: T245 - Must be provided for standing order only. PSC080: T222 - Day in week must be within defined bounds (range 1 to 5). PSC080: T229 - Must be present if Schedule Code = IntrvlWkDay. PSC080: T231 - Must be present if Schedule Code = WkInMnthDay. PSC090: T223 - Day in month must be within defined bounds (range -5 to 31 excluding: 0 & 00). PSC090: T233 - Must be present if Schedule Code = IntrvlMnthDay. PSC100: T224 - Week in month must be within defined bounds (range 1 to 5). PSC100: T232 - Must be present if Schedule Code = WkInMnthDay. PSC110: T225 - Interval in weeks must be within defined bounds (range 1 to 9). PSC110: T230 - Must be present if Schedule Code = IntrvlWkDay. PSC120: T226 - Interval in months must be a valid enumeration value (range 1 to 6, 12 and 24). PSC120: T234 - Must be present if Schedule Code = IntrvlMnthDay. PSC130: T227 - Quarter Day must be a valid enumeration value. PSC130: T235 - Must be present if Schedule Code = QtrDay. The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-5] WkInMnthDay:0[1-5]:0[1-5] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Mandatory/Conditional/Optional/Parent/Leaf: OL Type: 35 char string Regular Expression(s): (EvryWorkgDay)|(IntrvlWkDay:0[1-9]:0[1-5])|(WkInMnthDay:0[1-5]:0[1-5])|(IntrvlMnthDay:(0[1- 6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))|(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))", + "type": "string", + "pattern": "^((EvryWorkgDay)|(IntrvlWkDay:0[1-9]:0[1-5])|(WkInMnthDay:0[1-5]:0[1-5])|(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))|(QtrDay:(ENGLISH|SCOTTISH|RECEIVED)))$" + }, + "Reference": { + "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "FirstPaymentDateTime": { + "description": "The date on which the first payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "FirstPaymentAmount": { + "description": "The amount of the first Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "NextPaymentDateTime": { + "description": "The date on which the next payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "NextPaymentAmount": { + "description": "The amount of the next Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "FinalPaymentDateTime": { + "description": "The date on which the final payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "FinalPaymentAmount": { + "description": "The amount of the final Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "CreditorAccount": { + "description": "Provides the details to identify the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "required": [ + "AccountId", + "Frequency", + "NextPaymentDateTime", + "NextPaymentAmount" + ], + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountProduct" : + { + "title": "Product GET response", + "type": "object", + "properties": { + "Data": { + "title": "Product", + "type": "array", + "items": { + "type": "object", + "title": "Product", + "description": "Product", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "ProductIdentifier": { + "description": "Identifier within the parent organisation for the product. Must be unique in the organisation.", + "type": "string" + }, + "ProductType": { + "description": "Descriptive code for the product category.", + "type": "string", + "enum": [ + "BCA", + "PCA" + ] + }, + "ProductName": { + "description": "The name of the product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.", + "type": "string" + }, + "SecondaryProductIdentifier": { + "description": "Identifier within the parent organisation for the product. Must be unique in the organisation.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "ProductIdentifier", + "ProductType" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountRequest" : + { + "title": "Account Request POST request", + "description": "Allows setup of an account access request", + "type": "object", + "properties": { + "Data": { + "title": "Data", + "description": "Allows setup of an account access request", + "type": "object", + "properties": { + "Permissions": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "array", + "items": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "string", + "enum": [ + "ReadAccountsBasic", + "ReadAccountsDetail", + "ReadBalances", + "ReadBeneficiariesBasic", + "ReadBeneficiariesDetail", + "ReadDirectDebits", + "ReadProducts", + "ReadStandingOrdersBasic", + "ReadStandingOrdersDetail", + "ReadTransactionsBasic", + "ReadTransactionsCredits", + "ReadTransactionsDebits", + "ReadTransactionsDetail" + ] + }, + "minProperties": 1, + "additionalProperties": false + }, + "ExpirationDateTime": { + "description": "Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.", + "type": "string", + "format": "date-time" + }, + "TransactionFromDateTime": { + "description": "Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.", + "type": "string", + "format": "date-time" + }, + "TransactionToDateTime": { + "description": "Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.", + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "required": [ + "Permissions" + ] + }, + "Risk": { + "title": "Risk", + "type": "object", + "description": "The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Risk" + ] + } + } +} \ No newline at end of file diff --git a/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json.template b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json.template new file mode 100644 index 00000000..f7100ba2 --- /dev/null +++ b/src/devportal/all/modules/custom/openbank_swagger/swaggers/accountv1-0.json.template @@ -0,0 +1,2864 @@ +{ + "swagger": "2.0", + "host": "{{ host }}", + "info": { + "title": "Account Information APIs", + "description": "Swagger specification for Account Information APIs", + "termsOfService": "https://www.openbanking.org.uk/terms", + "contact": { + "name": "Craig Greenhouse", + "email": "Craig.Greenhouse@openbanking.org.uk" + }, + "license": { + "name": "open-licence", + "url": "https://www.openbanking.org.uk/open-licence" + }, + "version": "v1.0.0" + }, + "basePath": "/ais/open-banking/v1.0", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/account-requests": { + "post": { + "summary": "Create an account request", + "description": "Create an account request", + "operationId": "CreateAccountRequest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Create an Account Request", + "required": true, + "schema": { + + "$ref": "#/definitions/AccountRequest" + + } + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "header", + "name": "x-jws-signature", + "type": "string", + "required": true, + "description": "Header containig a detached JWS signature of the body of the payload." + } + ], + "responses": { + "201": { + "description": "Account Request resource successfully created", + "schema": { + "$ref": "#/definitions/CreateAccountRequest" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containig a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + } + }, + "/account-requests/{AccountRequestId}": { + "get": { + "summary": "Get an account request", + "description": "Get an account request", + "operationId": "GetAccountRequest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountRequestId", + "in": "path", + "description": "Unique identification as assigned by the ASPSP to uniquely identify the account request resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Request resource successfully retrieved", + "schema": { + "$ref": "#/definitions/CreateAccountRequest" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + }, + "delete": { + "summary": "Delete an account request", + "description": "Delete an account request", + "operationId": "DeleteAccountRequest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountRequestId", + "in": "path", + "description": "Unique identification as assigned by the ASPSP to uniquely identify the account request resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "required": true, + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + } + ], + "responses": { + "204": { + "description": "Account Request resource successfully deleted", + "headers": { + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + } + } + }, + "/accounts": { + "get": { + "summary": "Get Accounts", + "description": "Get a list of accounts", + "operationId": "GetAccounts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Accounts successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountInfo" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}": { + "get": { + "summary": "Get Account", + "description": "Get an account", + "operationId": "GetAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account resource successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountInfo" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/transactions": { + "get": { + "summary": "Get Account Transactions", + "description": "Get transactions related to an account", + "operationId": "GetAccountTransactions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fromBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions FROM - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "query", + "name": "toBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions TO - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Transactions successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountTransactions" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/beneficiaries": { + "get": { + "summary": "Get Account Beneficiaries", + "description": "Get Beneficiaries related to an account", + "operationId": "GetAccountBeneficiaries", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBeneficiaries" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/balances": { + "get": { + "summary": "Get Account Balances", + "description": "Get Balances related to an account", + "operationId": "GetAccountBalances", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBalance" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/direct-debits": { + "get": { + "summary": "Get Account Direct Debits", + "description": "Get Direct Debits related to an account", + "operationId": "GetAccountDirectDebits", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Direct Debits successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountDirectDebits" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/standing-orders": { + "get": { + "summary": "Get Account Standing Orders", + "description": "Get Standing Orders related to an account", + "operationId": "GetAccountStandingOrders", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Standing Orders successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountStandingOrders" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/accounts/{AccountId}/product": { + "get": { + "summary": "Get Account Product", + "description": "Get Product related to an account", + "operationId": "GetAccountProduct", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "AccountId", + "in": "path", + "description": "A unique identifier used to identify the account resource.", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Account Product successfully retrieved", + "schema": { + "$ref": "#/definitions/AccountProduct" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/standing-orders": { + "get": { + "summary": "Get Standing Orders", + "description": "Get Standing Orders", + "operationId": "GetStandingOrders", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Standing Orders successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountStandingOrders" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/direct-debits": { + "get": { + "summary": "Get Direct Debits", + "description": "Get Direct Debits", + "operationId": "GetDirectDebits", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Direct Debits successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountDirectDebits" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/beneficiaries": { + "get": { + "summary": "Get Beneficiaries", + "description": "Get Beneficiaries", + "operationId": "GetBeneficiaries", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Beneficiaries successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBeneficiaries" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/transactions": { + "get": { + "summary": "Get Transactions", + "description": "Get Transactions", + "operationId": "GetTransactions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + }, + { + "in": "query", + "name": "fromBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions FROM - NB Time component is optional - set to 00:00:00 for just Date" + }, + { + "in": "query", + "name": "toBookingDateTime", + "type": "string", + "format": "date-time", + "description": "The UTC ISO 8601 Date Time to filter transactions TO - NB Time component is optional - set to 00:00:00 for just Date" + } + ], + "responses": { + "200": { + "description": "Transactions successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountTransactions" + + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + }, + "/balances": { + "get": { + "summary": "Get Balances", + "description": "Get Balances", + "operationId": "GetBalances", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "x-fapi-financial-id", + "type": "string", + "required": true, + "default" : "123456789", + "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB." + }, + { + "in": "header", + "name": "x-fapi-customer-last-logged-time", + "type": "string", + "required": false, + "description": "The time when the PSU last logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-customer-ip-address", + "type": "string", + "default" : "10.20.30.40", + "required": false, + "description": "The PSU's IP address if the PSU is currently logged in with the TPP." + }, + { + "in": "header", + "name": "x-fapi-interaction-id", + "type": "string", + "required": false, + "description": "An RFC4122 UID used as a correlation id." + }, + { + "in": "header", + "name": "Authorization", + "type": "string", + "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" + } + ], + "responses": { + "200": { + "description": "Balances successfully retrieved", + "schema": { + + "$ref": "#/definitions/AccountBalance" + }, + "headers": { + "x-jws-signature": { + "type": "string", + "description": "Header containing a detached JWS signature of the body of the payload." + }, + "x-fapi-interaction-id": { + "type": "string", + "description": "An RFC4122 UID used as a correlation id." + } + } + }, + "400": { + "description": "Bad Request" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too Many Requests" + } + }, + "security": [ + { + "PSUOAuth2Security": [ + "accounts","openid" + ] + } + ] + } + } + }, + "responses": { + "400ErrorResponse": { + "description": "Bad Request" + }, + "401ErrorResponse": { + "description": "Unauthorized" + }, + "403ErrorResponse": { + "description": "Forbidden" + }, + "429ErrorResponse": { + "description": "Too Many Requests" + } + }, + "securityDefinitions": { + "PSUOAuth2Security": { + "type": "oauth2", + "flow": "accessCode", + "tokenUrl": "{{ host_withprotocol }}/apis/v1.0/oauth/token", + "authorizationUrl": "{{ host_withprotocol }}/apis/v1.0/oauth/authorize?response_type=code&client_id={{ client_id_aisp }}&state=abcd1234&scope=openid accounts&redirect_uri=https://api.enterprise.apigee.com/v1/o/{{ org }}/apimodels/accounts-apis-v1-0/templateauths/PSUOAuth2Security/callback", + "scopes": { + "accounts": "Ability to read Accounts information", + "openid" : "openId" + }, + "description": "OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU" + } + }, + "definitions": + { + "CreateAccountRequest" : + { + "title": "Account Request POST response", + "type": "object", + "properties": { + "Data": { + "title": "Data", + "type": "object", + "properties": { + "AccountRequestId": { + "description": "Unique identification as assigned to identify the account request resource.", + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "Status": { + "description": "Specifies the status of the account request resource.", + "type": "string", + "enum": [ + "Authorised", + "AwaitingAuthorisation", + "Rejected", + "Revoked" + ] + }, + "CreationDateTime": { + "description": "Date and time at which the resource was created.", + "type": "string", + "format": "date-time" + }, + "Permissions": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "array", + "items": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "string", + "enum": [ + "ReadAccountsBasic", + "ReadAccountsDetail", + "ReadBalances", + "ReadBeneficiariesBasic", + "ReadBeneficiariesDetail", + "ReadDirectDebits", + "ReadProducts", + "ReadStandingOrdersBasic", + "ReadStandingOrdersDetail", + "ReadTransactionsBasic", + "ReadTransactionsCredits", + "ReadTransactionsDebits", + "ReadTransactionsDetail" + ] + }, + "minProperties": 1, + "additionalProperties": false + }, + "ExpirationDateTime": { + "description": "Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.", + "type": "string", + "format": "date-time" + }, + "TransactionFromDateTime": { + "description": "Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.", + "type": "string", + "format": "date-time" + }, + "TransactionToDateTime": { + "description": "Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.", + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "required": [ + "AccountRequestId", + "CreationDateTime", + "Permissions" + ] + }, + "Risk": { + "title": "Risk", + "type": "object", + "description": "The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Risk" + ] + }, + "AccountInfo": + { + "title": "Account GET response", + "type": "object", + "properties": { + "Data": { + "title": "Account", + "type": "array", + "items": { + "type": "object", + "title": "Account", + "description": "Account", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Currency": { + "description": "Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.", + "type": "string", + "pattern": "^[A-Z]{3}$" + }, + "Nickname": { + "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "Account": { + "description": "Provides the details to identify an account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Currency" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountTransactions" : + { + "title": "Account Transactions GET response", + "type": "object", + "properties": { + "Data": { + "title": "Transaction", + "description": "Data Section of the Payload", + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "TransactionId": { + "description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "TransactionReference": { + "description": "Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Amount": { + "description": "Amount of money in the cash entry.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the transaction is a credit or a debit entry.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Status": { + "description": "Status of a transaction entry on the books of the account servicer.", + "type": "string", + "enum": [ + "Booked", + "Pending" + ] + }, + "BookingDateTime": { + "description": "Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.", + "type": "string", + "format": "date-time" + }, + "ValueDateTime": { + "description": "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date. For entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.", + "type": "string", + "format": "date-time" + }, + "TransactionInformation": { + "description": "Further details of the transaction. This is the transaction narrative, which is unstructured text.", + "type": "string", + "minLength": 1, + "maxLength": 500 + }, + "AddressLine": { + "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "BankTransactionCode": { + "description": "Set of elements used to fully identify the type of underlying transaction resulting in an entry.", + "type": "object", + "properties": { + "Code": { + "description": "Specifies the family within a domain.", + "type": "string" + }, + "SubCode": { + "description": "Specifies the sub-product family within a specific family.", + "type": "string" + } + }, + "required": [ + "Code", + "SubCode" + ], + "additionalProperties": false + }, + "ProprietaryBankTransactionCode": { + "description": "Set of elements to fully identify a proprietary bank transaction code.", + "type": "object", + "properties": { + "Code": { + "description": "Proprietary bank transaction code to identify the underlying transaction.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Issuer": { + "description": "Identification of the issuer of the proprietary bank transaction code.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "Code" + ], + "additionalProperties": false + }, + "Balance": { + "description": "Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.", + "type": "object", + "properties": { + "Amount": { + "description": "Amount of money of the cash balance after a transaction entry is applied to the account..", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Type": { + "description": "Balance type, in a coded form.", + "type": "string", + "enum": [ + "ClosingAvailable", + "ClosingBooked", + "Expected", + "ForwardAvailable", + "Information", + "InterimAvailable", + "InterimBooked", + "OpeningAvailable", + "OpeningBooked", + "PreviouslyClosedBooked" + ] + } + }, + "additionalProperties": false, + "required": [ + "Amount", + "CreditDebitIndicator", + "Type" + ] + }, + "MerchantDetails": { + "description": "Details of the merchant involved in the transaction.", + "type": "object", + "properties": { + "MerchantName": { + "description": "Name by which the merchant is known.", + "type": "string", + "minLength": 1, + "maxLength": 350 + }, + "MerchantCategoryCode": { + "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.", + "type": "string", + "minLength": 3, + "maxLength": 4 + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Amount", + "CreditDebitIndicator", + "Status", + "BookingDateTime" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountBeneficiaries" : + { + "title": "Beneficiaries GET response", + "type": "object", + "properties": { + "Data": { + "title": "Beneficiary", + "type": "array", + "items": { + "type": "object", + "title": "Beneficiary", + "description": "Beneficiary", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "BeneficiaryId": { + "description": "A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Reference": { + "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "CreditorAccount": { + "description": "Provides the details to identify the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountBalance": + { + "title": "Balances GET response", + "type": "object", + "properties": { + "Data": { + "title": "Balance", + "type": "array", + "items": { + "type": "object", + "title": "Balance", + "description": "Balance", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Amount": { + "description": "Amount of money of the cash balance.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "CreditDebitIndicator": { + "description": "Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.", + "type": "string", + "enum": [ + "Credit", + "Debit" + ] + }, + "Type": { + "description": "Balance type, in a coded form.", + "type": "string", + "enum": [ + "ClosingAvailable", + "ClosingBooked", + "Expected", + "ForwardAvailable", + "Information", + "InterimAvailable", + "InterimBooked", + "OpeningAvailable", + "OpeningBooked", + "PreviouslyClosedBooked" + ] + }, + "DateTime": { + "description": "Indicates the date (and time) of the balance.", + "type": "string", + "format": "date-time" + }, + "CreditLine": { + "type": "object", + "properties": { + "Included": { + "description": "Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.", + "type": "boolean" + }, + "Amount": { + "description": "Active Or Historic Currency Code and Amount", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "Type": { + "description": "Limit type, in a coded form.", + "type": "string", + "enum": [ + "Pre-Agreed", + "Emergency", + "Temporary" + ] + } + }, + "additionalProperties": false, + "required": [ + "Included" + ] + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "Amount", + "CreditDebitIndicator", + "DateTime", + "Type" + ] + }, + "minItems": 1 + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountDirectDebits": + {"title": "Account GET response", + "type": "object", + "properties": { + "Data": { + "title": "DirectDebit", + "type": "array", + "items": { + "type": "object", + "title": "Direct Debit", + "description": "Direct Debit", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "DirectDebitId": { + "description": "A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "MandateIdentification": { + "description": "Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "DirectDebitStatusCode": { + "description": "Specifies the status of the direct debit in code form.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ] + }, + "Name": { + "description": "Name of Service User", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "PreviousPaymentDateTime": { + "description": "Date of most recent direct debit collection.", + "type": "string", + "format": "date-time" + }, + "PreviousPaymentAmount": { + "description": "The amount of the most recent direct debit collection.", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + } + }, + "required": [ + "AccountId", + "MandateIdentification", + "Name" + ], + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountStandingOrders" : + { + "title": "Standing Orders GET response", + "type": "object", + "properties": { + "Data": { + "title": "StandingOrder", + "type": "array", + "items": { + "type": "object", + "title": "Standing Order", + "description": "Standing Order", + "properties": { + "AccountId": { + "description": "The date on which the first payment for a Standing Order schedule will be made.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "StandingOrderId": { + "description": "A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "Frequency": { + "description": "EvryWorkgDay - PSC070 IntrvlWkDay:PSC110:PSC080 (PSC070 code + PSC110 + PSC080) WkInMnthDay:PSC100:PSC080 (PSC070 code + PSC100 + PSC080) IntrvlMnthDay:PSC120:PSC090 (PSC070 code + PSC120 + PSC090) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) PSC070 + PSC130 The following response codes may be generated by this data element: PSC070: T221 - Schedule code must be a valid enumeration value. PSC070: T245 - Must be provided for standing order only. PSC080: T222 - Day in week must be within defined bounds (range 1 to 5). PSC080: T229 - Must be present if Schedule Code = IntrvlWkDay. PSC080: T231 - Must be present if Schedule Code = WkInMnthDay. PSC090: T223 - Day in month must be within defined bounds (range -5 to 31 excluding: 0 & 00). PSC090: T233 - Must be present if Schedule Code = IntrvlMnthDay. PSC100: T224 - Week in month must be within defined bounds (range 1 to 5). PSC100: T232 - Must be present if Schedule Code = WkInMnthDay. PSC110: T225 - Interval in weeks must be within defined bounds (range 1 to 9). PSC110: T230 - Must be present if Schedule Code = IntrvlWkDay. PSC120: T226 - Interval in months must be a valid enumeration value (range 1 to 6, 12 and 24). PSC120: T234 - Must be present if Schedule Code = IntrvlMnthDay. PSC130: T227 - Quarter Day must be a valid enumeration value. PSC130: T235 - Must be present if Schedule Code = QtrDay. The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-5] WkInMnthDay:0[1-5]:0[1-5] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Mandatory/Conditional/Optional/Parent/Leaf: OL Type: 35 char string Regular Expression(s): (EvryWorkgDay)|(IntrvlWkDay:0[1-9]:0[1-5])|(WkInMnthDay:0[1-5]:0[1-5])|(IntrvlMnthDay:(0[1- 6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))|(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))", + "type": "string", + "pattern": "^((EvryWorkgDay)|(IntrvlWkDay:0[1-9]:0[1-5])|(WkInMnthDay:0[1-5]:0[1-5])|(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))|(QtrDay:(ENGLISH|SCOTTISH|RECEIVED)))$" + }, + "Reference": { + "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", + "type": "string", + "minLength": 1, + "maxLength": 35 + }, + "FirstPaymentDateTime": { + "description": "The date on which the first payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "FirstPaymentAmount": { + "description": "The amount of the first Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "NextPaymentDateTime": { + "description": "The date on which the next payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "NextPaymentAmount": { + "description": "The amount of the next Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "FinalPaymentDateTime": { + "description": "The date on which the final payment for a Standing Order schedule will be made.", + "type": "string", + "format": "date-time" + }, + "FinalPaymentAmount": { + "description": "The amount of the final Standing Order", + "type": "object", + "properties": { + "Amount": { + "type": "string", + "pattern": "^-?\\d{1,13}\\.\\d{1,5}$" + }, + "Currency": { + "description": "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'", + "type": "string", + "pattern": "^[A-Z]{3}$" + } + }, + "required": [ + "Amount", + "Currency" + ], + "additionalProperties": false + }, + "Servicer": { + "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BICFI", + "UKSortCode" + ] + }, + "Identification": { + "description": "Unique and unambiguous identification of the servicing institution.", + "type": "string", + "minLength": 1, + "maxLength": 35 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + }, + "CreditorAccount": { + "description": "Provides the details to identify the beneficiary account.", + "type": "object", + "properties": { + "SchemeName": { + "description": "Name of the identification scheme, in a coded form as published in an external list.", + "type": "string", + "enum": [ + "BBAN", + "IBAN" + ] + }, + "Identification": { + "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 34 + }, + "Name": { + "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.", + "type": "string", + "minLength": 1, + "maxLength": 70 + }, + "SecondaryIdentification": { + "description": "This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).", + "type": "string", + "minLength": 1, + "maxLength": 34 + } + }, + "required": [ + "SchemeName", + "Identification" + ], + "additionalProperties": false + } + }, + "required": [ + "AccountId", + "Frequency", + "NextPaymentDateTime", + "NextPaymentAmount" + ], + "additionalProperties": false + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountProduct" : + { + "title": "Product GET response", + "type": "object", + "properties": { + "Data": { + "title": "Product", + "type": "array", + "items": { + "type": "object", + "title": "Product", + "description": "Product", + "properties": { + "AccountId": { + "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", + "type": "string", + "minLength": 1, + "maxLength": 40 + }, + "ProductIdentifier": { + "description": "Identifier within the parent organisation for the product. Must be unique in the organisation.", + "type": "string" + }, + "ProductType": { + "description": "Descriptive code for the product category.", + "type": "string", + "enum": [ + "BCA", + "PCA" + ] + }, + "ProductName": { + "description": "The name of the product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.", + "type": "string" + }, + "SecondaryProductIdentifier": { + "description": "Identifier within the parent organisation for the product. Must be unique in the organisation.", + "type": "string" + } + }, + "additionalProperties": false, + "required": [ + "AccountId", + "ProductIdentifier", + "ProductType" + ] + } + }, + "Links": { + "title": "Links", + "type": "object", + "description": "Links relevant to the payload", + "properties": { + "self": { + "type": "string", + "format": "uri" + }, + "first": { + "type": "string", + "format": "uri" + }, + "prev": { + "type": "string", + "format": "uri" + }, + "next": { + "type": "string", + "format": "uri" + }, + "last": { + "type": "string", + "format": "uri" + } + }, + "additionalProperties": false, + "required": [ + "self" + ] + }, + "Meta": { + "title": "Meta Data", + "type": "object", + "description": "Meta Data relevant to the payload", + "properties": { + "total-pages": { + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Links", + "Meta" + ] + }, + "AccountRequest" : + { + "title": "Account Request POST request", + "description": "Allows setup of an account access request", + "type": "object", + "properties": { + "Data": { + "title": "Data", + "description": "Allows setup of an account access request", + "type": "object", + "properties": { + "Permissions": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "array", + "items": { + "description": "Specifies the Open Banking account request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.", + "type": "string", + "enum": [ + "ReadAccountsBasic", + "ReadAccountsDetail", + "ReadBalances", + "ReadBeneficiariesBasic", + "ReadBeneficiariesDetail", + "ReadDirectDebits", + "ReadProducts", + "ReadStandingOrdersBasic", + "ReadStandingOrdersDetail", + "ReadTransactionsBasic", + "ReadTransactionsCredits", + "ReadTransactionsDebits", + "ReadTransactionsDetail" + ] + }, + "minProperties": 1, + "additionalProperties": false + }, + "ExpirationDateTime": { + "description": "Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.", + "type": "string", + "format": "date-time" + }, + "TransactionFromDateTime": { + "description": "Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.", + "type": "string", + "format": "date-time" + }, + "TransactionToDateTime": { + "description": "Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.", + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "required": [ + "Permissions" + ] + }, + "Risk": { + "title": "Risk", + "type": "object", + "description": "The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false, + "required": [ + "Data", + "Risk" + ] + } + } +} \ No newline at end of file diff --git a/src/devportal/all/modules/custom/openbank_swagger/swaggers/authv2.json.template b/src/devportal/all/modules/custom/openbank_swagger/swaggers/oauthv1-0.json similarity index 63% rename from src/devportal/all/modules/custom/openbank_swagger/swaggers/authv2.json.template rename to src/devportal/all/modules/custom/openbank_swagger/swaggers/oauthv1-0.json index 0c751736..4e6b63f4 100644 --- a/src/devportal/all/modules/custom/openbank_swagger/swaggers/authv2.json.template +++ b/src/devportal/all/modules/custom/openbank_swagger/swaggers/oauthv1-0.json @@ -1,6 +1,6 @@ { "swagger": "2.0", - "host": "{{ host }}", + "host": "testdemorrai-test.apigee.net", "schemes": [ "https" ], @@ -9,7 +9,7 @@ "title": "Generate Access Token", "version": "0.0.1" }, - "basePath": "/apis/v2/oauth", + "basePath": "/apis/v1.0/oauth", "paths": { "/authorize": { "get": { @@ -28,37 +28,46 @@ } }, "security": [], - "parameters": [ - { + "parameters": [{ "in": "query", "name": "client_id", - "description": "Client ID of the registered App.", + "description": "TPPs MUST provide this value and set it to the client id issued to them.", "type": "string", + "default": "zPq1BGV4OlLV7hJR1DsbfTI1t3orbDmD", "required": true }, { "in": "query", "name": "redirect_uri", - "description": "Redirect URI defined with your registered App.", + "description": "Redirect URI defined with your registered App. This MUST be a valid, absolute URL that was registered during Client Registration.", + "type": "string", + "default" : "http://localhost/", + "required": true + }, + { + "in": "query", + "name": "nonce", + "description": "A nonce value", "type": "string", "required": true }, { "in": "query", "name": "response_type", - "description": "The value must be one of 'code' for requesting an authorization code or 'token' for requesting an access token (implicit grant). The redirect url is passed with query params state and code.", + "description": "OAuth 2.0 requires that this parameter is provided. Value is set to ‘code id_token’ or ‘code’. The values for these parameters MUST match those in the Request Object, if present.", "type": "string", "required": true, "enum": [ + "code id_token", + "code", "token", - "code" - ], - "default": "token" + "token id_token" + ] }, { "in": "query", "name": "state", - "description": "Unique id to maintain state between asynchronous requests.", + "description": "TPPs MAY provide a state parameter. An Unique id to maintain state between asynchronous requests at the Client.", "type": "string", "required": true, "default": "af0ifjsldkj" @@ -66,31 +75,19 @@ { "in": "query", "name": "scope", - "description": "Scope of the access token requested.", + "description": "The scopes MUST be a sub-set of the scopes that were registered during Client Registration. At a minimum the scope parameter MUST contain openid. Other valid scopes are: accounts, payments", "type": "string", "required": true, "enum": [ - "accounts", - "payments", + "openid accounts", + "openid payments", "openid" ] }, { "in": "query", - "name": "acr_values", - "description": "Determines the level of security for authentication. A value of 2 will require only Customer Id and Password. A value of 3 will request for OTP.", - "type": "string", - "required": true, - "enum": [ - "2", - "3" - ], - "default": "2" - }, - { - "in": "query", - "name": "request_id", - "description": "Request Id for which Authorization Flow need to be executed", + "name": "request", + "description": "The parameter MUST contain a JWS that is signed by the TPP. The JWS payload MUST consist of a JSON object containing a request object as per OIDC Core 6.1.The request object MUST contain a claims section that includes as a minimum