Nova Rails API Explorer

Nova Rails API

## Sections
• [Getting Started](https://developer.novarails.com/getting-started.md): User Authorization Fetching the Quote Submitting the Trade An access token for the user will be generated in case of the successful authorization. Fetch the detailed, tradeable rate quote to convert money from one currency to another. Book a trade against the received quote. The Beneficiary ID or the Account ID needs to be given to submit the trade with payments. Fetching the Trades Fetching the Purpose of Payments Making Payments Against the Trade Get the list of trades booked by the authorized customer. Get the list of valid purpose of payments to be used in trades. Add single or multiple Payments to your existing Trade. Making Payments without Trade Fetching the Payments Fetching the List of Accounts Use a single call to fetch quote, submit trade and post the payments. Get the list of payments made by the authorized customer. Get the list of accounts of the authorized customer. Fetching the Account Details Making Transfer Between the Accounts Creating the Beneficiary Get the comprehensive information associated with a given customer account. Create and manage internal transfer between two accounts of the authorized customer. Create a new beneficiary for the authorized customer to be used in payments and fundings. Updating the Beneficiary Fetching the List of Beneficiaries Deleting the Beneficiary Update the details of the existing beneficiary record. Get the list of beneficiaries associated to the authorized customer. Delete the beneficiary which is no longer required.
• [Overview](https://developer.novarails.com/overview.md): 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. Quote Request API Provide preliminary payment details (currency pair, amounts, value date, etc.) on call to Nova. Nova Rails responds back with a real-time FX rate based on the provided details and a quote identifier. Rates can be informational or executable dependent on client’s request. Executable rates are valid for 60 Seconds (This is configurable. You need to contact support to change the validity). Trade Request API 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. Provide the quote identifier and payment details on the call to Nova. Nova responds back with a confirmation that a trade was booked to facilitate a future payment, and an id to identify the trade. Provide trade id upon payment submission to settle the trade. Payment Submissions API Create payments against the existing trade. Fetch Quote, Submit Trade and Post Payments in a single call if there is no existing trade. Create Single and Multiple payments. Full payments and Partial payments both also supported. 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. Accounts Mangement API The Account API of Nova Rails provides endpoints that allow you to interact with bank accounts and customer's internal accounts. 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. 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. Beneficiary Management API Create a standardized wire template to process the outgoing and incoming funds. Support the management of wire transfers within your application. Extensive functionality for tailoring wire templates to suit your unique needs. Retrieve essentials details of the beneficiaries present in the system.
• [Authorization](https://developer.novarails.com/authorization.md): 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.
  • [Login](https://developer.novarails.com/authorization/login.md): 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.
• [Quote](https://developer.novarails.com/quote.md): 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.
  • [Fetch Quote](https://developer.novarails.com/quote/fetch-quote.md): The Get Quote endpoint of Nova Rails API enables users to access real-time exchange rate information. Acting as a financial data source, this section significantly aids in making informed decisions in matters related to currency conversion and international transactions. This endpoint accepts the date of the rate (value_date) you're interested in, which is useful for businesses that need to analyze historical rates or predict future trends. The 'amount' parameter is used to specify the amount for which you want to get the rate. With 'fixed_side', you can choose if you want to fix the buy or sell side of the trade, which provides flexibility for different trading strategies. The endpoint has a robust filtering mechanism. You can apply comparison operators such as equal to (eq), greater than (gt), and so on to the fields in output. Moreover, logical operators (AND, OR) enable you to create complex filters. These features allow you to get the precise data you need, without having to sift through extraneous information. By offering a versatile set of features and delivering comprehensive output, the Rate Get Quote endpoint is a powerful resource for any business dealing with multiple currencies.
• [Trade](https://developer.novarails.com/trade.md): 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.
  • [Submit Trade](https://developer.novarails.com/trade/submit-trade.md): The "Post Trade" function of Nova Rail's API is designed to facilitate the process of creating a new trade deal within the system. It is accessed through the 'post /V2/EU/Trade' endpoint and is primarily utilized in situations where a user, either a client or a bank representative, wishes to initiate a new trade transaction. To carry out this operation, the endpoint makes use of several body parameters which provide crucial information such as quote details, beneficiary and account details, transaction details including currency and amount, and a custom audit trail for tracking changes. The system uses this information to process and record the trade deal in a secure and efficient manner. It's important to note that in order to successfully create a trade deal, the user must have the appropriate permissions and provide accurate and complete information. This ensures that each trade deal is correctly recorded and can be processed without errors. A - Submit Trade without Requisitions B - Submit Trade with Requisitions Only the quote_id from the output of the Fetch Quote is required. Option 1 - The Wire template ID can be given as the beneficiary_id . It is given in case of Wire transfers. Option 2 - The Entity Account ID can be given as the account_id. It is used in case of the internal transfer only. The Bank Accounts are Not Allowed. Either the beneficiary_id or the account_id can be given to create the payments. The receipts will be created as per the configurations defined in the Standing Instructions.
  • [Get Purpose of Payments](https://developer.novarails.com/trade/get-purpose-of-payments.md): The Nova Rails API provides a method to retrieve a list of purpose of payment records. It's a powerful feature that enables developers and financial teams to easily track, filter, and manage payment records based on their assigned purpose. It's particularly beneficial for users who need to handle multiple transactions, as it facilitates efficient sorting and filtering of records. With the Nova Rails API, you have the flexibility and control to manage your payment records with precision, efficiency, and ease. Whether you're looking to streamline your financial processes or develop a robust payment system, this API provides the tools needed to succeed.
  • [Get Trades](https://developer.novarails.com/trade/get-trades.md): The Nova Rails API provides a dedicated endpoint, 'get /V2/EU/Trades,' that enables users to retrieve a list of trades created by the authorized user. A 'trade' in this context refers to an exchange of currencies and this API endpoint is your portal to this crucial data from the system's database. This functionality is particularly useful in a variety of scenarios. For example, portfolio managers may use it to track trading activities for their clients. Financial analysts might leverage it to study patterns and trends in trade behavior. Even non-technical users, such as department heads and business analysts, might utilize this API endpoint to generate reports or insights into business operations. One key feature of this endpoint is its flexibility. It comes with a wide range of query parameters, allowing users to customize the output to fit their needs. For instance, users can filter the output using comparison and logical operators to focus on specific trades matching certain criteria. It's also possible to sort the trades in ascending or descending order based on different input parameters. In summary, the ‘get /V2/EU/Trades’ endpoint is a powerful tool within the Nova Rails API. Its purpose is to allow users to retrieve, filter, and analyze trade data in a secure and customizable manner, catering to a wide array of business and analytical needs.
• [Payment](https://developer.novarails.com/payment.md): 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.
  • [Submit Payments with Trade](https://developer.novarails.com/payment/submit-payments-with-trade.md): To Submit Payments with Trade, the endpoint Post PaymentWithTradeID will be used. This endpoint enables developers to create new payments associated with a specific trade ID. It's a powerful feature beneficial to businesses and individuals who need to handle multiple transactions related to a single trade, providing a vital level of organization and tracking. This endpoint is particularly suited for financial or trading platforms that need to manage complex payment structures. For instance, a trading platform could use this endpoint to manage different payments associated with a particular trade, ensuring all transactions are efficiently and accurately recorded. This could include payments to various third parties involved in the trade, or payments from multiple sources contributing to a single trade. In summary, the PaymentWithTradeID endpoint is a versatile and powerful tool for managing financial transactions associated with a specific trade, promoting efficient, transparent, and user-friendly transaction processing. If the payments aren’t created while submitting the Trade, you can use this call to create the payments. This method also allows Partial and Multiple payments. We have the following two options to create the payments: Creating Wire Transfer Creating Internal Transfer The Wire template ID can be given as the beneficiary_id in case of wire transfers. The Entity Account ID can be given as the account_id. It is used in case of the internal transfer only.
  • [Submit Payments without Trade](https://developer.novarails.com/payment/submit-payments-without-trade.md): The Nova Rails API's PaymentWithoutTradeId endpoint offers a unique way to create a payment without the necessity of a Trade ID. You can use this call to create the payments without giving the trade ID. This single call will fetch the quote, submit the trade and post the payments. The user will not have the option to accept or reject the quote, the rate offered by the Nova Rails API will be auto accepted. This endpoint accepts various details about the payment, including the funding currency, the value date, and specific elements related to the payment and funding. Payment-related parameters include the currency, amount, beneficiary_id, remarks, and the purpose of the payment. Funding-related parameters require the beneficiary_id, account_id, and act_type. The combination of these features makes the PaymentWithoutTradeId endpoint an effective tool for scenarios such as pre-authorized payments, where the transaction ID might not be available at the time of creating the payment.
  • [Get Payments](https://developer.novarails.com/payment/get-payments.md): The Get Payments endpoint of Nova Rails API provides a comprehensive method to fetch all payment records against the given trade. This feature is particularly beneficial for businesses seeking an organized and swift retrieval of all their financial transactions, which is a crucial element for maintaining accurate accounting records, performing audits, and conducting financial analyses. This method retrieves all the payment records from the Nova Rails database against the particular entity and presents them in a structured and readable format. The records returned include essential information such as transaction amount, date, method, and any associated transaction or customer IDs. One of the distinct features of this API endpoint is its capability to filter and sort the payment records based on specific parameters. Using a set of comparison, logical, and grouping operators, users can create intricate filters to access payment information that matches their exact requirements. This can be especially useful when dealing with a large volume of transactions and when needing to isolate specific records for detailed examination. The sorting feature allows for arranging the output in ascending or descending order for more manageable navigation. In addition, the method also provides information about the paging of the output. It includes details like the page number, size, and from-to details, which can be particularly useful when dealing with large sets of data. Overall, leveraging the Nova Rails API to fetch the payment records provides a powerful and flexible mechanism for businesses to manage and analyze their financial transactions effectively.
• [Account](https://developer.novarails.com/account.md): 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.
  • [Get Accounts](https://developer.novarails.com/account/get-accounts.md): The Nova Rails API's 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.
  • [Get Account Details](https://developer.novarails.com/account/get-account-details.md): The Nova Rails 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 Nova Rails 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 Nova Rails database, offering them detailed insights into account-related information, streamlining their operations, and ultimately, enhancing their experience.
  • [Submit Account Transfer](https://developer.novarails.com/account/submit-account-transfer.md): The Nova Rails API's "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.
• [Beneficiary](https://developer.novarails.com/beneficiary.md): 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.
  • [Get BeneficiaryMetaDataRules](https://developer.novarails.com/beneficiary/get-beneficiarymetadatarules.md): This API call allows you to retrieve wire meta data rules associated with the specified Entity ID, Country (Beneficiary, Beneficiary Bank and By Order Of) , and Currency. The response will include the status of the request, any error codes or messages, as well as the wire meta data rules if the request is successful. Please note that you need to include the appropriate headers, such as the authorization token and API key, in order to make a successful request. Additionally, make sure to provide the necessary body parameters, including the entity ID, country details, and currency details. This API section is useful for retrieving the specific wire meta data rules required for integrating wire identifiers into your project.
  • [Create Beneficiary](https://developer.novarails.com/beneficiary/create-beneficiary.md): The Nova Rails API's Post Beneficiary endpoint provides an endpoint that enables the creation of a wire template record, a key function that supports the management of wire transfers within your application. This functionality proves beneficial in cases where you need to set up a standardized template for outgoing or incoming wires to a particular beneficiary, thereby improving efficiency and reducing the possibility of errors in repeated transactions. The API takes in a wealth of information about the beneficiary, including personal details, contact information, bank details, and instructions for the wire transaction. It also accommodates data on intermediary banks and any further credit requirements, offering a great depth of flexibility and adaptability to suit various use-cases. Notably, this endpoint also has built-in compliance status features, allowing you to incorporate regulatory checks into the process of creating a beneficiary template. Special fields can be enabled for individual beneficiaries, catering to specific requirements of different jurisdictions or banking institutions. The endpoint also supports the specification of various additional fields, allowing you to customize the template according to your unique business requirements. For instance, you can specify whether the beneficiary is a resident, the type of the wire template (outgoing or incoming), and whether the beneficiary is an individual or an organization. By using this endpoint to create a beneficiary's template record, you can streamline your wire transfer processes, ensure compliance, and improve the overall efficiency of your financial operations.
    • [Create Beneficiary (USD)](https://developer.novarails.com/beneficiary/create-beneficiary/create-beneficiary-usd.md): Try this call to create a sample beneficiary for USD.
    • [Create Beneficiary (CAD)](https://developer.novarails.com/beneficiary/create-beneficiary/create-beneficiary-cad.md): Try this call to create a sample beneficiary for CAD.
    • [Create Beneficiary (GBP)](https://developer.novarails.com/beneficiary/create-beneficiary/create-beneficiary-gbp.md): Try this call to create a sample beneficiary for GBP.
    • [Create Beneficiary (CNY)](https://developer.novarails.com/beneficiary/create-beneficiary/create-beneficiary-cny.md): Try this call to create a sample beneficiary for China.
  • [Update Beneficiary](https://developer.novarails.com/beneficiary/update-beneficiary.md): The Nova Rails API's endpoint PUT Beneficiary provides a method for updating existing wire template records. This method offers extensive functionality for tailoring wire templates to suit your unique needs. Specifically, it allows you to tweak a variety of beneficiary details, including names, address information, contact details, and account specifics. You can specify whether the beneficiary is a third party or a resident. Furthermore, changes can be made to the payment details, such as currency type, account codes, and specific instructions for the beneficiary. This method is not just confined to adjusting beneficiary details; it also supports alterations to the associated bank details. For instance, you can modify the name, address, and routing codes of the beneficiary's bank, as well as of any intermediary banks involved in the wire transfer. In addition, the API provides the capability to update further credit details and by-order-of details, giving you full control over all aspects of your wire templates. This flexibility allows you to adapt wire templates to a wide range of contexts and use cases. The method also integrates compliance checks and allows you to adjust the compliance status of the wire template. To further enhance your control, it provides an option to specify the purpose of payment, whether the beneficiary is an individual client, and the desired execution date. In summary, whether you need to adjust basic beneficiary details or delve into more complex changes involving banks and compliance status, this Nova Rails API method makes updating wire templates a seamless and straightforward process.
  • [Get Beneficiary](https://developer.novarails.com/beneficiary/get-beneficiary.md): The Nova Rails API's Get Beneficiary endpoint is designed to retrieve the details of the given beneficiary. Utilized predominantly within payment processing, transfer routing, and data verification systems, this endpoint provides essential details about beneficiaries, helping users get the relevant information about the assigned beneficiaries. Essentially, the Get Beneficiary endpoint is not just a simple retrieval function - it is a powerful tool that enables you to extract, filter, sort, and manage beneficiary information with ease and precision.
  • [Delete Beneficiary](https://developer.novarails.com/beneficiary/delete-beneficiary.md): The Nova Rails API's Delete Beneficiary endpoint provides a method to delete a specific wire template record. This function is primarily used when there is a need to eliminate previously set wire template records, such as in cases of data clean-up or information updates. The given wire template record is identified and deleted based on the beneficiary_id that is inputted into the system. This makes this method extremely precise in its operations, ensuring that only the specified record gets deleted from the database. In summary, this method within the Nova Rails API allows for direct and secure deletion of wire template records, offering a robust response system for both successful operations and error situations. Its features are designed to streamline the process of data maintenance and ensure optimal application performance.
  • [Get Beneficiaries](https://developer.novarails.com/beneficiary/get-beneficiaries.md): The Get Beneficiaries endpoint in the Nova Rails API is designed to facilitate the retrieval of beneficiary information. A 'beneficiary' in this context, refers to an individual or entity that is eligible to receive distributions from a trust, will, or life insurance policy. This endpoint is primarily used whenever there's a need to access these details in your application. The endpoint supports a wide array of filters to help you specify the exact data you want to retrieve. For example, you can use comparison operators like 'Equal to', 'Not Equal to', 'Greater Than', 'Less Than', and others to set conditions on the data you're fetching. Logical operators such as 'AND', and 'OR' can be used to combine these conditions, allowing you to create sophisticated queries. You can also group your conditions using parentheses. Moreover, the endpoint supports sorting the output results in ascending or descending order. This functionality can be beneficial when dealing with a large number of beneficiaries and helps in organizing the data more effectively. This endpoint has been designed keeping in mind both ease of use and flexibility. The diverse filtering and sorting options make it extremely versatile and adaptable to various use-cases. However, please remember to provide the necessary authorization in the header section for a successful API request.