Enterprise APIs
Following are the list of Business APIs supported by the Account Aggregation Microservice.
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| SaltEdgeIntegrator | createCustomer | /party/profiles/{partyid} | Creates a new customer profile for given customer ID. |
| getAccountswithTransaction | /holdings/profiles/{partyid}/banks/{bankcode}/accountwithtransactions | Get Accounts and transaction for a customer in a bank. | |
| ConnectionManager | getConnectionsForPeriod | /system/notifyExpiryConnections | Stream List of Connections about to expire in a given period. |
| createConnection | /party/profiles/{partyid}/banks/{bankcode}/connections | Create Connection for a customer in a given bank | |
| reauthConnection | /party/profiles/{partyid}/banks/{bankcode}/reauthenticate | Reauthenticate Connection for a customer in a given bank | |
| getConnections | /party/profiles/{partyid}/connections | Get list of connections from provider for Customer. | |
| refreshConnection | /party/profiles/{partyid}/banks/{bankcode}/refreshConnections | Refresh connections for a given party and a bank | |
| removeConnection | /party/profiles/{partyid}/banks/{bankcode}/removeConnections | API is used to delete connection. | |
| getConnectionDirectoryDetails | /party/profiles/{partyid}/connectionDetails | Get Connection Details from DB | |
| OpenBankingDirectory | loadBankDirectory | /system/banks | Get List of banks from provider. |
| getBankDetails | /system/banks/{bankcode}/provider/{providername} | Get Details of bank for bank code and provider. | |
| getBankDetailsForBankId | /system/banks/{bankid} | Get Details of bank for bank id. | |
| getBankDetailsForCountry | /system/countries/{countrycode}/banks | Get Details of banks in a country | |
| createEnableAccess | /system/bank/{bankcode}/access | Enable Admin access. |
To view the complete APIs specification, refer to the Swagger JSON file.
In this topic