Datasoft Global Technologies

Getting Started

Overview

Authorization

Login 

Quote

Fetch Quote

Trade

Submit Trade

Click 'Try it Out' to update the Authentication Token and then click 'Execute'

Get Purpose of Payments

Get Trades

Payment

Submit Payments with Trade

Submit Payments without Trade

Click 'Try it Out' enter the Authentication Token and then click 'Execute'

Get Payments 

Account

Get Accounts

Get Account Details

Submit Account Transfer

Beneficiary

Get BeneficiaryMetaDataRules

Click 'Try it Out' to update the Input Parameters and then click 'Execute'

Create Beneficiary

Click 'Try it Out' to update the Input Parameters  and then click 'Execute'

Update Beneficiary

Get Beneficiary

Delete Beneficiary 

Get Beneficiaries

Datasoft Rest API V2 Documentation

APA API Documentation

APA API Explorer

Sandbox

Production

<div style="text-align:center"><img src="https://d24lr4zqs1tgqh.cloudfront.net/b9b3e280-fd6e-4d8e-b029-f9573884547b.png" style="
              width:709px;
	            height:213px;
	            aspect-ratio:709 / 213"
         /></div><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:340px;">Title</div><div style="width:511px;">Description</div><div style="width:426px;">Title</div></div><colgroup ><col style="width:340px"><col style="width:511px"><col style="width:426px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/authorization/login" target=""><strong class="slate-bold">User Authorization</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/quote/fetch-quote" target=""><strong class="slate-bold">Fetching a Quote</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/trade/submit-trade" target=""><strong class="slate-bold">Submitting a Trade</strong></a></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >An access token will be generated for the user upon successful authorization.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Fetch a detailed, tradeable rate quote to convert funds from one currency to another.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Book a trade using the received quote. To submit the trade with payment details, either the Beneficiary ID or Account ID must be provided.</p></td></div></tr></tbody></table></div><p class="slate-p " >  </p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:340px;">Title</div><div style="width:516px;">Description</div><div style="width:422px;">Title</div><div style="width:400px;">Description</div></div><colgroup ><col style="width:340px"><col style="width:516px"><col style="width:422px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/trade/get-trades" target=""><strong class="slate-bold">Fetching Trades</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/trade/get-purpose-of-payments" target=""><strong class="slate-bold">Fetching Purpose of Payments</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/payment/submit-payments-with-trade" target=""><strong class="slate-bold">Making Payments Against a Trade</strong></a></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Retrieve the list of trades booked by the authorized customer.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Get the list of valid purpose of payments to be used in trades. </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Add single or multiple Payments to your existing Trade.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:340px;">Title</div><div style="width:515px;">Description</div><div style="width:417px;">Title</div><div style="width:400px;">Description</div></div><colgroup ><col style="width:340px"><col style="width:515px"><col style="width:417px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/payment/submit-payments-without-trade" target=""><strong class="slate-bold">Making Payments without Trade</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/payment/get-payments" target=""><strong class="slate-bold">Fetching Payments</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/account" target=""><strong class="slate-bold">Fetching a List of Accounts</strong></a></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Use a single call to fetch quote, submit trade and post the payments. </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Get a list of payments made by the authorized customer. </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Get the list of accounts of the authorized customer. </p></td></div></tr></tbody></table></div><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:347px;">Title</div><div style="width:508px;">Description</div><div style="width:408px;">Title</div><div style="width:400px;">Description</div></div><colgroup ><col style="width:347px"><col style="width:508px"><col style="width:408px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/account/get-account-details" target=""><strong class="slate-bold">Fetching Account Details</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/account/submit-account-transfer" target=""><strong class="slate-bold">Making Transfer Between Accounts</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/beneficiary/create-beneficiary" target=""><strong class="slate-bold">Creating a Beneficiary</strong></a></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Retrieve comprehensive information associated with a specified customer account.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Create and manage internal transfer between two accounts of the authorized customer. 

