Regionalized Solutions
Updated On 02 December 2024 |
Min(s) read
APIs
Please find below the API details for the OBIE Account Information APIs module.
The APIs related versions and enquiries cannot be accessed through the Temenos Transact menus. The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| getConsentDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customer/consents/{consentId} | Retrieve the consent details of all authorised or revoked/rejected/expired consents of the customer such as name of the third party provider, status of the consent(ACTIVE,AUTHORISED, INACTIVE,OTHERS), accountId, permissions etc. |
| withdrawAccountAccessConsent | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customer/consents/{consentId} | Revoke the account access consent with details such as customer, role, product etc. |
| getCustomerTppReference | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/{customerId}/tppReferences/{tppReference} | Retrieves customer and related tppReference details for the open banking accounts. |
| getBeneficiaries | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/beneficieries/{consentId}/{tppReference} | Retrieves beneficiary details of the customer for the given open banking account like customer reference. |
| getCustomers | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/accounts/{consentId}/{tppReference} | Retrieve customer details of the given open banking account like Name. |
| getExternalUserId | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/externalUsers/{consentId} | Retrieve the external user id of the customer linked to an account. |
| getOpenBankingAccount | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/openBanking/{accountId} | Retrieves details of Openbanking Accounts pertaining to the customer such as customer reference, account with bank, IBAN, address etc. |
| getUnapprovedAccountConsentDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/unapprovedConsents/{consentId} | Retrieves the details of the unapproved account consent such as consentId, status, permissions etc. |
| getAccountConsentDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/consents/{consentId} | Retrieves the details of the account consent of the open banking account such as status, permissions, block details,etc. |
| updateAccountConsentStatus | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/consents/{consentId} | Update the status of the account consent for the open banking account such as awaiting authorization, revoked, expired. |
| createAccountConsent | POST | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/consentInitiation | Inititate the new account access consent with details such as Customer, Role, Product etc. |
| initiateAccountConsent | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/consentInitiations/{consentId} | Update the status of the account consent for the open banking account to unapproved. |
| approveAccountConsents | PUT | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/consentApprovals/{consentId} | Approve the account consent for the open banking account. |
| getBalances | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/balances/{consentId}/{tppReference} | Retrieve customer balances requested for the open-banking account by the PSU(Payment Service User). |
| getAccounts | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/{consentId}/{tppReference} | Retrieve account details requested for the open-banking accounts by the PSU(Payment Service User). |
| getTransactions | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/transactions/{consentId}/{tppReference} | Retrieve list of transactions requested for the open-banking account by the PSU(Payment Service User). |
| getDirectDebits | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/directDebits/{consentId}/{tppReference} | Retrieve direct debit details of the given open banking account like status code. |
| getStatements | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/holdings/uk/accounts/statements/{consentId}/{tppReference} | Retrieves statement details of given open banking account like statementId. |
| getConsentDetails | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/party/uk/customers/{customerId}/consents/{status} | Retrieve the consent details of all authorised or revoked/rejected/expired consents of the customer such as name of the third party provider. |
| getScheduledPayments | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/paymentOrders/paymentSchedules/{consentId}/{tppReference} | Retrieves future dated payment details of given open banking account like paymentId. |
| getStandingOrders | GET | http://<hostname>:<jboss_port>/ukmb-provider-iris/api/vx.x.x/order/uk/standingOrders/{consentId}/{tppReference} | Retrieves standing order details of given open banking account like Id. |
The list of Publisher APIs offered as part of this module is provided below.
| UK Open Banking AIS Endpoint *) | Method | URL (UKOBPZ_Publisher_Container) | Description |
|---|---|---|---|
| AccountAccess | |||
| account-access-consents | POST | /api/open-banking/aisp/v1.0.0/account-access-consents | Create consent on the basis of an initial request. |
| account-access-consents/{ConsentId} | DELETE | /api/open-banking/aisp/v1.0.0/account-access-consents/{ConsentId} | Deletion of the consent where the consent needs to be withdrawn based on the request from TPP. |
| account-access-consents/{ConsentId} | GET | /api/open-banking/aisp/v1.0.0/account-access-consents/{ConsentId} | Return the consent status based on the request from TPP. |
| Accounts | |||
| accounts | GET | /api/open-banking/aisp/v1.0.0/accounts | Return the account details for the all the accounts added to the consent. |
| accounts/{AccountId} | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId} | Return the account details for a specific account available as part of the consent. |
| Balances | |||
| balances | GET | /api/open-banking/aisp/v1.0.0/balances | Return the balance details for all the accounts added to the consent. |
| accounts/{AccountId}/balances | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/balances | Return the balance details for the specific account available as part of the consent. |
| Beneficiaries | |||
| beneficiaries | GET | /api/open-banking/aisp/v1.0.0/beneficiaries | Return the beneficiary details for all the accounts added to the consent. |
| accounts/{AccountId}/beneficiaries | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/beneficiaries | Return the beneficiary details for the specific account available as part of the consent. |
| DirectDebits | |||
| direct-debits | GET | /api/open-banking/aisp/v1.0.0/direct-debits | Return the direct debit details for all the accounts added to the consent. |
| accounts/{AccountId}/direct-debits | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/direct-debits | Return the direct debit details for the specific account available as part of the consent. |
| Partys | |||
| party | GET | /api/open-banking/aisp/v1.0.0/party | Return the party details for all the accounts added to the consent. |
| accounts/{AccountId}/party | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/party | Return the party details for the specific account available as part of the consent. |
| ScheduledPayments | |||
| scheduled-payments | GET | /api/open-banking/aisp/v1.0.0/scheduled-payments | Return the scheduled payment details for all the accounts added to the consent. |
| accounts/{AccountId}/scheduled-payments | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/scheduled-payments | Return the scheduled payment details for the specific account available as part of the consent. |
| StandingOrders | |||
| standing-orders | GET | /api/open-banking/aisp/v1.0.0/standing-orders | Return the standing order details for all the accounts added to the consent. |
| accounts/{AccountId}/standing-orders | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/standing-orders | Return the standing order details for the specific account available as part of the consent. |
| Statements | |||
| statements | GET | /api/open-banking/aisp/v1.0.0/statements | Return the statement details for all the accounts added to the consent. |
| accounts/{AccountId}/statements | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/statements | Return the statement details for the specific account available as part of the consent. |
| Transactions | |||
| transactions | GET | /api/open-banking/aisp/v1.0.0/transactions | Return the transaction details for all the accounts added to the consent. |
| accounts/{AccountId}/transactions | GET | /api/open-banking/aisp/v1.0.0/accounts/{AccountId}/transactions | Return the transaction details for the specific account available as part of the consent. |
*) AIS Endpoints are documented in the OBIEv3.1.0 2022-11-04.json swagger file.
| Consent Access Dashboard Endpoint | Method | URL (ukmb-provider-iris) | Description |
|---|---|---|---|
| party/uk/customer/consents/{consentId} | GET | /api/v1.0.0/party/uk/customer/consents/{consentId} | Return the details of the consent being created based on the consentId provided. |
| party/uk/customers/consents/{consentId} | PUT | /api/v1.0.0/party/uk/customers/consents/{consentId} | API to revoke the consent being created. (i.e) Status will be updated as revokedByPSU. |
*) Dashboard APIs are documented in the party-uk-customer-service-v1.0.0-swagger.json swagger file.
In this topic