5paisa Loans Partner API’s

Overview

Overview

Use our API’s at no additional costs and integrate with your own trading tools.
You can execute orders in real time, monitor your positions, manage your portfolio and much more.

Our Rest API’s can help you build a complete investment and trading platform in no time. Some key benefits:

  • Build your own trading interface while using your 5paisa Trading account
  • No additional costs
  • Secure and easy to implement
  • Flexible REST API compatible with multiple languages
  • With SDK's for different programming languages like Python, Node JS and Golang
Lender API

Lender API’s

API HEADER REQUEST

This header request for common for all API request :

Parameter DataType Is Mandatory Description
product String M Product name i.e P2P
source String M Source Name i.e Partner UserID shared by 5Paisa
sourcedBy String M From which source
i.e Android/IOS/Web
key String M Request Header Key (Shared by 5Paisa)
appVersion String M Mobile app/Web Version
ipAddress String M Requester device/System IP Address

API HEADER RESPONSE :

his header response format will be same for entire API

Parameter DataType Is Mandatory Description
statusCode Integer Y 500
0
401
400
-1
3
statusMessage {Key1: Value2, Key2:Value2,...} Y Internal_Error_Occured = 500,
Failed = 1,
Success = 0,
No_Record_Found = 0,
Unauthorizd_Access= 401,
Invalid_Header_Key= 400
Session_Expired=-1
Invalid_Request=3

Version 1 UAT:

http://uatapi.5paisaloans.com/p2papi/api/v1

Note : Request Head Section all fields are mandatory

HEAD SECTION PARAMETER

Product,source,sourcedBy,key,appVersion,ipAddress

  1. Product - P2P
  2. source - Partner useid shared by 5Paisa
  3. sourceBy - for web application (Web), for mobile(android/ios etc)
  4. ipAddress (user ipaddress)
  5. appVersion (based on version)

UAT HEADER KEY

Key : We will share separately

Partner User ID & Password: We will share separately.

Token : Generate Token using Partner user id and Password through Authenticate API. Token validity only for 20 minute. Once token expired you need to generate new token and send request.

Authorization : Bearer

1.TOKEN GENERATION API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/authenticate

Request:-
{
{
"head": {
"product": "P2P",
"source": "Partner1",
　"sourcedBy": "Android",
"key": "jhsdfjh343TBVnjksd23njg0njdnxb12jcb",
"appVersion": "0.1",
　"ipAddress": "100.0.0.0"
}
"body"{
"UserId":"Partner1" ,
"Password":"Partner1@123"
}
}

To generate token

Parameter DataType Is Mandatory Description
UserId String M Registration Id of lender
Password String M Password will
Request:-
{
"head": {
　"statusCode": 0,
　"statusMessage": ,{
"message": "Success”
}
},
"body"{
　"token": ""
}
}
Parameter DataType Description
UserId String Generated Token will pass to call api

2.REGISTRATION API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/registration

Request:-
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "0.1",
"appVersion": "",
"ipAddress": ""
},
"body"{
"Name":"Pooja Singh",
"Email":"XXXXa1@gmail.com",
"Mobile":"XXXXXXXX09",
"PAN":"XXXXP3XX4D",
"Aadhar":"XXXXXXXX5456",
"Address":"Kalyan",
"Pincode":"XXX306",
"City":"Mumbai",
"State":"Maharashtra",
"AccountNumber":"XXXXXXXX0052",
"IFSCCode":"XXXX0006412",
"AddressDocument":"GYYHRTYRYYRY",
"AddressDocumentExtention":".jpg",
"BankDocument":"ggdfgdgdgdgdg",
"BankDocumentExtention":".pdf"
}
}
Parameter DataType Is Mandatory Description
Name String M UserName is Required
Email String M Valid Email is Required
Mobile String M Valid Mobile is Required
PAN String M Valid PAN number required
Aadhar String M Valid Aadhar number required
Address String M Address is Required
Pincode String M Pincode is Required
City String M City Name is Required
State String M State Name is Required
AccountNumber String M Valid AccountNumber is Required
ValidIFSC String M Valid IFSC Code is Required
AddressDocument String M Address Document Base64 is Required
AddressDocumentExtention String M Address Document Extention Required
BankDocument String M Bank Document Base64 is require
BankDocumentExtention String M Bank Document Extention Required in pdf format
BankDocumentExtention String M Bank Document Extention Required in pdf format
Request:-
{
"head": {
　"statusCode": 1,
"statusMessage":{
"message":"Success"
}
},
"body"{
"registrationID":"59324123",
"investmentID":"I522090353"
}
}
Parameter DataType Description
RegistrationID String Get Partner Lender Registration Unique Id
InvestmentID String Get Partner Lender Investment Unique Id

