Deposit account
| Function | Method and endpoint | Description |
|---|---|---|
| Create a new deposits | POST {baseURL}/deposits | Facilitates the creation of new customer deposit accounts, including customer account validation and the generation of account details. |
| Get deposit account balances | GET {baseURL}/deposits/balances?{accountIds} | Enables you to fetch the balances of one or more deposit accounts by specifying their unique identifiers (account IDs). |
| Get deposit account details | GET {baseURL}/deposits/{accountId} | Enables you to fetch the details of one or more deposit account by specifying their unique identifiers (account IDs). |
| Update deposit account details | PUT {baseURL}/deposits/{accountId} | Enables you to make changes or modifications to the information associated with a particular account, including customer details, account settings, or other relevant information. |
| Close an inactive deposit account | PATCH {baseURL}/deposits/{Id}/close | Enables you to identify inactive deposit accounts based on predefined criteria, such as no withdrawals, deposits, or transactions within a specified time frame. Once an inactive account is identified, the connector initiates the closure process. |
Deposit account transaction
| Function | Method and endpoint | Description |
|---|---|---|
| Get transaction details of multiple deposit accounts | GET {baseURL}/deposits/transactions?{accountIds} | Enables you to access and retrieve transaction information for several accounts simultaneously. |
| Retrieve deposit account transactions based on filters | GET {baseURL}/deposits/{accountId}/transactions | Enables you to fetch the balances of one or more accounts by specifying their unique identifiers (account IDs). |
| Get account transaction by transaction ID | GET {baseURL}/deposits/transactions/{transactionId} | Enables you to fetch the transaction details by specifying their unique identifiers (transaction IDs). |
Loan
| Function | Method and endpoint | Description |
|---|---|---|
| Create a loan account | POST {baseURL}/loans | Initiates the creation of a loan account, including setting up a record for a customer to manage a loan, with details such as the loan amount, interest rate, repayment terms, and other relevant information. |
| Get loan accounts details | GET {baseURL}/loans | Enables you to retrieve details related to loan accounts such as loan balances, payment schedules, interest rates, and other relevant data associated with individual loan accounts. |
| Get loan account by loan ID | GET {baseURL}/loans/{loanId} | Enables you to fetch the details of one or more accounts by specifying their unique identifiers (loan IDs). |
| Get loan amortization schedule details | GET {baseURL}/loans/{loanId}/amortization-schedule | Enables you to retrieve specific details related to the amortization schedule of a loan. In financial terms, an amortization schedule outlines the repayment of a loan over time, specifying each installment’s breakdown into principal and interest. |
| Get loan amortization payment details | GET {baseURL}/loans/{loanId}/amortization-schedule/{amortizationPaymentId} | Enables users to retrieve specific details related to loan amortization payments, including information about each scheduled payment, such as the principal amount, interest, total payment, remaining balance, and the payment date. |
Loan transaction
| Function | Method and endpoint | Description |
|---|---|---|
| Get loan transaction details by loan ID | GET {/baseURL}/loans/transactions?{accountIds} | Enables you to retrieve detailed information about a specific loan account by specifying its unique identifier (Loan ID). |
| Retrieve loan transactions based on filters | GET {baseURL}/loans/{loanId}/transactions | Enables you to retrieve specific loan transactions based on specified filters, including criteria such as date ranges, loan types, customer identifiers, or other relevant parameters. |
| Retrieve details of loan transaction by transaction ID | GET {baseURL}/loans/transactions/{transactionId} | Fetch information about a particular loan transaction based on its unique identifier, the transaction ID. |
Payment
| Function | Method and endpoint | Description |
|---|---|---|
| Initiate a payment | POST {baseURL}/payments | Enables the initiation of payment transactions, including functionalities such as fund transfers, bill payments, or any other financial transactions supported by the API. |
Party
| Function | Method and endpoint | Description |
|---|---|---|
| Create party | POST {baseURL}/parties | Enables you to create a new party record. A “party” typically refers to an individual, organization, or entity that is a participant in a business process. Parties can represent customers, clients, suppliers, or any other entities relevant to the system. |
| Update party by party ID | PUT {baseURL}/parties/{partyId} | Enables you to update party record by specifying their unique identifiers (party IDs). |
| Patch party by party ID | PATCH {baseURL}/parties/{partyId} | Enables you to patch party record by specifying their unique identifiers (party IDs). |
| Get party details | GET {baseURL}/parties/{partyId} | Enables you to fetch the details of one or more party records by specifying their unique identifiers (party IDs). |
| Retrieve account balances that belongs to the party details specified | GET {baseURL}/parties/{partyId}/balances | Enables you to fetch account balance information related to a specified party, providing insights into the financial status associated with that particular entity. |
| Retrieve accounts that belongs to the party details specified | GET {baseURL}/parties/{partyId}/accounts | Enables you to retrieve information about accounts associated with a specific party (customer or entity). |