These APIs help to have smooth disbursement status communication between both Apollo and Fintech partners.
\nThis API makes sure that there is efficient communication between Apollo and Fintech partners based on who has conducted the disbursement activity. Once the disbursement is done by Apollo, the partners can use Disbursement Read API to fetch the status of the disbursement.
There are 3 key elements to Loan Read APIPartner provides a callback URL on which they want to get a notification for the disbursement of a loan
This URL will be added to the partner’s configuration on Sonic to enable this feature. This is optional and can be used instead of Disbursement Read Status API by simply giving a Callback URL and integrating it with Sonic.
Whenever Apollo uploads and update the disbursement status for a loan and if the URL is integrated into the partner’s configuration on Sonic, then it will send responses along with the status to the partner on this URL.
\nThe response structure sent by Sonic contains the following information:
\nResponse sent on Webhook URL when status success is uploaded;
\n{\n \"partner_tag\": \"TEST3\",\n \"loan_type\": \"PL\",\n \"loan_id\": \"TEST202\",\n \"utr\": \"N1372115063\",\n \"status\": \"SUCCESS\",\n \"bank_name\": \"HDFC Bank\",\n \"customer_bank_account_name\": \"Salman Khan\",\n \"bank_account_number\": \"50170817\",\n \"bank_IFSC_code\": \"HDFC0046\"\n}\n\nResponse sent on Webhook URL when status Failed is uploaded
\n{\n\"partner_tag\": \"TEST4\", \n\"loan_type\": \"CL\", \n\"loan_id\": \"test0001\", \n\"utr\": \"\",\n \"status\": \"Failed\"\n}\n\nThese are the common statuses pushed on the response body of the Disbursement Status Read API and Callback URL.
\nApollo Finvest will hit the callback URL provided by Fintechs only when the accounts team at Apollo uploads the disbursement status file manually on Sonic.
\n","_postman_id":"09e832d2-bc0c-48a7-84f0-7985e8534aaf"},{"name":"Disbursement status update","id":"1a2abd8a-f334-470d-b2df-38c0ede840ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This is a post API for the UAT/test environment and Prod to update the disbursement status of a loan on Apollo's Loan Management System: Sonic. This API is used when Fintech partners do the disbursement. Whenever loans are disbursed the status must be communicated to Apollo Finvest and all stakeholders involved for easy operations.
Below mentioned are the key request fields required while hitting the Status Update API
\nIf a loan is successfully disbursed by the partner, the below request will be sent to the API
\n{\n \"partner_tag\": \"TEST\",\n \"loan_type\": \"PL\",\n \"loan_id\": \"qw5\",\n \"status\": \"SUCCESS\",\n \"utr\": \"hiudgchjvwbn\"\n}\n\nThe below response will be provided to the partner once the request is successful
\n{\n \"message\": \"UTR uploaded successfully\"\n}\n\nIf the disbursement transaction failed, the below request will be sent to the API
\n{\n \"partner_tag\": \"TEST\",\n \"loan_type\": \"PL\",\n \"loan_id\": \"qw5\",\n \"status\": \"FAILED\",\n \"utr\": \"hiudgchjvwbn\"\n}\n\nThe below response will be provided to the partner after the failed transaction is updated at Apollo's end
\n{\n \"message\": \"Loan moved to failed state\"\n}\n\nThese are the common error codes pushed by the API in case of any errors.
\n10000 requests per second.
\nUnlimited total number of API calls
\nApollo 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.
\nUptime is the percentage of total possible minutes API was available during a fiscal year. Our commitment is to maintain at least 99.99% uptime:
\nSometimes 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.
\nAs 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","urlObject":{"protocol":"https","path":["{bureau_name}","{version}","{bureau-request}"],"host":["{servername","com}"],"query":[],"variable":[]}},"response":[{"id":"5413f76e-09b2-4650-8930-76e0ce0e9435","name":"Disbursement status update Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"STATUS\": \"SUCCESS\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apollofinvestapi.com/disbursement_status_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Sep 2021 05:23:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b9086f3f-fde6-4ea2-b39a-a93c32344fa4"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"GGdRGFtKBcwFh7A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-614c0f3a-6d74ed663180b7cd0ec12d8a;Sampled=0"}],"cookie":[],"responseTime":null,"body":"{\n \"STATUS\": \"SUCCESS\"\n}"}],"_postman_id":"1a2abd8a-f334-470d-b2df-38c0ede840ad"},{"name":"Disbursement status read","id":"d0bb0d3d-fcc4-4e76-8536-6dad3283d134","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"This is post API for UAT/test environment and Prodc to get the disbursement status of a loan on Apollo's Loan Management System: Sonic. This is the API used when **Apollo do the disbursement.**Whenever loans are disbursed the status must be communicated to Partners and all stakeholders involved for easy operations.
As mentioned above the partners can provide a Callback URL and integrate it with Sonic. It will help the partners to save time, instead of hitting this API multiple times.
\nBelow mentioned are the key request fields required while hitting the Status Read API
\nThe Loan Id was created by the Partner at the time of loan creation. Eg: \"Test001\"
\nBelow mentioned is a sample request body to use the Disbursement Read API
\n{\n \"partner_tag\": \"PT\",\n \"loan_type\": \"ML\",\n \"loan_id\": \"TEST1000\",\n \"status\":\"SUCCESS\"\n}\n\nAll the below fields in the response body are defined as same as above.
\n\n\nThe
\n
A sample response received from the Disbursement Read API will look like this below.
\n{\n \"partner_tag\": \"PT\",\n \"loan_type\": \"ML\",\n \"loan_id\": \"TEST1000\",\n \"utr\": \"ASDFJHHFJ87\",\n \"status\": \"SUCCESS\"\n}\n\nThese are the common statuses pushed on the response body of the Disbursement Status Read API and Callback URL. This states whether the disbursement for a particular loan is successful or failed or pending.
These are the common error codes pushed by the API in case of any errors
\nRate Limit and SLA Breakdown conditions will be the same as above, mentioned on Disbursement Status Update API.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","urlObject":{"protocol":"https","path":["{bureau_name}","{version}","{bureau-request}"],"host":["{servername","com}"],"query":[],"variable":[]}},"response":[{"id":"940b213e-5bd5-4fe0-985c-8684cb9b92ed","name":"Disbursement status read Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tag\": \"TEST3\",\n \"loan_type\": \"PL\",\n \"loan_id\": \"TEST005\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apollofinvestapi.com/disbursement_status_read"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Sep 2021 05:25:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"07d157a8-8454-40e8-8d81-3802f4b93bf5"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"GGdlZGoohcwFoKg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-614c0fbb-2b930aba461f545e2828bd90;Sampled=0"}],"cookie":[],"responseTime":null,"body":"{\n \"tag\": \"TEST3\",\n \"loan_type\": \"PL\",\n \"loan_id\": \"TEST005\",\n \"utr\": \"N280201266126500\",\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"d0bb0d3d-fcc4-4e76-8536-6dad3283d134"}],"event":[{"listen":"prerequest","script":{"id":"88a98a95-0cb9-44c2-b966-d262c727b0a0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d007d31-db76-445a-ba85-4dbe512bff33","type":"text/javascript","exec":[""]}}]}