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

Nova Rails API Documentation

Nova Rails API Explorer

Sandbox

Production

<p class="slate-p" placeholder="Type / for widgets">Nova Rails offers a variety of APIs that enable you to request real-time foreign exchange rates and then book trades and submit payments with those rates. You can also create beneficiaries and accounts against the authorized customers and manage transfers between them. By choosing and combining the components they need, developers can build a custom solution that suits their requirements.</p><h1 class="slate-h1"><strong style="font-size:14px" 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.) on call to Nova.</div></li><li class="slate-li"><div style="position:relative">Nova Rails 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" placeholder="Type / for widgets"></p><h1 class="slate-h1"><strong style="font-size:14px" 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 Nova.</div></li><li class="slate-li"><div style="position:relative">Nova 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" placeholder="Type / for widgets"></p><h1 class="slate-h1"><strong style="font-size:14px" 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" placeholder="Type / for widgets">
<strong style="font-size:14px" class="slate-bold">Accounts </strong><strong class="slate-bold">Mangement API</strong><strong style="font-size:14px" class="slate-bold"> </strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">The Account API of Nova Rails 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" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><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 the 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" placeholder="Type / for widgets">







</p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets"></p>

Nova Rails offers a variety of APIs that 

enable you to request real-time foreign exchange rates and then book trades and submit payments with those rates. You can also create 

 and accounts against the authorized customers and manage transfers between them. 

By choosing and combining the components they need, developers can build a custom solution that suits their requirements.

<p class="slate-p" placeholder="Type / for widgets">The Authorization section of the Nova Rails 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 Nova Rails API.</p><p class="slate-p" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets"><span style="color:#000000;font-size:14px" class="slate-color">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" class="slate-color">
</span>
</p><p class="slate-p" placeholder="Type / for widgets"></p>

The Authorization section of the Nova Rails 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 Nova Rails 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" placeholder="Type / for widgets">The Nova Rails API provides a functional endpoint, Post Token, which is primarily used to generate a unique token. This unique token serves as a key to gain necessary privileges to interact with the system. In essence, it is similar to a digital ID card which, after proper validation, allows for the execution of essential tasks. 
To get the access to the other calls<span style="background-color:white;color:rgb(33, 37, 41)" class="slate-color"><span style="background-color:white;color:rgb(33, 37, 41)" class="slate-backgroundColor">, </span></span>the login user must be authorized and an access token for the respective user must be generated. After the successful authorization, the user can continue making the API Calls. </p><p class="slate-p" placeholder="Type / for widgets">A common use-case for creating tokens is during the process of user authentication. When a user logs in with their credentials, the system can generate a token that represents their user session. This token can then be used for tracking the user session or authorizing subsequent requests from the user.</p><p class="slate-p" placeholder="Type / for widgets">The token creation process is secure and robust. It is designed to ensure that only valid requests succeed in generating a token. Invalid requests receive a status code of 400, and an error message is returned that provides details about the reason for failure. This feedback is particularly useful in identifying the cause of unsuccessful token requests and aids in troubleshooting.</p><p class="slate-p" placeholder="Type / for widgets">The API utilizes parameters for passing essential values including Customer ID, Username and Password in creation process. The API Key is a unique identifier that authenticates a user or service, while the Portal ID represents the specific portal from which the request originates.</p><p class="slate-p" placeholder="Type / for widgets">It&apos;s important to note that tokens are typically temporary and have an expiration period. Hence, it is crucial to handle token expiration and regeneration appropriately in your implementation.</p><p class="slate-p" placeholder="Type / for widgets">In sum, the post token endpoint of the Nova Rails API is a powerful tool that allows for secure and efficient user session management and request authorization. With proper handling, it can greatly simplify your interactions with the system and enhance the security of your application.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The Nova Rails API provides a functional endpoint, Post Token, which is primarily used to generate a unique token. This unique token serves as a key to gain necessary privileges to interact with the system. In essence, it is similar to a digital ID card which, after proper validation, allows for the execution of essential tasks. 
To get the access to the other calls

the login user must be authorized and an access token for the respective user must be generated. After the successful authorization, the user can continue making the API Calls. 

A common use-case for creating tokens is during the process of user authentication. When a user logs in with their credentials, the system can generate a token that represents their user session. This token can then be used for tracking the user session or authorizing subsequent requests from the user.

The token creation process is secure and robust. It is designed to ensure that only valid requests succeed in generating a token. Invalid requests receive a status code of 400, and an error message is returned that provides details about the reason for failure. This feedback is particularly useful in identifying the cause of unsuccessful token requests and aids in troubleshooting.

The API utilizes parameters for passing essential values including Customer ID, Username and Password in creation process. The API Key is a unique identifier that authenticates a user or service, while the Portal ID represents the specific portal from which the request originates.

It's important to note that tokens are typically temporary and have an expiration period. Hence, it is crucial to handle token expiration and regeneration appropriately in your implementation.

In sum, the post token endpoint of the Nova Rails API is a powerful tool that allows for secure and efficient user session management and request authorization. With proper handling, it can greatly simplify your interactions with the system and enhance the security of your application.

The Grant Type can be entered as Password or Refresh Token

grant_type

The Entity Number which serves as the Custimer ID will be entered in this body parameter

CustID

username

password

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

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

Indicates the success or failure of the request.

status

data

This response parameter provides the status of the API request, indicating whether the transaction was successful or not.

This response parameter indicates any error that may have occurred during the request. The value of this parameter will contain the details of the error.

error

<p class="slate-p" placeholder="Type / for widgets">The Rate section of the Nova Rails API is a robust and highly useful functionality designed to retrieve essential rating information for any given product or service within the Nova Rails 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" placeholder="Type / for widgets">This powerful API endpoint is primarily leveraged to fetch the rating&apos;s quantitative score, reviewers’ comments, and other related data elements from the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets"></p>

The Rate section of the Nova Rails API is a robust and highly useful functionality designed to retrieve essential rating information for any given product or service within the Nova Rails 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 Nova Rails 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" placeholder="Type / for widgets">The “Trade” section in the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets"></p>

The “Trade” section in the Nova Rails 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" placeholder="Type / for widgets">The Payment section of the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">In conclusion, the Payment section of the Nova Rails 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>

The Payment section of the Nova Rails 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 the Nova Rails 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" placeholder="Type / for widgets">The Account section of the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">A key feature of this API endpoint is its seamless integration capability. It allows any service or platform using the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets"></p>

The Account section of the Nova Rails 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 Nova Rails 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" placeholder="Type / for widgets">The Beneficiary section of the Nova Rails 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" placeholder="Type / for widgets">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" placeholder="Type / for widgets">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" placeholder="Type / for widgets"></p>

The Beneficiary section of the Nova Rails 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