3.VIEW PRODUCT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/view-product

Request:-
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
}
"body"{
"RegistrationID":"53529527",
"Producttype":0
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationID of lender
Producttype Int Y 0 Both Array
1 Portfolio List
2 Borrower List
RiskTypeId Int Y RiskTypeId for portfolio
PageIndex Int Y PageIndex
PageSize Int Y PageSize
OrderByCol String Y OrderByCol filter
OrderType String Y OrderType filter
FilterValueRisk String Y Risk value filter
FilterValueTenure String Y Tenure filter
FilterValueAmount String Y Amount filter
Location String Y Location of state filter
Request:-
{
"head": {
"statusCode": 0,
"statusMessage":{
　"message": "Success"
}
},
"body"{
"borrowerCount": 100,
"portfolioCount": 29,
"borrowerDetails": [
{
　"loanid": "A554214164",
　"name": "Ojas",
　"loanAmount": 30000,
　"fundedAmount": 0,
"roi": 36.0,
"tenure": 36,
"risk": "E",
"fundAmountPercent": 0.0,
"remAmount": 30000,
"investmentStatus": "Approved",
"unifiedScore": "0.065",
"cibilScore": "1"
}
],
"portFolioData":[
{
　"riskTypeId": 1,
"riskType": "Conservative",
"risk": "Low Risk, Low Return",
"low_Per": 80.0,
"medium_Per": 10.0,
"high_Per": 10.0,
"min_Return_Per": 12.0,
"max_Return_Per": 18.0,
"tenure": ""
}
]
}
}
Parameter DataType Description
borrowerCount Int borrower Count
portfolioCount Int portfolio Count
borrowerDetails array borrowerDetails
riskTypeId Int riskTypeId for portfolio
riskType String riskType for portfolio
risk String risk for portfolio
low_Per double low_Per for portfolio
medium_Per double medium_Per for portfolio
high_Per double high_Per for portfolio
min_Return_Per double array of portFolioData
max_Return_Per double max_Return_Per for portfolio
tenure String tenure
borrowerDetails array borrowerDetails
cibilScore String cibilScore
unifiedScore String unifiedScore
investmentStatus String string
remAmount Int remAmount
fundAmountPercent Float fundAmountPercent
risk String risk
tenure Int tenure
roi float roi
fundedAmount Int fundedAmount
loanAmount Int loanAmount
name String name
loanid String loanid

4.ESCROW WITHDRAWAL API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/escrow-withdrawal

Request:-
{
"head": {
"product": "P2P",
"source": "",
　"sourcedBy": "",
　"key": "",
"appVersion": "",
　"ipAddress": ""
}
"body"{
　"RegistrationID":"51266354",
　"WithdrawalAmount":10.21,
"WithdrawalType":1
}
}
Parameter DataType Is Mandatory Description
RegistrationID String M RegistrationID of lender
WithdrawalType Int M 1 Escrow Account 0 Portfolio
WithdrawalAmount Int M Withdrawal amount
RiskType String M for portfolio Risktype of portfolio
Request:-
{
"head": {
　"statusCode": 0,
"statusMessage":{
　　"message": "Withdraw request successful. Amount will be credited to your bank account in next 24hrs."
}
}
}
Parameter DataType Description
statusCode Int statusCode
message String Message of withdrawal

5.INVESTMENT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/investment

Invest to portfolio request:
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"50007907",
"InvestAmount":10000,
"UserType":"L",
　"IsAgreementAutoSign":1,
"RiskType":"Billing",
"Producttype":1,
"InvestmentId":"I621234567"
}
}
Invest to portfolio request:
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"50007907",
"InvestAmount":10000,
"UserType":"L",
　"IsAgreementAutoSign":1,
"RiskType":"Billing",
"Producttype":2,
"LoanID":"A921234565",
"InvestmentId":"I621234567"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y Escrow Account or Portfolio Name
Producttype Int M 1 portfolio Invest
2 Indivisual Borrower Invest
InvestAmount Int M Amount to be invested
UserType Date M L as Lender
IsAgreementAutoSign Date M should always be 1
LoanID String M for indivisual loanid of borrower in which lender want to invest
InvestmentId String N Investment id of lender
RiskType String M for portfolio Risktype of portfolio
Response :
{
"body":: { 　"investmentId": null,
　"registrationID": "50007907"
},
"head": {
　 "statusCode": 0,
"statusMessage": {
}
}
}
Parameter DataType Description
investmentId Int investmentId of lender
registrationID String registrationID of lender

