APIs
Please find below the API details for the to Account Information (AISP) module.
The API will only be useable if the module has been licenced by the client.
| API Name | Method | URL | Temenos Transact Enquiry (ENQ) | Temenos Transact Application | Description | |
|---|---|---|---|---|---|---|
| getCustomerDetails |
GET |
http://<hostname>:<jboss_port>/<iris_war>>/api/holder/v1/v1.0.11/customers/ {customerId} | AUOBPZ.API.CUSTOMER.DETAIL.1.0.0 | CUSTOMER
|
Retrieves basic information on the Australian customer. | |
| getCustomerAccount |
GET |
http://<hostname>:<jboss_port>/<iris_war>/api/holder/v1/v1.0.11/customers /{customerId}/accounts/{accountId} | NOFILE.AUOBPZ.API.ACCOUNT.DETAILS.1.0.0 | Eqnuiry build on multiple applications like
ACCOUNT, AA.ARR.Property Class>, CUSTOMER application etc.
|
Retrieve the details of the customer account such as address, loans, fees, term deposits etc. | |
| getCustomerAccountsBalances | POST | http://<hostname>:<jboss_port>/<iris_war>/api/holder/v1/v1.0.11/customers /{customerId}/accounts | NOFILE.AUOBPZ.API.ACCOUNT.BALANCES.1.0.0 | Enquiry build on multiple applications like ACCOUNT, ECB, LIMIT. |
Retrieve the basic details of customer accounts including balances such as the available balance and current working balance for the specified customer. | |
| getCustomerAccountTransactions | GET | http://<hostname>:<jboss_port>/<iris_war>/api/holder/v1/v1.0.11/customers/ {customerId}/accounts/{accountId}/transactionDetailList | NOFILE.AUOBPZ.API.TRANSACTIONS.1.0.0 | STMT.ENTRY, FT etc. |
Retrieves the transactions details for a specific account of a customer. | |
| getCustomerAccountsDirectDebits | POST | http://<hostname>:<jboss_port>/<iris_war>/>/api/holder/v1/v1.0.11/customers /{customerId}/accounts/directDebits | AUOBPZ.API.ACCOUNT.DIRECTDEBITS.1.0.0 | DD.DDI
|
Retrieve the account direct debit details for a customer. | |
| getScheduledPayments | POST | http://<hostname>:<jboss_port>/<iris_war>/api/holder/v1/v1.0.11/customers/ {customerId}/accounts/scheduledPayments | NOFILE.AUOBPZ.API.SCH.PYMT.1.0.0 | STO, FT (Future Dated transactions alone) | Retrieve the account standing order details for a customer. | |
| getBeneficiary | GET | http://<hostname>:<jboss_port>/<iris_war>/api/holder/v1/v1.0.11/customers/ {customerId}/payees | AUOBPZ.API.PAYEE.DETAILS.1.0.0 | BENEFICIARY
|
Retrieve the customer beneficiary details such as the beneficiary name, beneficiary country, beneficiary bank details etc.. | |
| getCustomerAccounts (Entitlement API) | GET | http://<hostname>:<jboss_port>/<iris_war>/api/customeradmin/v1/v1.0.9/customers /{customerId}/entitlement | NOFILE.AUOBPZ.API.CUSTOMER.ACCOUNT.1.0.0 | Multiple applications like AA.CUSTOMER.ARRANGEMENT, ACCOUNT.CLOSED etc |
Retrieve the account entitlement details for a customer such as whether an account is eligibility to share information, reason for not sharing etc based on the customer’s preference. Only the accounts that were closed up to 24 month ago will be shared to Cuscal. | |
| GetTransactionDetails | GET | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/{accountId}/transactions | NOFILE.AUOBPZ.API.TRANSACTIONS.1.0.0 | Retrieve transactions details. | ||
| GetAccountDetails | GET | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/{accountId | NOFILE.AUOBPZ.API.ACCOUNT.DETAILS.1.0.0 | Retrieve account details. | ||
| GetCustomerDetails | GET | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/customers/{customerId}/consent | AUOBPZ.API.CUSTOMER.DETAIL.1.0.0 | Retrieve customer details. | ||
| GetCustomerAccountList | GET | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/consents | NOFILE.AUOBPZ.API.CUSTOMER.ACCOUNT.1.0.0 | Retrieve customer entitlements. | ||
| PostAccountBalances | POST | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/balances | NOFILE.AUOBPZ.API.ACCOUNT.BALANCES.1.0.0 | Retrieve details of the balances for a specific account. | ||
| PostScheduledPayments | POST | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/standingOrders | AUOBPZ.API.SCH.PYMT.ACCOUNT.1.0.0 | Retrieve information from all the standing orders related to a specific account. | ||
| PostDirectDebits | POST | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/customers/{customerId}/accounts/directdebits | AUOBPZ.API.ACCOUNT.DIRECTDEBITS.1.0.0 | Retrieve information from all the direct debits related to a specific account. | ||
| GetBeneficiary | GET | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/customers/{customerId}/beneficiairies/{beneficiaryId} | AUOBPZ.API.PAYEE.DETAILS.1.0.0 | Retrieve detailed information for all payees of a particular customer. |
Joint Holders
Please find below the API details for the Joint Holders functionality.
| API Name | Method | Description | URL |
|---|---|---|---|
| AUOBPZ.DOMS,AUOBPZ.API.BEN.NONDISCLOSURE.OPTIONS.1.0.0 | PUT | Update the non-disclosure option provided by beneficiary customers | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/openBanking/customers/{customerid}/nonDisclosure |
| NOFILE.AUOBPZ.API.BEN.DISCLOSE.DETAILS.1.0.0 | GET | Retrieve the non-disclosure details of beneficiary customers | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/openBanking/customers/{customerid}/nonDisclosure |
| AUOBPZ.NOMINATIONS,AUOBPZ.API.CUST.NOMINATIONS.1.0.0 | PUT | Create/Update the record to capture the nomination for the secondary customers | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/openBanking/customers/{customerid}/nominations |
| AUOBPZ.NOMINATIONS,AUOBPZ.API.CUST.NOMINATIONS.1.0.0 | GET | Retrieve the nomination details of the secondary customers | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/openBanking/customers/{customerid}/nominations |
| NOFILE.AUOBPZ.API.ACCOUNT.CUSTOMERS.1.0.0 | GET | Retrieve the customer details for the corresponding open banking account | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/openBanking/accounts/{accountId}/customers |
| NOFILE.AUOBPZ.CUST.NOM.STATUS.PROFILES.1.0.0 | GET | Retrieve the related customer profiles for the requested customer | http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/openBanking/customers/{customerId}/relatedProfiles |
Field Name
|
Application/Table name
In this topic