</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Create a new beneficiary for the authorized customer to be used in payments and fundings.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:347px;">Title</div><div style="width:512px;">Description</div><div style="width:407px;">Title</div><div style="width:400px;">Description</div></div><colgroup ><col style="width:347px"><col style="width:512px"><col style="width:407px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/beneficiary/update-beneficiary" target=""><strong class="slate-bold">Updating a Beneficiary</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/beneficiary/get-beneficiaries" target=""><strong class="slate-bold">Fetching a List of Beneficiaries</strong></a></h3></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><h3 class="slate-h3 " ><a href="https://developer.atlanticpartnersasia.com/beneficiary/delete-beneficiary" target=""><strong class="slate-bold">Deleting a Beneficiary</strong></a></h3></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Update the details of an existing beneficiary record.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Retrieve the list of beneficiaries associated with the authorized customer.</p><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Delete a beneficiary that is no longer required.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Title

Description

<p class="slate-p " >The APA API provides a range of endpoints that allow you to request real-time foreign exchange rates, book trades, and submit payments using those rates. You can also create beneficiaries and accounts for authorized customers and manage transfers between them. By selecting and combining the necessary components, developers can build custom solutions tailored to their specific requirements.</p><h1 class="slate-h1 " ><strong class="slate-bold">Quote Request API</strong></h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Provide preliminary payment details (currency pair, amounts, value date, etc.) </div></li><li class="slate-li " ><div style="position:relative">APA API responds back with a real-time FX rate based on the provided details and a quote identifier</div></li><li class="slate-li " ><div style="position:relative">Rates can be informational or executable dependent on client’s request</div></li><li class="slate-li " ><div style="position:relative">Executable rates are valid for 60 Seconds (This is configurable. You need to contact support to change the validity).</div></li></ul><p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Trade Request API</strong></h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The RFQ API can be used to confirm you want to make a payment based off of the rate requested over the Quote Request API.</div></li><li class="slate-li " ><div style="position:relative">Provide the quote identifier and payment details on the call to APA API.</div></li><li class="slate-li " ><div style="position:relative">APA API responds back with a confirmation that a trade was booked to facilitate a future payment, and an id to identify the trade.</div></li><li class="slate-li " ><div style="position:relative">Provide trade id upon payment submission to settle the trade.</div></li></ul><p class="slate-p " ></p><h1 class="slate-h1 " ><strong class="slate-bold">Payment Submissions API</strong></h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Create payments against the existing trade.</div></li><li class="slate-li " ><div style="position:relative">Fetch Quote, Submit Trade and Post Payments in a single call if there is no existing trade.</div></li><li class="slate-li " ><div style="position:relative">Create Single and Multiple payments. Full payments and Partial payments both also supported.</div></li><li class="slate-li " ><div style="position:relative">Retrieve the records from the payment inventory. This can be particularly useful for businesses aiming to review their transactions, auditors conducting financial checks, or developers building custom reporting tools.</div></li></ul><p class="slate-p " >
<strong class="slate-bold">Accounts </strong><strong class="slate-bold">Mangement API</strong><strong class="slate-bold"> </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The Account API provides endpoints that allow you to interact with bank accounts and customer&apos;s internal accounts. </div></li><li class="slate-li " ><div style="position:relative">This API has been carefully designed with a focus on security and privacy. All data is retrieved over a secure connection, and sensitive account. information is always encrypted. </div></li><li class="slate-li " ><div style="position:relative">Allows you to create and manage transfers between different accounts. This function is crucial for applications that require immediate or scheduled fund transfers, such as banking apps, accounting software, e-commerce platforms, or any financial systems.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Beneficiary Management API</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Create a standardized wire template to process outgoing and incoming funds. </div></li><li class="slate-li " ><div style="position:relative">Support the management of wire transfers within your application.</div></li><li class="slate-li " ><div style="position:relative">Extensive functionality for tailoring wire templates to suit your unique needs.</div></li><li class="slate-li " ><div style="position:relative">Retrieve essentials details of the beneficiaries present in the system.</div></li></ul><p class="slate-p " >







</p><p class="slate-p " >
</p><p class="slate-p " ></p><p class="slate-p " ></p>

The APA API provides a range of endpoints that allow you to request real-time foreign exchange rates, book trades, and submit payments using those rates. You can also create beneficiaries and accounts for authorized customers and manage transfers between them. By selecting and combining the necessary components, developers can build custom solutions tailored to their specific requirements.

