The GET section of the Banking Core Services API allows you to retrieve information from the API Gateway. This section provides functionality for fetching data from the API endpoint. Whether you're a developer or a non-technical user, this section will guide you in integrating the API and retrieving the specific information you need. The GET method is commonly used for retrieving data, and it ensures that your requests are efficient and secure. By following the instructions in this section, you'll be able to access the necessary data and incorporate it into your own applications or systems. Additionally, the GET section provides details on any special features or considerations that may be relevant for retrieving data from the API Gateway. By understanding these considerations, you can make the most out of the API integration and ensure a smooth data retrieval process.

The POST /accounts API endpoint allows you to create a new account within the Banking Core Services. This API provides a straightforward way to add new accounts to the system.

By making a POST request to this endpoint, you can provide the necessary details for the account creation. The API will process the request and respond with the unique identifier of the newly created account.

This functionality is useful for scenarios where you need to programmatically create accounts within the Banking Core Services. Whether you are a developer building a custom application or a non-technical user integrating with our services, this API makes it easy to add new accounts to the system.

Additionally, there are no special considerations or limitations when using this API endpoint. Simply provide the required information and expect a successful response containing the account identifier.

Update Account Status:

The PATCH /accounts endpoint allows you to update the status of an account in the Banking Core Services project. This endpoint provides a way to modify the status of an account, such as activating or deactivating it.

Use this API endpoint when you need to change the status of a specific account in the system. By making a PATCH request to this endpoint, you can update the status of the account as needed.

Updating the account status can have various use-cases. For example, you may need to activate a previously deactivated account when a user requests to resume their banking services. Alternatively, you may want to deactivate an account temporarily if there are suspicious activities detected.

Please note that the PATCH /accounts endpoint only updates the account status and does not allow for any other modifications to the account details. If you require additional changes, please refer to the relevant API endpoints for account management.

To update the account status, include the necessary parameters in the request body. Refer to the provided examples and parameters section for more details on the required fields and their corresponding values.

Keep in mind that updating the account status may trigger additional actions or processes within the Banking Core Services project. It's important to consider any dependencies or implications of changing the account status before making the request.

We strive to make the API integration process as straightforward as possible. If you have any questions or encounter any issues while using the PATCH /accounts endpoint, please refer to the troubleshooting section or reach out to our support team for assistance.

Read account by account number - This API endpoint allows you to retrieve detailed information about a specific account using its account number. By providing the account number as a parameter, you can access various details such as the account holder's name, balance, transaction history, and associated account information. This functionality is particularly useful for banking applications that need to fetch specific account data for both internal and customer-facing purposes. The API ensures that only authenticated users with the necessary permissions can access this endpoint, guaranteeing the security and privacy of sensitive account information.

This API endpoint allows you to retrieve transactions from a specific account by providing its unique identifier. By making a GET request to this endpoint, you can access transaction information associated with the provided account ID. This functionality is useful for applications that need to fetch transaction data for a particular account, such as banking or financial management systems. It provides a straightforward way to integrate transaction retrieval into your software or application, enabling you to easily access and process relevant transaction details.

The PUT /accounts/closure API endpoint allows you to close a banking account. This functionality is useful when you need to deactivate an account that is no longer in use or has been flagged for closure. By invoking this API, you can initiate the closure process for the specified account.

Closing an account involves several steps, including verifying the account information, updating the account status, and performing any necessary account balance adjustments. Once the closure process is initiated, it cannot be reversed, so please exercise caution when using this API.

Please note that the closure process may take some time to complete, depending on various factors such as account balance, pending transactions, and account history. You may periodically check the account status using the GET /accounts/<account_id> API endpoint to monitor the progress of the closure process.

It is important to ensure that you have the necessary permissions and authentication credentials to perform this action. Additionally, please make sure to adhere to any regulatory requirements or compliance guidelines applicable to the closure of banking accounts.

If you encounter any issues or have questions related to the account closure process, please refer to the support documentation or reach out to our technical support team for assistance.

This API endpoint allows you to retrieve the account details for a specific user ID. By making a GET request to this endpoint with the appropriate user ID parameter, you can access information such as the user's account balance, transaction history, and linked payment methods.

This API section is particularly useful for applications that require access to user-specific account information, such as banking or financial management services. It provides a straightforward way to fetch account details for a specific user and incorporate that information into your application.

When using this API endpoint, please ensure that you provide the correct user ID as the parameter in the request URL. The response will include the relevant account details in a structured format, allowing you to easily parse and utilize the information in your application.

Keep in mind that this API section is read-only and does not support any modifications to the account details. If you need to perform updates or changes to the account information, please refer to the appropriate API sections provided for those specific operations.

In addition to the core account details, the response may also include additional metadata or contextual information related to the user account. This can help provide a more comprehensive understanding of the account and its associated attributes.

By leveraging this API section, you can seamlessly integrate account details retrieval into your application, enabling your users to access and manage their banking information with ease.