Payment Planner API

Precisely produce loan amortization schedules with the Payment Planner API.

About the API:  

The Payment Planner API is designed to empower users to create applications that offer complete loan payment schedules. Whether you are building a financial planning tool, banking interface, or loan management system, this API offers essential functionality for accurate calculation and visualization of loan repayment schedules.

A notable feature of the Payment Planner API is its ability to generate complex loan amortization schedules based on user-defined parameters. Users can enter vital loan details such as principal amount, interest rate, loan term and payment frequency to accurately calculate the payment schedule. This functionality helps users understand the breakdown of their loan payments over time, covering the distribution of principal and interest components.

In terms of integration, the Payment Planner API presents seamless integration paths for users. With its easy-to-use endpoint and comprehensive documentation, users can integrate the API into their applications effortlessly and with minimal hassle.

Basically, the Payment Planner API provides users with a robust set of tools to develop applications with complete loan payment functionality. With its precise calculations, adaptable customization options, and easy integration capabilities, the API enables users to create innovative financial applications tailored to the diverse needs of users within the realm of lending and financial services.

 

What this API receives and what your API provides (input/output)?

It will receive parameters and provide you with a JSON.

 

What are the most common uses cases of this API?

  1. Financial planning applications: Integrate the API to enable users to calculate loan repayment terms and plan their finances effectively.

    Banking platforms: Incorporate the API to provide loan repayment capabilities so customers understand their repayment obligations.

    Loan management systems: Use the API to generate comprehensive loan schedules and manage repayment activities efficiently.

    Mortgage calculators: Integrate the API to provide users with information on their mortgage amortization schedules and total interest payments.

    Personal finance tools: Incorporate the API to enable users to assess the impact of loan repayments on their overall financial health.

Are there any limitations to your plans?

Besides the number of API calls, there is no other limitation.

API Documentation

Endpoints


To use this endpoint you must indicate the annual interest, start date, installments and principal amount in the parameters.



                                                                            
GET https://zylalabs.com/api/3820/payment+planner+api/4437/calculate+payments
                                                                            
                                                                        

Calculate Payments - Endpoint Features

Object Description
annualInterestRate [Required] Indicates anual interest rate
startDate [Required] Indicates start date
installmentCount [Required] Indicates payment installments
principalAmount [Required] Indicates an amount
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            [{"date":"2023-06-15","interest":41.666666666666664,"principal":814.4081512180071,"payment":856.0748178846737,"balance":9185.591848781993},{"date":"2023-07-15","interest":38.27329936992497,"principal":817.8015185147488,"payment":856.0748178846737,"balance":8367.790330267244},{"date":"2023-08-15","interest":34.86579304278018,"principal":821.2090248418936,"payment":856.0748178846737,"balance":7546.58130542535},{"date":"2023-09-15","interest":31.444088772605625,"principal":824.6307291120681,"payment":856.0748178846737,"balance":6721.950576313282},{"date":"2023-10-15","interest":28.00812740130534,"principal":828.0666904833683,"payment":856.0748178846737,"balance":5893.883885829913},{"date":"2023-11-15","interest":24.557849524291306,"principal":831.5169683603824,"payment":856.0748178846737,"balance":5062.366917469531},{"date":"2023-12-15","interest":21.093195489456377,"principal":834.9816223952173,"payment":856.0748178846737,"balance":4227.385295074313},{"date":"2024-01-15","interest":17.61410539614297,"principal":838.4607124885308,"payment":856.0748178846737,"balance":3388.9245825857824},{"date":"2024-02-15","interest":14.120519094107427,"principal":841.9542987905663,"payment":856.0748178846737,"balance":2546.9702837952163},{"date":"2024-03-15","interest":10.612376182480068,"principal":845.4624417021937,"payment":856.0748178846737,"balance":1701.5078420930226},{"date":"2024-04-15","interest":7.0896160087209275,"principal":848.9852018759528,"payment":856.0748178846737,"balance":852.5226402170698},{"date":"2024-05-15","interest":3.552177667571124,"principal":852.5226402171027,"payment":856.0748178846737,"balance":-3.285549610154703e-11}]
                                                                                                                                                                                                                    
                                                                                                    

Calculate Payments - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/3820/payment+planner+api/4437/calculate+payments?annualInterestRate=5&startDate=2023-06-15&installmentCount=12&principalAmount=10000' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Payment Planner API REST API, simply include your bearer token in the Authorization header.
Headers
Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

πŸš€ Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Specialized Customer Support
  • Real-Time API Monitoring

Customer favorite features

  • βœ”οΈŽ Only Pay for Successful Requests
  • βœ”οΈŽ Free 7-Day Trial
  • βœ”οΈŽ Multi-Language Support
  • βœ”οΈŽ One API Key, All APIs.
  • βœ”οΈŽ Intuitive Dashboard
  • βœ”οΈŽ Comprehensive Error Handling
  • βœ”οΈŽ Developer-Friendly Docs
  • βœ”οΈŽ Postman Integration
  • βœ”οΈŽ Secure HTTPS Connections
  • βœ”οΈŽ Reliable Uptime

Users must indicate the annual interest rate, start date, installment count and principal amount in order to use this API.

The Payment Planner API designed to help users build applications that offer comprehensive loan amortization schedules.

There are different plans to suit all tastes, including a free trial for a small number of requests, but your rate is limited to avoid abuse of the service.

Zyla provides a wide range of integration methods for almost all programming languages. You can use these codes to integrate with your project as you need.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, refer to the β€˜X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

The β€˜X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
657ms

Category:


Related APIs