<p class="slate-p " >The Authorization section of the APA API documentation refers to authentication, a critical component that secures access to your application&apos;s resources. This section, specifically, details the methods and processes necessary to establish secure, authenticated connections between your application and the APA API.</p><p class="slate-p " >Authentication not only safeguards your application&apos;s resources from unauthorized access but also provides control over the extent of access. This facilitates different levels of user permissions and access rights, allowing for a tailored application experience for each user.</p><p class="slate-p " >This part of the API documentation is especially crucial for developers and system administrators who need to understand how to implement secure connections within their application&apos;s architecture. However, it&apos;s also valuable for non-technical roles who require insight into the security protocols that protect the data and resources within their software solutions.</p><p class="slate-p " ><span style="color:#000000">One of the primary use-cases of this API is during a user sign-in attempt where it is crucial to validate the user&apos;s credentials. Upon successful validation, the system generates a unique token that is used for authorization throughout the session. This token must be included in each subsequent request to ensure that the user remains authenticated. This authorization helps prevent unauthorized access to sensitive information and capabilities, therefore defending the system from malicious activities.</span><span style="color:#000000">
</span>
</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Authorization section of the APA API documentation refers to authentication, a critical component that secures access to your application's resources. This section, specifically, details the methods and processes necessary to establish secure, authenticated connections between your application and the APA API.

Authentication not only safeguards your application's resources from unauthorized access but also provides control over the extent of access. This facilitates different levels of user permissions and access rights, allowing for a tailored application experience for each user.

This part of the API documentation is especially crucial for developers and system administrators who need to understand how to implement secure connections within their application's architecture. However, it's also valuable for non-technical roles who require insight into the security protocols that protect the data and resources within their software solutions.

One of the primary use-cases of this API is during a user sign-in attempt where it is crucial to validate the user's credentials. Upon successful validation, the system generates a unique token that is used for authorization throughout the session. This token must be included in each subsequent request to ensure that the user remains authenticated. This authorization helps prevent unauthorized access to sensitive information and capabilities, therefore defending the system from malicious activities.

<p class="slate-p " >The Quote section of the APA API is a robust and highly useful functionality designed to retrieve essential rating information for any given product or service within the APA API system. It plays a critical role in facilitating and enhancing user interaction with products or services, as it provides a comprehensive and detailed overview of the rating data.</p><p class="slate-p " >This powerful API endpoint is primarily leveraged to fetch the rating&apos;s quantitative score, reviewers’ comments, and other related data elements from the APA API database directly. This can be particularly useful in scenarios such as gathering user feedback for analysis, displaying ratings on the user interface, or refining search results based on rating statistics.</p><p class="slate-p " >The Rate API endpoint is also designed to handle multiple use cases. For instance, it can be used by developers to extract all ratings for a specific product or service, to track rating trends over time, or to evaluate overall customer satisfaction levels. Non-technical roles might employ the API to gather market research data, conduct competitive analysis, or understand customer preferences better.</p><p class="slate-p " >One of the standout features of the Rate section is its flexible nature. It can efficiently handle large volumes of data and can be tailored to fetch ratings data according to specific parameters such as date ranges, product categories, or geographical locations for a more targeted analysis.</p><p class="slate-p " >Finally, please note that while the Rate API is generally straightforward to use, it is crucial to ensure the API requests are correctly formatted for successful data retrieval. We recommend thoroughly reading through the provided examples in our documentation to understand how to effectively use this API endpoint in your application.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Quote section of the APA API is a robust and highly useful functionality designed to retrieve essential rating information for any given product or service within the APA API system. It plays a critical role in facilitating and enhancing user interaction with products or services, as it provides a comprehensive and detailed overview of the rating data.

This powerful API endpoint is primarily leveraged to fetch the rating's quantitative score, reviewers’ comments, and other related data elements from the APA API database directly. This can be particularly useful in scenarios such as gathering user feedback for analysis, displaying ratings on the user interface, or refining search results based on rating statistics.

The Rate API endpoint is also designed to handle multiple use cases. For instance, it can be used by developers to extract all ratings for a specific product or service, to track rating trends over time, or to evaluate overall customer satisfaction levels. Non-technical roles might employ the API to gather market research data, conduct competitive analysis, or understand customer preferences better.

