OBIE Account Information APIs (AISP)
The APIs related versions and enquiries cannot be accessed through the Temenos Transact menus.
| API Name | Method | Description |
|---|---|---|
| account-access-consents | POST | Create consent |
| account-access-consents/{ConsentId} | GET | Provide the status of the consent |
| account-access-consents/{ConsentId} | DELETE | Delete a consent or close a consent arrangement before its expiry date |
| accounts/{AccountId} | GET | Provide the account details of a specific account |
| accounts/{AccountId}/balances | GET | Provide the account balance information of a specific account |
| accounts/{AccountId}/transactions | GET | Provides the transaction details of a specific account. |
| accounts/{AccountId}/beneficiaries | GET | Provides information about the beneficiaries related to a specific account |
| accounts/{AccountId}/direct-debits | GET | Provides information on the direct debits related to a specific account |
| accounts/{AccountId}/standing-orders | GET | Provides information on the standing orders related to a specific account |
| accounts/{AccountId}/party | GET | Provides information on the different customer parties related to a specific account |
| accounts/{AccountId}/scheduled-payments | GET | Provides information on the scheduled payments related to a specific account |
| accounts/{AccountId}/statements | GET | Provides the statements related to a specific account |
| accounts/{AccountId}/statements/{StatementId} | GET | Provides the statements related to a specific account and pertaining to a specific Statement Id |
| .customers/{customerId}/consents/{status} | GET | Retrieves customer consent details, which are in different statuses like Awaiting Authorization, Authorized, Expired, Rejected, or Revoked. |
The table below is related to the Account and Transaction APIs.
| API Name | Method | Description | URL |
|---|---|---|---|
|
UKOBPZ.API.OBIE.TXNS.2.0.0 |
GET |
Retrieve list of transactions requested for the open-banking account by the PSU (Payment Service User) |
http://<hostname>:<jboss_port>/<iris_war>/api/v2.0.0/holdings/uk/accounts/transactions/{consentId}/{tppReference} |
|
UKOBPZ.API.OBIE.ACCOUNTBALANCE.2.0.0 |
GET |
Retrieve balances details requested for the open-banking account by the PSU(Payment Service User) |
http://<hostname>:<jboss_port>/<iris_war>/api/v2.0.0/holdings/uk/accounts/balances/{consentId}/{tppReference} |
|
UKOBPZ.API.OBIE.ACCOUNTINFO.2.0.0 |
GET |
Retrieve account details requested for the open-banking accounts by the PSU(Payment Service User). |
http://<hostname>:<jboss_port>/<iris_war>/api/v2.0.0/holdings/uk/accounts/{consentId}/{tppReference} |
|
UKOBPZ.API.OBIE.GET.EXTERNALUSERID.1.0.0 |
GET |
Retrieve the Spotlight user id of the customer linked to an account. |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/uk/accounts/externalUsers/{consentId} |
The table below is related to the Account Access Consent APIs.
| API Name | Method | Description |
|---|---|---|
|
AA.ARRANGEMENT.ACTIVITY,UKPZ.API.OBIE.CONSENT.1.0.0 |
POST | Create consent. |
| AA.ARRANGEMENT.ACTIVITY,UKPZ.API.OBIE.AUCONSENT.1.0.0 | PUT | Delete a consent or close a consent arrangement before its expiry date. |
| PZ.API.OBIE.ACCOUNTCONSENT | GET | Retrieve a list with the consent status. |
The table below is related to the API integration with Infinity.
| API Name | Method | Description | API Endpoint URL |
|---|---|---|---|
| Token Generation API | GET | JWT Token for Saltedge and account permissions check in Spotlight | api/v1.0.0/generateauthtoken/account-access-consent |
The table below is related to the External Consent ID and Consent Deletion API functionality.
| API Name | Method | Description | API Endpoint URL |
|---|---|---|---|
| Consent Creation provider API | POST | Create the AIS consent API. | /v1.1.0/holdings/uk/accounts/consentInitiation |
| Update Consent provider APIs | PUT | Update the consent status and additional details. | /v1.1.0/holdings/uk/accounts/consents/{consentId} |
| /v1.1.0/holdings/uk/accounts/consentApprovals/{consentId} | |||
| /v1.1.0/holdings/uk/accounts/consentInitiations/{consentId} | |||
| /v1.0.0/party/uk/customers/consents/{consentId} | |||
| Get Consent Details Provider API | GET | Retrieve the consent details for given consent Id. | /v1.1.0/party/uk/customers/{customerId}/consents/{status} |
| Consent Creation publisher API | POST | Create the AIS consent API. | /open-banking/aisp/v1.0.0/account-access-consents |
| Get Consent status publisher API | GET | Retrieve the consent status for given consent Id. | /open-banking/aisp/v1.0.0/account-access-consents/{ConsentId} |
In this topic