6.INVESTMENT SUMMARY API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/investment-summary

Invest to borrower request:
{
"head": { "product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"53529527",
"MonthName":"",
"MonthYear":"",
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationID of lender
MonthName string N Month (May)
MonthYear Int N Year (eg 2020)
param1 string N param1 is for future use
para1 string N param2 is for future use
param3 String N param3 is for future use
Invest to borrower request:
{
"head": {
　"statusCode": 0,
"statusMessage": {
　"message": "Success"
}
"Body":{
"totalInvestment": 0.0,
"principalRecovered": 0.0000,
"interestReceived": 0.0000,
"expectedReturn": 0.00,
"principalLost": 0.0000,
"minYear": 0,
"maxYear": 0,
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Description
statusCode Int status code
message String Message of withdrawal

7.BALANCE OVERVIEW API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/balance-overview

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　"RegistrationId": "58747511",
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationId should be unique user id
AccountType string N AccountType
FromDate DateTime N FromDate
ToDate DateTime N ToDate
param1 string N Extra Parameter
para1 String N Extra Parameter
param3 String N Extra Parameter
Response:
{
"head": {
　"statusCode": 0,
"statusMessage":{
　"message": "Success"
},
}
"Body":{
"partnerBalanceOverview": [
　"totalEcrowBalance": 772990.7,
　"availableBalance": 685825.3,
"portfolioBalance": 87165.35,
"availableBalanceInfo": "",
"param1": "",
"param2": "",
　"param3": ""
}
]
"balanceOverviewDetails":[
{
"accountType": "Escrow Account",
"balance": 685825.3,
"param1": "",
"param2": "",
　"param3": ""
}
{
"accountType": "Sunday",
"balance": 20000.0,
"param1": "",
"param2": "",
　"param3": ""
},
{
　"accountType": "Moderate",
　"balance": 24927.24,
"param1": "",
"param2": "",
　"param3": ""
},
{
　"accountType": "Aggressive",
　"balance": 10693.74,
"param1": "",
"param2": "",
　"param3": ""
},
{
　　"accountType": "Billing ",
　"balance": 10166.88,
"param1": "",
"param2": "",
　"param3": ""
}
]
}
}
Parameter DataType Description
TotalEcrowBalance float Ecrow balance
AvailableBalance Float AvailableBalance
PortfolioBalance Float Portfolio Balance
AvailableBalanceInfo String Available Balance info
AccountType String acount type(Escrow/Portfolio)
Balance String Escrow/portfolio Balance
param1 string Extra Parameter
param2 string Extra Parameter
param3 string Extra Parameter

8.EMI DETAILS API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/emi-details

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　"RegistrationId": "59627719",
"PageIndex":1,
"PageSize":10,
"MonthName":"November",
"MonthYear":2020
}
}
Parameter DataType Description
EMIID Int Emi id
LoanId String Loan Id
EMIDate String Emi date
Amount decimal Amount(Principal amt +interest amt)
PaidDate String Emi paid date
Status String status(Paid, Pending, Bounce))
Principal decimal Principal amount
Interest decimal Interest Amount
count int no of emi count
ProposalId int Proposal amount
param1 string Extra Parameter
param2 string Extra Parameter
param3 string Extra Parameter

9.PORTFOLIO DETAILS API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/portfolio-details

Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　　"RegistrationID":"59324123",
"PortfolioId":5
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y Registartion Id is Required
PortfolioId int Y Portfolio Id is Required
Response:
{
"head": {
　"statusCode": 0,
"statusMessage": {
　"message": "Success"
}
"Body":{
　"portfolioRules": [
{
　"infoDetail": "",
"masterRuleName": "EmploymentType",
"ruleName": "Employment Type",
"ruleValue": "Salaried"
}
]
"portfolioInfo": [
{
　"aboutPortfolio": "Contents
",
"fundAllocation": "Fund Allocation Content"
　"param3": ""
}
],
　"portfolioPastPerformance": null,
"riskTypeId": 5,
"riskType": "Business+",
"risk": "High risk,High Return",
"low_Per": 60.0,
"medium_Per": 20.0,
"high_Per": 20.0,
"min_Return_Per": 12.0,
"max_Return_Per": 25.0,
"tenure": "12"
}
}
Parameter DataType Description
PortfolioRules Array infoDetail - Get Portfolio Details
masterRuleName - Get Master Rule Name
ruleName - Get Master Rule Header Name. ex: CIBIL,
UnifiedScore ruleValue - Get Rule Values
portfolioInfo Array aboutPortfolio - Get About Portfolio description fundAllocation - Get fundallocation description
PortfolioPastPerformance Array Month - Get Month
Year - Get Year
Returns - Get Returns
Default - Get Default Value
RiskTypeId string Get Portfolio RiskType Id
RiskType String Get RiskType Value
Risk String Get Risk Value
Low_Per String Get Low percentage value
Medium_Per String Get Medium percentage value
High_Per String Get High percentage value
min_Return_Per String Get Minimum Return percentage value
Max_Return_Per String Get Maximum Return percentage value
Tenure String Get Tenure Value

10.BORROWER PROFILE API

URL: https://uatapi.5paisaloans.com/p2papi/api//v1/partner/lender/borrower-details

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　　"RegistrationID":"51923902",
"LoanID":"A565860571"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationId should be unique user id
LoanID int Y Borrower loan id
Response:
{
"body": : {
"registrationID": "51923902",
"loanId": "A565860571",
"loanAmount": 300000,
"tenure": 3,
"roi": 12.0,
"loanPurpose": "Debt Consolidation",
"amountFunded": 1500,
"amtNeeded": 298500,
"totalProposal": 1,
"currentCity": "KHOPOLI",
"currentState": "MAHARASHTRA",
"age": 30,
"gender": "Male",
"maritalStatus": "Single",
"noofDependents": ">2",
"residenceType": "Rented",
"educationalName": "Undergraduate",
"employmentType": "Salaried",
"name": "TestB",
"currentExp": "<1",
"employeeName": "JGJG",
"pan": "APPROVED",
"aadhar": "APPROVED",
"bankStatement": "APPROVED",
"salarySlip": "Pending",
"cibil": 0,
"unifiedScore": 0.7,
"risk": "AAA"
},
"head":{
"statusCode": 0,
"statusMessage": {
"message": "Success"
}
}
}
Parameter DataType Description
RegistrationID String RegistrationId should be unique user id
LoanID int Borrower loan id
LoanAmount int LoanAmount
Tenure int tenure of Loan in months
ROI Float Rate of Interest
LoanPurpose String Loan Purpose
AmountFunded int AmountFunded to borrower
AmtNeeded int AmtNeeded
TotalProposal int no of TotalProposal on Loan
CurrentCity String CurrentCity
CurrentState String CurrentState
Age int Age of borrower
Gender String Gender
MaritalStatus string MaritalStatus
NoofDependents String NoofDependents
ResidenceType String ResidenceType
EducationalName String EducationalName
EmploymentType String EmploymentType
Name String Name
CurrentExp String Current Experience
EmployeeName String EmployeeName
PAN String PAN
Aadhar String Aadhar
BankStatement String BankStatement
SalarySlip String SalarySlip
CIBIL int CIBIL
UnifiedScore double UnifiedScore
Risk String Risk

11.ACCOUNT STATEMENT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/account-statement

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
"RegistrationID":"59324123",
"AccountType":"Escrow Account"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String M RegistrationID of lender
AccountType String M Pass Account type as "Escrow Account" or Portfolio type eg Conservative
ToDate DateTime M FromDate
PageIndex DateTime M ToDate
ToDate Int M PageIndex
PageSize string M PageSize
Request:-
{
"head": {
　"statusCode": 0,
"statusMessage":{
"message":"Success"
}
},
"body"[
{
　"date": "08/10/20",
　"description": "Money Added to Escrow", "amount": 1000.0,
"finalBalance": 1000.0,
"transactionType": "Cr",
"param1": "",
"param2": "",
"param3": "",
}
]
}
Parameter DataType Description
date string status code
description string Description of money transaction
finalBalance float Final Balance in escrow account
transactionType string Transaction Type debit(Dr) credit(Cr)
Medium_Per String Extra Parameter
param1 String Extra Parameter
param1 String Extra Parameter
Sample Request
{
"head": {
"appName": "5PRASHMI",
"appVer": "1.0",
"key": "WelW2CTD0srtUUDaQzs2e22TeydRlLv3",
"osName": "Android",
"requestCode": "5PMF",
"userId": "r8aokDeH54g",
"password": "qo6eKEuVFNe"
},
"body": {
"Count": 1,"MarketFeedData":[{"Exch":"N", "ExchType":"C","Symbol":"BHEL","Expiry":"","StrikePrice":"0", "OptionType":""},{"Exch":"N","ExchType":"D","Symbol":"INFY 29 Oct 2020","Expiry":"20201029","StrikePrice":"0","OptionType": "XX"}],"ClientLoginType":0,"LastRequestTime":"/Date(0)/"," RefreshRate":"H"}
}
Borrower API

Borrower API’s

API HEADER REQUEST

This header request for common for all API request :

Parameter DataType Is Mandatory Description
product String M Product name i.e P2P
source String M Source Name i.e Partner UserID shared by 5Paisa
sourcedBy String M From which source
i.e Android/IOS/Web
key String M Request Header Key (Shared by 5Paisa)
appVersion String M Mobile app/Web Version
ipAddress String M Requester device/System IP Address

API HEADER RESPONSE :

his header response format will be same for entire API

Parameter DataType Is Mandatory Description
statusCode Integer Y 500
0
401
400
-1
3
statusMessage {Key1: Value2, Key2:Value2,...} Y Internal_Error_Occured = 500,
Failed = 1,
Success = 0,
No_Record_Found = 0,
Unauthorizd_Access= 401,
Invalid_Header_Key= 400
Session_Expired=-1
Invalid_Request=3

Version 1 UAT:

http://uatapi.5paisaloans.com/p2papi/api/v1

Note : Request Head Section all fields are mandatory

HEAD SECTION PARAMETER

Product,source,sourcedBy,key,appVersion,ipAddress

  1. Product - P2P
  2. source - Partner useid shared by 5Paisa
  3. sourceBy - for web application (Web), for mobile(android/ios etc)
  4. ipAddress (user ipaddress)
  5. appVersion (based on version)

UAT HEADER KEY

Key : We will share separately

Partner User ID & Password: We will share separately.

Token : Generate Token using Partner user id and Password through Authenticate API. Token validity only for 20 minute. Once token expired you need to generate new token and send request.

Authorization : Bearer

1.TOKEN GENERATION API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/authenticate

Request:-
{
{
"head": {
"product": "P2P",
"source": "Partner1",
　"sourcedBy": "Android",
"key": "jhsdfjh343TBVnjksd23njg0njdnxb12jcb",
"appVersion": "0.1",
　"ipAddress": "100.0.0.0"
}
"body"{
"UserId":"Partner1" ,
"Password":"Partner1@123"
}
}

To generate token

Parameter DataType Is Mandatory Description
UserId String M Registration Id of lender
Password String M Password will
Request:-
{
"head": {
　"statusCode": 0,
　"statusMessage": ,{
"message": "Success”
}
},
"body"{
　"token": ""
}
}
Parameter DataType Description
UserId String Generated Token will pass to call api

2.REGISTRATION API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/registration

Request:-
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "0.1",
"appVersion": "",
"ipAddress": ""
},
"body"{
"Name":"Pooja Singh",
"Email":"XXXXa1@gmail.com",
"Mobile":"XXXXXXXX09",
"PAN":"XXXXP3XX4D",
"Aadhar":"XXXXXXXX5456",
"Address":"Kalyan",
"Pincode":"XXX306",
"City":"Mumbai",
"State":"Maharashtra",
"AccountNumber":"XXXXXXXX0052",
"IFSCCode":"XXXX0006412",
"AddressDocument":"GYYHRTYRYYRY",
"AddressDocumentExtention":".jpg",
"BankDocument":"ggdfgdgdgdgdg",
"BankDocumentExtention":".pdf"
}
}
Parameter DataType Is Mandatory Description
Name String M UserName is Required
Email String M Valid Email is Required
Mobile String M Valid Mobile is Required
PAN String M Valid PAN number required
Aadhar String M Valid Aadhar number required
Address String M Address is Required
Pincode String M Pincode is Required
City String M City Name is Required
State String M State Name is Required
AccountNumber String M Valid AccountNumber is Required
ValidIFSC String M Valid IFSC Code is Required
AddressDocument String M Address Document Base64 is Required
AddressDocumentExtention String M Address Document Extention Required
BankDocument String M Bank Document Base64 is require
BankDocumentExtention String M Bank Document Extention Required in pdf format
BankDocumentExtention String M Bank Document Extention Required in pdf format
Request:-
{
"head": {
　"statusCode": 1,
"statusMessage":{
"message":"Success"
}
},
"body"{
"registrationID":"59324123",
"investmentID":"I522090353"
}
}
Parameter DataType Description
RegistrationID String Get Partner Lender Registration Unique Id
InvestmentID String Get Partner Lender Investment Unique Id

3.VIEW PRODUCT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/view-product

Request:-
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
}
"body"{
"RegistrationID":"53529527",
"Producttype":0
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationID of lender
Producttype Int Y 0 Both Array
1 Portfolio List
2 Borrower List
RiskTypeId Int Y RiskTypeId for portfolio
PageIndex Int Y PageIndex
PageSize Int Y PageSize
OrderByCol String Y OrderByCol filter
OrderType String Y OrderType filter
FilterValueRisk String Y Risk value filter
FilterValueTenure String Y Tenure filter
FilterValueAmount String Y Amount filter
Location String Y Location of state filter
Request:-
{
"head": {
"statusCode": 0,
"statusMessage":{
　"message": "Success"
}
},
"body"{
"borrowerCount": 100,
"portfolioCount": 29,
"borrowerDetails": [
{
　"loanid": "A554214164",
　"name": "Ojas",
　"loanAmount": 30000,
　"fundedAmount": 0,
"roi": 36.0,
"tenure": 36,
"risk": "E",
"fundAmountPercent": 0.0,
"remAmount": 30000,
"investmentStatus": "Approved",
"unifiedScore": "0.065",
"cibilScore": "1"
}
],
"portFolioData":[
{
　"riskTypeId": 1,
"riskType": "Conservative",
"risk": "Low Risk, Low Return",
"low_Per": 80.0,
"medium_Per": 10.0,
"high_Per": 10.0,
"min_Return_Per": 12.0,
"max_Return_Per": 18.0,
"tenure": ""
}
]
}
}
Parameter DataType Description
borrowerCount Int borrower Count
portfolioCount Int portfolio Count
borrowerDetails array borrowerDetails
riskTypeId Int riskTypeId for portfolio
riskType String riskType for portfolio
risk String risk for portfolio
low_Per double low_Per for portfolio
medium_Per double medium_Per for portfolio
high_Per double high_Per for portfolio
min_Return_Per double array of portFolioData
max_Return_Per double max_Return_Per for portfolio
tenure String tenure
borrowerDetails array borrowerDetails
cibilScore String cibilScore
unifiedScore String unifiedScore
investmentStatus String string
remAmount Int remAmount
fundAmountPercent Float fundAmountPercent
risk String risk
tenure Int tenure
roi float roi
fundedAmount Int fundedAmount
loanAmount Int loanAmount
name String name
loanid String loanid

4.ESCROW WITHDRAWAL API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/escrow-withdrawal

Request:-
{
"head": {
"product": "P2P",
"source": "",
　"sourcedBy": "",
　"key": "",
"appVersion": "",
　"ipAddress": ""
}
"body"{
　"RegistrationID":"51266354",
　"WithdrawalAmount":10.21,
"WithdrawalType":1
}
}
Parameter DataType Is Mandatory Description
RegistrationID String M RegistrationID of lender
WithdrawalType Int M 1 Escrow Account 0 Portfolio
WithdrawalAmount Int M Withdrawal amount
RiskType String M for portfolio Risktype of portfolio
Request:-
{
"head": {
　"statusCode": 0,
"statusMessage":{
　　"message": "Withdraw request successful. Amount will be credited to your bank account in next 24hrs."
}
}
}
Parameter DataType Description
statusCode Int statusCode
message String Message of withdrawal

5.INVESTMENT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/investment

Invest to portfolio request:
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"50007907",
"InvestAmount":10000,
"UserType":"L",
　"IsAgreementAutoSign":1,
"RiskType":"Billing",
"Producttype":1,
"InvestmentId":"I621234567"
}
}
Invest to portfolio request:
{
"head": {
"product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"50007907",
"InvestAmount":10000,
"UserType":"L",
　"IsAgreementAutoSign":1,
"RiskType":"Billing",
"Producttype":2,
"LoanID":"A921234565",
"InvestmentId":"I621234567"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y Escrow Account or Portfolio Name
Producttype Int M 1 portfolio Invest
2 Indivisual Borrower Invest
InvestAmount Int M Amount to be invested
UserType Date M L as Lender
IsAgreementAutoSign Date M should always be 1
LoanID String M for indivisual loanid of borrower in which lender want to invest
InvestmentId String N Investment id of lender
RiskType String M for portfolio Risktype of portfolio
Response :
{
"body":: { 　"investmentId": null,
　"registrationID": "50007907"
},
"head": {
　 "statusCode": 0,
"statusMessage": {
}
}
}
Parameter DataType Description
investmentId Int investmentId of lender
registrationID String registrationID of lender

6.INVESTMENT SUMMARY API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/investment-summary

Invest to borrower request:
{
"head": { "product": "P2P",
"source": "",
"sourcedBy": "",
"key": "",
"appVersion": "",
"ipAddress": ""
},
"Body":{
"RegistrationID":"53529527",
"MonthName":"",
"MonthYear":"",
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationID of lender
MonthName string N Month (May)
MonthYear Int N Year (eg 2020)
param1 string N param1 is for future use
para1 string N param2 is for future use
param3 String N param3 is for future use
Invest to borrower request:
{
"head": {
　"statusCode": 0,
"statusMessage": {
　"message": "Success"
}
"Body":{
"totalInvestment": 0.0,
"principalRecovered": 0.0000,
"interestReceived": 0.0000,
"expectedReturn": 0.00,
"principalLost": 0.0000,
"minYear": 0,
"maxYear": 0,
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Description
statusCode Int status code
message String Message of withdrawal

7.BALANCE OVERVIEW API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/balance-overview

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　"RegistrationId": "58747511",
"param1": "",
"param2": "",
　"param3": ""
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationId should be unique user id
AccountType string N AccountType
FromDate DateTime N FromDate
ToDate DateTime N ToDate
param1 string N Extra Parameter
para1 String N Extra Parameter
param3 String N Extra Parameter
Response:
{
"head": {
　"statusCode": 0,
"statusMessage":{
　"message": "Success"
},
}
"Body":{
"partnerBalanceOverview": [
　"totalEcrowBalance": 772990.7,
　"availableBalance": 685825.3,
"portfolioBalance": 87165.35,
"availableBalanceInfo": "",
"param1": "",
"param2": "",
　"param3": ""
}
]
"balanceOverviewDetails":[
{
"accountType": "Escrow Account",
"balance": 685825.3,
"param1": "",
"param2": "",
　"param3": ""
}
{
"accountType": "Sunday",
"balance": 20000.0,
"param1": "",
"param2": "",
　"param3": ""
},
{
　"accountType": "Moderate",
　"balance": 24927.24,
"param1": "",
"param2": "",
　"param3": ""
},
{
　"accountType": "Aggressive",
　"balance": 10693.74,
"param1": "",
"param2": "",
　"param3": ""
},
{
　　"accountType": "Billing ",
　"balance": 10166.88,
"param1": "",
"param2": "",
　"param3": ""
}
]
}
}
Parameter DataType Description
TotalEcrowBalance float Ecrow balance
AvailableBalance Float AvailableBalance
PortfolioBalance Float Portfolio Balance
AvailableBalanceInfo String Available Balance info
AccountType String acount type(Escrow/Portfolio)
Balance String Escrow/portfolio Balance
param1 string Extra Parameter
param2 string Extra Parameter
param3 string Extra Parameter

8.EMI DETAILS API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/emi-details

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　"RegistrationId": "59627719",
"PageIndex":1,
"PageSize":10,
"MonthName":"November",
"MonthYear":2020
}
}
Parameter DataType Description
EMIID Int Emi id
LoanId String Loan Id
EMIDate String Emi date
Amount decimal Amount(Principal amt +interest amt)
PaidDate String Emi paid date
Status String status(Paid, Pending, Bounce))
Principal decimal Principal amount
Interest decimal Interest Amount
count int no of emi count
ProposalId int Proposal amount
param1 string Extra Parameter
param2 string Extra Parameter
param3 string Extra Parameter

9.PORTFOLIO DETAILS API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/portfolio-details

Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　　"RegistrationID":"59324123",
"PortfolioId":5
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y Registartion Id is Required
PortfolioId int Y Portfolio Id is Required
Response:
{
"head": {
　"statusCode": 0,
"statusMessage": {
　"message": "Success"
}
"Body":{
　"portfolioRules": [
{
　"infoDetail": "",
"masterRuleName": "EmploymentType",
"ruleName": "Employment Type",
"ruleValue": "Salaried"
}
]
"portfolioInfo": [
{
　"aboutPortfolio": "Contents
",
"fundAllocation": "Fund Allocation Content"
　"param3": ""
}
],
　"portfolioPastPerformance": null,
"riskTypeId": 5,
"riskType": "Business+",
"risk": "High risk,High Return",
"low_Per": 60.0,
"medium_Per": 20.0,
"high_Per": 20.0,
"min_Return_Per": 12.0,
"max_Return_Per": 25.0,
"tenure": "12"
}
}
Parameter DataType Description
PortfolioRules Array infoDetail - Get Portfolio Details
masterRuleName - Get Master Rule Name
ruleName - Get Master Rule Header Name. ex: CIBIL,
UnifiedScore ruleValue - Get Rule Values
portfolioInfo Array aboutPortfolio - Get About Portfolio description fundAllocation - Get fundallocation description
PortfolioPastPerformance Array Month - Get Month
Year - Get Year
Returns - Get Returns
Default - Get Default Value
RiskTypeId string Get Portfolio RiskType Id
RiskType String Get RiskType Value
Risk String Get Risk Value
Low_Per String Get Low percentage value
Medium_Per String Get Medium percentage value
High_Per String Get High percentage value
min_Return_Per String Get Minimum Return percentage value
Max_Return_Per String Get Maximum Return percentage value
Tenure String Get Tenure Value

10.BORROWER PROFILE API

URL: https://uatapi.5paisaloans.com/p2papi/api//v1/partner/lender/borrower-details

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
　　"RegistrationID":"51923902",
"LoanID":"A565860571"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String Y RegistrationId should be unique user id
LoanID int Y Borrower loan id
Response:
{
"body": : {
"registrationID": "51923902",
"loanId": "A565860571",
"loanAmount": 300000,
"tenure": 3,
"roi": 12.0,
"loanPurpose": "Debt Consolidation",
"amountFunded": 1500,
"amtNeeded": 298500,
"totalProposal": 1,
"currentCity": "KHOPOLI",
"currentState": "MAHARASHTRA",
"age": 30,
"gender": "Male",
"maritalStatus": "Single",
"noofDependents": ">2",
"residenceType": "Rented",
"educationalName": "Undergraduate",
"employmentType": "Salaried",
"name": "TestB",
"currentExp": "<1",
"employeeName": "JGJG",
"pan": "APPROVED",
"aadhar": "APPROVED",
"bankStatement": "APPROVED",
"salarySlip": "Pending",
"cibil": 0,
"unifiedScore": 0.7,
"risk": "AAA"
},
"head":{
"statusCode": 0,
"statusMessage": {
"message": "Success"
}
}
}
Parameter DataType Description
RegistrationID String RegistrationId should be unique user id
LoanID int Borrower loan id
LoanAmount int LoanAmount
Tenure int tenure of Loan in months
ROI Float Rate of Interest
LoanPurpose String Loan Purpose
AmountFunded int AmountFunded to borrower
AmtNeeded int AmtNeeded
TotalProposal int no of TotalProposal on Loan
CurrentCity String CurrentCity
CurrentState String CurrentState
Age int Age of borrower
Gender String Gender
MaritalStatus string MaritalStatus
NoofDependents String NoofDependents
ResidenceType String ResidenceType
EducationalName String EducationalName
EmploymentType String EmploymentType
Name String Name
CurrentExp String Current Experience
EmployeeName String EmployeeName
PAN String PAN
Aadhar String Aadhar
BankStatement String BankStatement
SalarySlip String SalarySlip
CIBIL int CIBIL
UnifiedScore double UnifiedScore
Risk String Risk

11.ACCOUNT STATEMENT API

URL: https://uatapi.5paisaloans.com/p2papi/api/v1/partner/lender/account-statement

　Request:
{
"head": {
　 "product": "P2P",
　"source": "",
"sourcedBy": "",
　"key": "",
　"appVersion": "",
　"ipAddress": ""
}
"Body":{
"RegistrationID":"59324123",
"AccountType":"Escrow Account"
}
}
Parameter DataType Is Mandatory Description
RegistrationID String M RegistrationID of lender
AccountType String M Pass Account type as "Escrow Account" or Portfolio type eg Conservative
ToDate DateTime M FromDate
PageIndex DateTime M ToDate
ToDate Int M PageIndex
PageSize string M PageSize
Request:-
{
"head": {
　"statusCode": 0,
"statusMessage":{
"message":"Success"
}
},
"body"[
{
　"date": "08/10/20",
　"description": "Money Added to Escrow", "amount": 1000.0,
"finalBalance": 1000.0,
"transactionType": "Cr",
"param1": "",
"param2": "",
"param3": "",
}
]
}
Parameter DataType Description
date string status code
description string Description of money transaction
finalBalance float Final Balance in escrow account
transactionType string Transaction Type debit(Dr) credit(Cr)
Medium_Per String Extra Parameter
param1 String Extra Parameter
param1 String Extra Parameter
Sample Request
{
"head": {
"appName": "5PRASHMI",
"appVer": "1.0",
"key": "WelW2CTD0srtUUDaQzs2e22TeydRlLv3",
"osName": "Android",
"requestCode": "5PMF",
"userId": "r8aokDeH54g",
"password": "qo6eKEuVFNe"
},
"body": {
"Count": 1,"MarketFeedData":[{"Exch":"N", "ExchType":"C","Symbol":"BHEL","Expiry":"","StrikePrice":"0", "OptionType":""},{"Exch":"N","ExchType":"D","Symbol":"INFY 29 Oct 2020","Expiry":"20201029","StrikePrice":"0","OptionType": "XX"}],"ClientLoginType":0,"LastRequestTime":"/Date(0)/"," RefreshRate":"H"}
}