One of the standout features of the Rate section is its flexible nature. It can efficiently handle large volumes of data and can be tailored to fetch ratings data according to specific parameters such as date ranges, product categories, or geographical locations for a more targeted analysis.

Finally, please note that while the Rate API is generally straightforward to use, it is crucial to ensure the API requests are correctly formatted for successful data retrieval. We recommend thoroughly reading through the provided examples in our documentation to understand how to effectively use this API endpoint in your application.

<p class="slate-p " >The “Trade” section in the APA API documentation provides the essential functionality for interacting with the deals in your application&apos;s database. It allows you to retrieve information about a specific deal or a list of deals, based on certain criteria that you specify. This is particularly useful for situations where you need to display deal information on your application, assess the performance of specific deals, or collate data for reporting purposes.</p><p class="slate-p " >The API is designed with flexibility in mind, so you can easily integrate it into your existing application structure and business processes. It facilitates operations such as fetching a single deal through its unique identifier or retrieving a list of deals that meet certain conditions. This can be especially beneficial in scenarios like analyzing deal trends or generating deal-based reports and analytics.</p><p class="slate-p " >In addition to the basic retrieval functions, the &quot;Trade&quot; API provides advanced features to enhance your interactions with deal data. It handles sorting and filtering, allowing you to easily customize your deal queries based on your specific requirements.</p><p class="slate-p " >While this API is powerful and versatile, its usage is straightforward. It is designed not only for technical developers but also for non-technical roles who might need to access deal data for business analysis or decision-making purposes.</p><p class="slate-p " >In terms of security, the API adheres to industry best practices to ensure the privacy and integrity of the data accessed and transferred. Note that to use this API, you would require appropriate authorization credentials.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The “Trade” section in the APA API documentation provides the essential functionality for interacting with the deals in your application's database. It allows you to retrieve information about a specific deal or a list of deals, based on certain criteria that you specify. This is particularly useful for situations where you need to display deal information on your application, assess the performance of specific deals, or collate data for reporting purposes.

The API is designed with flexibility in mind, so you can easily integrate it into your existing application structure and business processes. It facilitates operations such as fetching a single deal through its unique identifier or retrieving a list of deals that meet certain conditions. This can be especially beneficial in scenarios like analyzing deal trends or generating deal-based reports and analytics.

In addition to the basic retrieval functions, the "Trade" API provides advanced features to enhance your interactions with deal data. It handles sorting and filtering, allowing you to easily customize your deal queries based on your specific requirements.

While this API is powerful and versatile, its usage is straightforward. It is designed not only for technical developers but also for non-technical roles who might need to access deal data for business analysis or decision-making purposes.

In terms of security, the API adheres to industry best practices to ensure the privacy and integrity of the data accessed and transferred. Note that to use this API, you would require appropriate authorization credentials.

<p class="slate-p " >The Payment section of the APA API is designed to facilitate all your transactional needs. With this API, you will be able to handle a wide array of payment-related functions, be it processing payments, scheduling recurring charges, or refunding transactions, in a seamless manner, thereby enhancing your application&apos;s financial operations.</p><p class="slate-p " >One of the key functionalities of this API is its ability to process payments. It allows your application to accept, process, and manage payments from various credit and debit cards, digital wallets, bank transfers, and more. This makes it a versatile tool for businesses of all sizes and types.</p><p class="slate-p " >A unique feature of this API is the ability to schedule recurring charges. Whether you&apos;re managing subscriptions, memberships, or any service with a recurring fee, the Payment API automatically handles the billing cycle with your specified parameters, thus relieving you from manual tracking and billing.</p><p class="slate-p " >Another important function facilitated by this API is the refunding of transactions. If there&apos;s a need to issue a refund, the API can manage this process, ensuring a smooth transaction back to the customer&apos;s account.</p><p class="slate-p " >Furthermore, the Payment API is designed with a focus on security. All transactions are encrypted using industry-standard protocols to protect sensitive data. Its inbuilt fraud detection and prevention mechanisms make it a reliable choice for handling your payment operations.</p><p class="slate-p " >The API is also designed with simplicity in mind. It can be integrated into your current systems with minimal effort. Its robust functionality doesn’t compromise its ease of use, making it an excellent choice for both technical and non-technical users.</p><p class="slate-p " >In conclusion, the Payment section of theAPA API is a comprehensive solution for all your payment processing needs. Its versatility, automation features, security protocols, and easy integration make it an essential tool for modern-day businesses.</p><p class="slate-p " ></p>

