{"info":{"_postman_id":"bef90825-3227-428f-81eb-5d651ecfd10e","name":"Apollo Finvest: Repayment API V2","description":"

Repayment API Version 2

\n

Introduction

\n

This API enables partners and collection agents to share the repayments made by the borrowers. This helps to reduce manual interventions and make repayment-related updates instantaneously.

\n

Overview

\n

This is a POST-API to share the repayment-related information with Apollo Finvest. This API can push the repayment details such as the amount, charges, etc along with relevant loan information.

\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
repayment_statusDescription
pendingWhen a repayment status is pending, this means basic validations are as expected.
Payment ids and Amount verification is still in progress.
Partners have to listen via webhook for the final status.
rejectedIf repayment status is rejected through API - This means basic validations for the request have failed. Partner has added incorrect value/parameter and it is mandatory for partners to retry with correct data.
\n

Authentication/Authorisation

\n
\n

x-API-key and access tokens 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 API collection to understand more...

\n
import requests\nimport base64\nurl = \"will be shared by apollo\"\napp_client_id = \"will be shared by apollo\"\napp_secret = \"will be shared by apollo\"\nbasic = base64.b64encode((app_client_id+':'+app_secret).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

Required Fields in Request Body

\n
\n

There are fields necessarily required to operate this API. Please follow the instructions to integrate and operate this API efficiently.

\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\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
RequestValuesDescription
partner_tagUnique Partner Tag provided by Apollo. Eg: ABCRequired This helps to identify the partner while loan creation. This is created by Apollo. String
loan_typePL/ML/CL/LOCRequired Use the right input product to which repayment is made. PL- Personal Loan, ML- Micro Loan, CL- Consumer Loan. String
partner_loan_idUnique Loan Id created and maintained by the partner. Eg: 123abc
In case of \"LOC\" input partner loan id as the loc_ID that was sent while creating a loc and in case the repayment is drawdown specific, input the drawdown id under partner loan id		Required This loan_id will be used to create the loan in LMS and works as an identifier between Apollo and Partner. It should not be more than 10 digits. It is created by the partner. String
payment_idUnique Payment Id only for SUCCESSFUL transaction. Eg. pay_DG4ZdRK8ZnXC3kRequired This is a unique id to capture and fetch payment. String
order_idUnique Order Id only for SUCCESSFUL transaction. Eg. order_GjCr5oKh4AVC51Required Order id creation is important as it helps you associate every payment with an order, thus preventing multiple payments. String
collection_agentUnique id given by Apollo for collections
Eg: \"test123\"		Required String This works as an identifier between Apollo and collection agent.
customer_payback_dateThis is the date column to indicate the repayment date. Eg: DD/MM/YYYYRequired Date String Its the date when the customer made the repayment
amount_received_exclusive_of_chargesThis should be only a number. Eg: 10Required Integer This amount indicates the repayment amount or EMI actually received. This cannot be zero
penal_interestThis should be only a number. Eg: 10Required Integer Penal interest is the charge on delayed repayments. This can be zero if there are no relevant charges
pre-payment_chargesThis should be only a numberThis will be any pre-payment charges that will be charged to the borrower
other_chargesThis should be only a number. Eg: 10Required Integer This is an amount charged if there are any other charges on the. This can be zero if there are no relevant charges
gst_on_other_chargesThis should be only a number. Eg: 10Required Integer This amount is the GST charged on other charges. This cannot be zero if other charges exist
is_prepaymentTo indicate the repayment type. Eg: true or falseOptional Boolean This is applicable only if the repayment is done for future EMIs or to foreclose the loan. In any other case, it will be false.
\n

Sample Request Body

\n
\n
{\n    \"partner_tag\": \"Test\",\n    \"loan_type\": \"PL\",\n    \"partner_loan_id\": \"t3\",\n    \"order_id\":\"order_GjCr5oK4AVC51\",\n    \"payment_id\": \"pay_uTjCrafb4AVC51\",\n    \"collection_agent\":\"test\",\n    \"customer_payback_date\": \"1/7/2022\",\n    \"amount_received_exclusive_of_charges\": 500,\n    \"penal_interest\": 0,\n    \"pre-payment_charges\":0,\n    \"other_charges\": 0,\n    \"gst_on_other_charges\": 0,\n    \"is_prepayment\": true\n}\n\n
\n

Sample response

\n
\n

When a repayment is pushed and few basic validations are as expected:

\n
{\n\"message\": \"repayment created successfully, pending confirmation\",\n\"repayment_status\": \"pending\",\n\"created_at\" : 1678392365,\n\"afil_repayment_id\": \"rpy_9131f8ab9f\"\n}\n\n
\n

When a repayment is rejected due to some reason:

\n
{\n\"message\": \"missing parameter partner_tag\",\n\"repayment_status\": \"rejected\",\n\"created_at\" : 1678392365,\n\"afil_repayment_id\": \"rpy_9131f8ab9f\"\n}\n\n
\n

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
Status 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)
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

SLA breakdown

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Repayment API Version 2","slug":"repayment-api-version-2"},{"content":"Status Codes","slug":"status-codes"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"SLA breakdown","slug":"sla-breakdown"}],"owner":"16291369","collectionId":"bef90825-3227-428f-81eb-5d651ecfd10e","publishedId":"2s93z58jDV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-22T05:21:48.000Z"},"item":[{"name":"Repayment API","id":"577b2e8c-ea83-4fae-8422-2825d3a1ed40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"****************************","type":"text"},{"key":"x-api-key","value":"****************","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_tag\": \"Test\",\n \"loan_type\": \"PL\",\n \"partner_loan_id\": \"t3\",\n \"order_id\":\"order_GjCr5oKh4AVC51\",\n \"payment_id\": \"pay_uTjCrafhb4AVC51\",\n \"collection_agent\":\"test\",\n \"customer_payback_date\": \"1/7/2022\",\n \"amount_received_exclusive_of_charges\": 500,\n \"penal_interest\": 0,\n \"other_charges\": 0,\n \"gst_on_other_charges\": 0,\n \"is_prepayment\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://{servername.com}/{env}/{version}/{action}","urlObject":{"protocol":"https","path":["{env}","{version}","{action}"],"host":["{servername","com}"],"query":[],"variable":[]}},"response":[],"_postman_id":"577b2e8c-ea83-4fae-8422-2825d3a1ed40"},{"name":"Access Token Generator","id":"5bc719b4-3bf3-47cc-8a06-602a21ff5f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":""},{"key":"clientSecret","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"client_authentication","value":""},{"key":"authUrl","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://{name-api-app.auth.ap-server-name-2.{servercognito}.com/{auth2}/token","urlObject":{"protocol":"https","path":["{auth2}","token"],"host":["{name-api-app","auth","ap-server-name-2","{servercognito}","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bc719b4-3bf3-47cc-8a06-602a21ff5f76"}]}