{"info":{"_postman_id":"d2a163f6-70dc-4588-a01b-a6b517efd3d7","name":"Apollo Finvest: Loan Update API (PL/ML/EDI)","description":"

Overview

\n

Loan Update API is used to update the loan that is created on Apollo's Loan Management System: Sonic. This API allows the fintech partners to allow edit a few fields/attributes of the loans that created already up to a certain stage of the loan process.

\n

Authentication/Authorisation:

\n
\n

x-API-key and access token should be sent in request headers for authenticating the request. Apollo will provide x-API-key. Access tokens should be generated by the partners. Therefore please generate a new access token using the below code piece. The token will expire in 5 minutes.

\n

Please refer to the API collection to understand more...

\n
import requests\nimport base64\nurl = \"will be shared by apollo\"\nclient_id = \"will be shared by apollo\"\nclient_secret_id = \"will be shared by apollo\"\nbasic = base64.b64encode((client_id+':'+client_secret_id).encode())\npayload = 'grant_type=client_credentials&scope='\nheaders = {\n    'Authorization': 'Basic '+basic.decode(),\n    'Content-Type': 'application/x-www-form-urlencoded',\n}\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.json())\n\n
\n
\n

Required Query Parameters:

\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamsValuesDescription
loan_idThe Loan Id was created by the partner at the time of loan creation. Eg: \"Tesst001\"Required. String. This is the unique value created and maintained by the partner at the time of pushing the loan to Apollo's system
\n

Required Request Body:

\n
\n

We allow the partners only a few fields/attributes of the loan and that should be available in the request body. Also, these updates/changes can be made only within 3 days of the loan creation. If there are no updates and required documents (loan agreement, sanction letter, KFS) are not received within 3 days the loan will be moved rejected stage. Below mentioned are the fields/attributes that can be updated.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
RequestValuesDescription
partner_tagUnique Partner Tag provided by Apollo. Eg: \"ABC\"Required. String. This is a unique value assigned by Apollo to its partners to identify and allow them to create and store loans in Apollo's system
loan_typePL/ML/CL/CL_2/EDIRequired. String. This is the type of loan mentioned at the time of loan creation for that particular loan. PL- Personal Loan, ML- Micro Loan, CL- Consumer Loan, EDI - Daily Installments
\n

Allowed Changes and Loan Stages

\n

The below fields can be updated by the partner using the Loan Update API. The update can be done only to the loans in Document Check Pending Stage. This action won't be allowed to perform if the loan is in any other stage.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
RequestValuesDescription
disbursement_dateThe new disbursement date needs to be updated. DD/MM/YYYY, Eg: \"12/03/2023\"Required. String. The disbursement date is when the actual transaction will take place.
first_emi_date/first_installment_dateThis will be the new First EMI/Installment Date that needs to be updated and based on the disbursement date. DD/MM/YYYY, Eg: \"12/03/2023\"Required. String. The First EMI/Installment Date is when the first repayment date is due. If its a PL/ML loan type then There should be a minimum of 25-30 days difference between the Disbursement Date and the First EMI Date and the Loan Tenure should match this new tenure.
loan_tenure_in_daysLoan tenure in the number of days. Eg: \"90\"Optional. String. This would be applicable only when Loan Type is ML
\n

Request body for PL loan type:

\n
{\n    \"partner_tag\": \"apollo assigned partner tag\",\n    \"loan_type\": \"loan type\",\n    \"loan_information\": {\n        \"disbursement_date\": \"Updated disbursement date\",\n        \"first_emi_date\": \"first_emi_date will be same as pushed earlier\"\n    }\n}\n\n
\n

Request body for ML loan type:

\n

If there is no change in loan tenure in days:

\n
{\n    \"partner_tag\": \"apollo assigned partner tag\",\n    \"loan_type\": \"loan type\",\n    \"loan_information\": {\n        \"disbursement_date\": \"Updated disbursement date\",\n        \"first_emi_date\": \"first_emi_date will be revised as per DOD + no. of days of tenure\",\n        \"loan_tenure_in_days\": \"Loan tenure in days\"\n    }}\n\n
\n

If there is a change in loan tenure in days:

\n
{\n    \"partner_tag\": \"apollo assigned partner tag\",\n    \"loan_type\": \"loan type\",\n    \"loan_information\": {\n        \"disbursement_date\": \"Updated disbursement date\",\n        \"first_emi_date\": \"first_emi_date will be revised as per DOD + no. of days of tenure\",\n        \"loan_tenure_in_days\": \"Loan tenure in days\",\n        \"partner_computed_emi_amount\": \"Updated Emi amount\",\n        \"partner_computed_interest_amount\": \"Updated Interest amount\"    \n     }\n}\n\n
\n

Request body for EDI loan type:

\n
{\n    \"partner_tag\": \"apollo assigned partner tag\",\n    \"loan_type\": \"loan type\",\n    \"loan_information\": {\n        \"disbursement_date\": \"Updated disbursement date\",\n        \"first_installment_date\": \"first_installment_date will be same as pushed earlier\"\n    }\n}\n\n
\n

Sample Response:

\n

If a loan was successfully updated in Apollo's system, the following response will be provided;

\n
{ \n  \"message\": \"loan updated successfully\" \n} \n\n
\n

If the loan is not updated in Apollo's system;

\n
{ \n  \"message\": \"loan cannot be updated after xyz date and time\"\n}\n\n
\n

If the newly updated first_emi_date doesn't match the loan tenure;

\n
\"message\": \"first_emi_date & loan_tenure_in_days do not match\"\n\n
\n

*If the newly updated disbursement_date, first_emi_date, and tenure is not given in days;__*

\n
\"message\": \"provide disbursement_date, first_emi_date and loan_tenure_in_days\"\n\n
\n

Response Status Codes:

\n
\n

These are the common error codes pushed by the API in case of any errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDescription
200Successful Request
400Invalid Request
401Unauthorized (The incoming token has expired)
403Forbidden (x-API-key is wrong or partner is not allowed to use this API)
404Not Found (No such loan exists)
500Internal Server Error (Rare)
504 bad gatewayThe server is down. Please inform immediately to tech POC. You can retry within a few seconds.
\n

Rate Limit

\n
\n

Throttling

\n

:10000 requests per second.

\n

Quota

\n

: Unlimited total number of API calls

\n

SLA breakdown

\n
\n\n

Apollo will provide standard technical support twenty-four (24) hours per day, five (5) days per week, excluding weekends and national Indian holidays. Standard Support will be offered via email.

\n\n

Uptime is the percentage of total possible minutes API was available during a fiscal year. Our commitment is to maintain at least 99.99% uptime

\n\n

Sometimes we need to perform maintenance to keep API working smoothly. If scheduled downtime is necessary, we’ll give you at least 48 hours advance notice. In a year, scheduled downtime won’t exceed 12 hours.

\n

Updates

\n

As our business evolves, we may change our service level agreement. Customers can review the most current version of the service level agreement at any time by visiting this page.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Rate Limit","slug":"rate-limit"},{"content":"SLA breakdown","slug":"sla-breakdown"},{"content":"Updates","slug":"updates"}],"owner":"16291369","collectionId":"d2a163f6-70dc-4588-a01b-a6b517efd3d7","publishedId":"UVsLR6bW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-03-15T10:50:01.000Z"},"item":[{"name":"Loan Update API","id":"51b76469-523c-40bd-ac2c-bbb8c4b1b423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"*********","type":"text"},{"warning":"This is a duplicate header and will be overridden by the x-api-key header generated by Postman.","key":"x-api-key","value":"*********","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_tag\": \"apollo assigned partner tag\",\n \"loan_type\": \"loan type\",\n \"loan_information\": {\n \"disbursement_date\": \"Updated disbursement date\",\n \"first_emi_date\": \"first_emi_date will be revised as per DOD + no. of days of tenure\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{servername.com}/{env}/{version}/loan/{id}","urlObject":{"protocol":"https","path":["{env}","{version}","loan","{id}"],"host":["{servername","com}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51b76469-523c-40bd-ac2c-bbb8c4b1b423"},{"name":"Access token ","id":"0ffda34a-4be2-42f4-bce6-96b470dd9a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic *************","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"","type":"text"}]},"url":"https://{name-api-app.auth.ap-server-name-2.{servercognito}.com/{auth2}/token","description":"

This API is for generating access tokens for using Update API

\n\n

Access Token can be generated by the below Python code.

\n
import requests\nimport base64\n \n \nurl = \"will be shared by apollo\"\n \nclient_id = \"will be shared by apollo\"\nclient_secret_id = \"will be shared by apollo\"\n \nbasic = base64.b64encode((client_id+':'+client_secret_id).encode())\n \npayload = 'grant_type=client_credentials&scope='\nheaders = {\n    'Authorization': 'Basic '+basic.decode(),\n    'Content-Type': 'application/x-www-form-urlencoded',\n \n}\n \nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n \nprint(response.json())\n
","urlObject":{"protocol":"https","path":["{auth2}","token"],"host":["{name-api-app","auth","ap-server-name-2","{servercognito}","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ffda34a-4be2-42f4-bce6-96b470dd9a75"}]}