The Payment section of the APA API is designed to facilitate all your transactional needs. With this API, you will be able to handle a wide array of payment-related functions, be it processing payments, scheduling recurring charges, or refunding transactions, in a seamless manner, thereby enhancing your application's financial operations.

One of the key functionalities of this API is its ability to process payments. It allows your application to accept, process, and manage payments from various credit and debit cards, digital wallets, bank transfers, and more. This makes it a versatile tool for businesses of all sizes and types.

A unique feature of this API is the ability to schedule recurring charges. Whether you're managing subscriptions, memberships, or any service with a recurring fee, the Payment API automatically handles the billing cycle with your specified parameters, thus relieving you from manual tracking and billing.

Another important function facilitated by this API is the refunding of transactions. If there's a need to issue a refund, the API can manage this process, ensuring a smooth transaction back to the customer's account.

Furthermore, the Payment API is designed with a focus on security. All transactions are encrypted using industry-standard protocols to protect sensitive data. Its inbuilt fraud detection and prevention mechanisms make it a reliable choice for handling your payment operations.

The API is also designed with simplicity in mind. It can be integrated into your current systems with minimal effort. Its robust functionality doesn’t compromise its ease of use, making it an excellent choice for both technical and non-technical users.

In conclusion, the Payment section of theAPA API is a comprehensive solution for all your payment processing needs. Its versatility, automation features, security protocols, and easy integration make it an essential tool for modern-day businesses.

<p class="slate-p " >The Account section of theAPA API primarily focuses on providing access to a user&apos;s account details. It allows for the retrieval of essential account information, which includes but is not limited to the user&apos;s personal details, account status, and the date the account was created.</p><p class="slate-p " >This part of the API is crucial across a variety of use-cases. For example, it is often utilized in support settings where it&apos;s necessary to pull up a user&apos;s account details quickly. It&apos;s also used in user management scenarios, where a user&apos;s account details might need to be reviewed or confirmed.</p><p class="slate-p " >A key feature of this API endpoint is its seamless integration capability. It allows any service or platform using the APA API to easily fetch the user&apos;s account data in a structured format, ready to be integrated into any workflow or system.</p><p class="slate-p " >Finally, a unique consideration for the Account API section is its focus on data security. It ensures that only authorized individuals and systems can access user account details, thereby safeguarding user data. Strict authentication and authorization protocols are in place to ensure that access is limited to those with the appropriate permissions. This ensures that the API aligns with best practices in user privacy and data protection.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Account section of theAPA API primarily focuses on providing access to a user's account details. It allows for the retrieval of essential account information, which includes but is not limited to the user's personal details, account status, and the date the account was created.

This part of the API is crucial across a variety of use-cases. For example, it is often utilized in support settings where it's necessary to pull up a user's account details quickly. It's also used in user management scenarios, where a user's account details might need to be reviewed or confirmed.

A key feature of this API endpoint is its seamless integration capability. It allows any service or platform using the APA API to easily fetch the user's account data in a structured format, ready to be integrated into any workflow or system.

Finally, a unique consideration for the Account API section is its focus on data security. It ensures that only authorized individuals and systems can access user account details, thereby safeguarding user data. Strict authentication and authorization protocols are in place to ensure that access is limited to those with the appropriate permissions. This ensures that the API aligns with best practices in user privacy and data protection.

<p class="slate-p " >The APA API Get Accounts endpoint fetches the list of the accounts of the authorized customer. It is designed to aid in the management of accounts, offering a straightforward method for fetching all necessary data related to accounts in a single request.</p><p class="slate-p " >The primary use case for this endpoint is to gather detailed account data for resource management, reporting, or for integrating into other systems. It provides detailed information about accounts including their current status, error messages if any, and specific details about any errors that are encountered.</p><p class="slate-p " >This endpoint offers the ability to sort the returned data according to your preference. This can be especially useful when dealing with a large number of accounts, making it easier to navigate and manage the retrieved data.</p><p class="slate-p " >In summary, the Get Accounts endpoint is a robust tool for fetching, managing and integrating account data. Whether your goal is data extraction, system integration, or troubleshooting, this endpoint provides the flexibility and specificity you need.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

The APA API Get Accounts endpoint fetches the list of the accounts of the authorized customer. It is designed to aid in the management of accounts, offering a straightforward method for fetching all necessary data related to accounts in a single request.

The primary use case for this endpoint is to gather detailed account data for resource management, reporting, or for integrating into other systems. It provides detailed information about accounts including their current status, error messages if any, and specific details about any errors that are encountered.

This endpoint offers the ability to sort the returned data according to your preference. This can be especially useful when dealing with a large number of accounts, making it easier to navigate and manage the retrieved data.

In summary, the Get Accounts endpoint is a robust tool for fetching, managing and integrating account data. Whether your goal is data extraction, system integration, or troubleshooting, this endpoint provides the flexibility and specificity you need.

Requires the keyword 'Bearer' followed by a generated access token for secure requests.

A header parameter that specifies the media type of the sent request body.

Content-Type

A header parameter specifying the media type that is acceptable for the response

Accept

This header parameter is used to input the uniquely generated API key in order to authenticate and authorize the user for the API request.

api_key

Enter the available operators with input parameters to filter the output:  Comparison Operators: eq (Equal to), ne (Not Equal To), gt (Greater Than), ge (Greater than or Equal), lt (Less Then or Equal), notin (Not in), In, Like  Logical Operators: AND, OR  Grouping Operators: ()

filter

Enter the sort clause (asc or desc) with input parameters to sort the output

sort

Indicates the success or failure of the request.

status

Contains the response data when the request is successfully processed.

data

error

<p class="slate-p " >The APA API provides a specific endpoint, Get Account Details, designed to retrieve the given account&apos;s details. This endpoint can be used by both developers and non-technical individuals involved in the management.</p><p class="slate-p " >Through this API endpoint, users can access a comprehensive array of information associated with a given account. The data includes but is not limited to account ID, account creation date, account status, and more. This information could be essential for tasks such as account troubleshooting, auditing, and data analysis.</p><p class="slate-p " >In addition to simply retrieving account data, the APA API offers robust filtering and sorting capabilities. Users can query specific data ranges, enabling them to focus on a particular period of interest, for instance, from a certain &apos;from_date&apos; to a &apos;to_date&apos;. Moreover, data can be filtered using a wide range of comparison and logical operators. This flexibility provides users the ability to extract precise information tailored to their needs. For instance, one might want to retrieve details of accounts created within a certain period or those with a specific status.</p><p class="slate-p " >With these features and functionalities, the Get Account Details endpoint provides a powerful tool for users to interact with the APA API database, offering them detailed insights into account-related information, streamlining their operations, and ultimately, enhancing their experience.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

The APA API provides a specific endpoint, Get Account Details, designed to retrieve the given account's details. This endpoint can be used by both developers and non-technical individuals involved in the management.

Through this API endpoint, users can access a comprehensive array of information associated with a given account. The data includes but is not limited to account ID, account creation date, account status, and more. This information could be essential for tasks such as account troubleshooting, auditing, and data analysis.

In addition to simply retrieving account data, the APA API offers robust filtering and sorting capabilities. Users can query specific data ranges, enabling them to focus on a particular period of interest, for instance, from a certain 'from_date' to a 'to_date'. Moreover, data can be filtered using a wide range of comparison and logical operators. This flexibility provides users the ability to extract precise information tailored to their needs. For instance, one might want to retrieve details of accounts created within a certain period or those with a specific status.

With these features and functionalities, the Get Account Details endpoint provides a powerful tool for users to interact with the APA API database, offering them detailed insights into account-related information, streamlining their operations, and ultimately, enhancing their experience.

A header parameter specifying the media type that is acceptable for the response.

Input the starting date (in YYYY-MM-DD format) for the time range of account details required

from_date

Input the ending date (in YYYY-MM-DD format) for the time range of account details required

to_date

Input the Id corresponding to the entity account you are seeking details for

ent_act_id

<p class="slate-p " >The APA API &quot;Post Account Transfer&quot; endpoint allows you to create and manage transfers between different accounts. This function is crucial for applications that require immediate or scheduled fund transfers, such as banking apps, accounting software, e-commerce platforms, or any financial systems.</p><p class="slate-p " >When you make a request to this endpoint, you can specify the source and destination accounts, the transfer amount, and the currency. This allows for flexibility in managing transactions, whether it&apos;s for local or international transfers. Besides, you also have the option to set a specific date for the transfer (value date), enabling you to schedule future transactions effortlessly.</p><p class="slate-p " >Moreover, you can add internal remarks to the transfers for your reference. This could be helpful for tracking purposes and for maintaining a detailed transaction history. For auditing and tracking changes, there are also custom audit fields which record who created or updated the transfer and when these actions took place.</p><p class="slate-p " >The flexibility, security, and ease of integration provided by the &quot;Post Account Transfer&quot; endpoint make it a powerful tool for developers working on applications involving monetary transactions. Whether it&apos;s a simple local transaction or a complex international fund transfer, this API endpoint has the features to accommodate your needs.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

The APA API "Post Account Transfer" endpoint allows you to create and manage transfers between different accounts. This function is crucial for applications that require immediate or scheduled fund transfers, such as banking apps, accounting software, e-commerce platforms, or any financial systems.

When you make a request to this endpoint, you can specify the source and destination accounts, the transfer amount, and the currency. This allows for flexibility in managing transactions, whether it's for local or international transfers. Besides, you also have the option to set a specific date for the transfer (value date), enabling you to schedule future transactions effortlessly.

Moreover, you can add internal remarks to the transfers for your reference. This could be helpful for tracking purposes and for maintaining a detailed transaction history. For auditing and tracking changes, there are also custom audit fields which record who created or updated the transfer and when these actions took place.

The flexibility, security, and ease of integration provided by the "Post Account Transfer" endpoint make it a powerful tool for developers working on applications involving monetary transactions. Whether it's a simple local transaction or a complex international fund transfer, this API endpoint has the features to accommodate your needs.

The unique identifier or reference number associated with the specific transfer.

transfer

A customizable field for your audit purposes, such as tracking or logging transfer data.

custom_audit_field

<p class="slate-p " >The Beneficiary section of the APA API is a crucial resource designed to interact with the beneficiary data within your application. A &apos;beneficiary,&apos; in this context, typically refers to an individual or entity that is eligible to receive benefits or profits through a particular transaction. Common use-cases would include financial transactions like transfers, payments, or any other financial operation where a beneficiary is involved.</p><p class="slate-p " >This part of the API allows you to seamlessly fetch, manage, and update beneficiary information in your system. Through leveraging these endpoints, developers can conveniently handle beneficiary data to ensure up-to-date and accurate record-keeping, opening an avenue for cross-application synchronization and data integrity.</p><p class="slate-p " >The Beneficiary section is not just limited to the retrieval of information but also extends to the modification of beneficiary details. This feature is particularly helpful when you need to reflect changes in a beneficiary&apos;s status or details in real-time, such as a change in their bank details, address, or contact information.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Beneficiary section of the APA API is a crucial resource designed to interact with the beneficiary data within your application. A 'beneficiary,' in this context, typically refers to an individual or entity that is eligible to receive benefits or profits through a particular transaction. Common use-cases would include financial transactions like transfers, payments, or any other financial operation where a beneficiary is involved.

This part of the API allows you to seamlessly fetch, manage, and update beneficiary information in your system. Through leveraging these endpoints, developers can conveniently handle beneficiary data to ensure up-to-date and accurate record-keeping, opening an avenue for cross-application synchronization and data integrity.

The Beneficiary section is not just limited to the retrieval of information but also extends to the modification of beneficiary details. This feature is particularly helpful when you need to reflect changes in a beneficiary's status or details in real-time, such as a change in their bank details, address, or contact information.

Sections