API (V 1.0)

Cashcow API is integrated web service API that helps Cashcow to programmatically exchange data on advisor, lead and more. For using the Cashcow API, you need to have Credentials provided by Cashcow.

Function

Opertions are define in the function, and for each function there are perdefined "Function Codes".

Function Function Code
Advisor 1
Lead 2
Lead Dashboard 3


Advisor

Opertions are define in the method related to Advisor Creation and Manupalation are defined with method code.

Methods

Operation Method Code
Create 1



Create Advisor

The API is created for creation of Advisor with cashcow.

URL http://cashcow.ai/4e31e11a-c6c3-4959-8952-20a8a80b5826/API/

Request Parameters:

Parameters Required Description
user_id * User Id As provided By Cashcow.ai.
password * Password As provided By Cashcow.ai.
secret_key * Secret Key As provided By Cashcow.ai.
function * Function Code ‘1’
method * Method Code.
name * Advisor Name
phone_no * 10 Digit MobileExample:9123456789
pincode * 6 Digit Pincode value Example:123456
email * Email example:abc@pqr.com
occupation * Occupation Code Table Example: 1(for: house wife)
other Optional Mention Occupation if not listed in Occupation List
company_name Optional Non Numaric Values
address Optional Text

Data Parameters:

Parameters Type Description
user_id Text User Id As provided By Cashcow.ai, without white space
password Text Password As provided By Cashcow.ai, without white space
secret_key Text Secret Key As provided By Cashcow.ai, without white space
function Int Function Code ‘2’
method Int Method Code.
name Text Non Numeric Values
phone_no Int 10 Digit Numeric Value Example:9123456789
pincode Int 6 Digit Numeric value Example:123456
email Text Email example:abc@pqr.com
occupation Int Codes as Defined in Occupation Code Table Example: 1(for: house wife)
other Text Non Numeric Values
company_name Text Non Numeric Values
address Text Text

Request Example:

$data = array(
'user_id' => 'user', //Required
'password' => 'password', //Required
'secret_key' => 'hkdfksd53sf1df', //Required
'function' => '1', //Required
'method' => '1', //Required
'name' => 'Sample Name', //Required
'phone_no' => '9000000000', //Required
'email' => 'demo@example.com', //Required
'company_name' => 'sample company', // optional
'address' => ‘sample address’, // optional
'occupation' => '6', //Required
'other' => 'Other Ocupation', // optional
'pincode' => '400101', //Required
'referedby' => '1' //optional
);

Response Example:

{"status":"success" , "status_code":"1","msg":"Recode Inserted"}

Error Example:

{"status":"fail" , "status_code":"5" , "sub_status_code":"1" , "msg":"parameter mismatch"}

Occupation:

Type Code
House Wife 1
Retied Professional 2
LIC Agent 3
CA 4
Real Estate 5
Other * 100
* If Occupation is other then need to specify "other" occupation parameter.

Error Codes:

Error Parameters Description Status Codes Sub Error Codes status
Authentication Error Invalid Authentication Details 100 fail
Internal Error Server Error 2 fail
Function Invalid Function Code 3 fail
Method Invalid Method Code 4 fail
Parameter Mismatch Error Name Non Numeric Values 5 1 fail
Parameter Mismatch Error Phone Invalid or empty Phone number ValueExample:9123456789 5 2 fail
Parameter Mismatch Error Email Invalid or empty Value Email example:abc@pqr.com 5 3 fail
Parameter Mismatch Error Pincode Invalid or empty Pincode Value Example:123456 5 4 fail
Parameter Mismatch Error Occupation Invalid or Empty Occupation Code 5 5 fail
Parameter Mismatch Error Other Other Occupation Not Defined 5 6 fail
Duplicate Entry Error Duplicate Entry Error 6 fail
Limit Reached Error Insert Limit Reached(Limit) 102 fail
Operation Success Operation Success 1 success

Advisor Offline Documentation



Lead

This API is for referring the leads to Cashcow. The parameters are detailed in this documentation listing the mandatory parameters as well as the other parameters which, if entered, would increase the speed of conversion.

Methods

Operation Method Code
Create 1

Request Parameters:

Parameters Required Description
User Id * User Id As provided By Cashcow.ai.
Password * Password As provided By Cashcow.ai.
Secret Key * Secret Key As provided By Cashcow.ai.
Function * Function Code ‘2’
Method * Method Code.
Loan Type * Loan Type Code
Loan Amount * Loan Amount
Loan Tenure * Loan Tenure in Months
Employment Type * Employment Type Eg 1: Salaried and 2: Self Employed
First Name * First Name
Middle Name (Optional) Middle Name
Last Name * Last Name
Gender * Gender Code
Date Of Birth * Date Of Birth (dd-mm-yyyy)
Email * Email
PAN Number * 10 Digit Alpha Numeric
Mobile * 10 Digit Numeric Value
Personal Address * Text
Personal Pincode * 6 Digit Number
Advisor Id * Advisor Id Provided by Cashcow

Request Parameters Data Defination:


Parameters Data Type Description
user_id String User Id As provided By Cashcow.ai.
password String Password As provided By Cashcow.ai.
secret_key String Secret Key As provided By Cashcow.ai.
function Number Function Code ‘2’
method Number Method Code.
loan_type Number Loan Type Code from Loan Type Tabel
loan_amount Number Loan Amount
loan_tenure Number Loan Tenure in Months
employment_type Number Employment Type Eg 1: Salaried and 2: Self Employed
first_name String First Name
middle_name String Middle Name
last_name String Last Name
lead_gender Number Gender Code
lead_dob Date Date Of Birth (dd-mm-yyyy)
lead_email String Email
lead_pan_number String 10 DIgit Alpha Numeric
lead_mobile Number 10 Digit Numeric
personal_address Text Text
lead_pincode Number 6 Digit Number
advisor_id Number Advisor Id Provided by Cashow

Request Example:

$data = array(
'user_id' => 'userid', //R
'password' => 'somepassword', //R
'secret_key' => 'somesecretkey', //R
'function' => '2', //R
'method' => '1', //R
'loan_type'=>'1', //R
'loan_amount'=>'100000', //R
'loan_tenure'=>'12', //R
'employment_type'=>'1', //R
'first_name'=>'abcd', //R
'middle_name'=>'dav', //OP
'last_name'=>'rst', //R
'lead_mobile'=>'1234567890', //R
'gender'=>'1', //R
'date_of_birth'=>'28-03-1993', //R
'email'=>'abc@demo.com', //R
'pan_number'=>'ABCDE1234A', //R
'address'=>'aadfdxffb gnx b', //R
'pincode'=>'400057', //R
'advisor_id'=>'XXXX' //R
);

Response Example:

{"status":"success" , "status_code":"1" , "msg":"Recode Inserted"}

Error Example:

{"status":"fail" , "status_code":"5" , "sub_status_code":"1" , "msg":"parameter mismatch"}

Loan Type Code:

Name Loan Type Code
Personal Loan 1
Business Lone 2
Home Lone 3
Loan Again Property 4
Credit Card 5
Balance Transfer 6
Car Loan 7
Gold Lone 8

Error Codes:

Error Parameters Description Status Codes Sub Error Codes status
Authentication Error Invalid Authentication Details 100 fail
Internal Error Server Error 2 fail
Function Invalid Function Code 3 fail
Method Invalid Method Code 4 fail
Product Type Loan Type Numeric code as given in Product Type Table 7 1 fail
Parameter Mismatch Error Loan Amount Numeric Values Only 7 2 fail
Parameter Mismatch Error Loan Tenure Numeric Values 7 3 fail
Parameter Mismatch Error First Name Non Numeric Values Only 7 4 fail
Parameter Mismatch Error Middle Name Non Numeric Values Only 7 5 fail
Parameter Mismatch Error Last Name Non Numeric Values Only 7 6 fail
Parameter Mismatch Error Mobile 10 Digit Numeric Value Example:9123456789 7 7 fail
Parameter Mismatch Error Gender Numeric Values Only(1:Male,2:Female and 3:Other) 7 8 fail
Parameter Mismatch Error Personal Pincode 6 Digit Numeric value Example:123456 7 9 fail
Parameter Mismatch Error PAN Number 10 Digit Alpha Numeric Value Example:DEMOA1234A 7 10 fail
Parameter Mismatch Error Date Of Birth Date in Given Format Only (dd-mm-yyyy) 7 11 fail
Parameter Mismatch Error Email Text Value 7 12 fail
Parameter Mismatch Error Personal Address Address cannot be empty or Such Small Address 7 13 fail
Parameter Mismatch Error Employment Type Numeric Values 1: Salaried and 2: Self Employed 7 14 fail
Parameter Mismatch Error Advisor Id Invalid Advisor Id 7 15 fail
Duplicate Entry Error Duplicate Entry Error 6 fail
Operation Success Operation Success 1 success

Lead Offline Documentation



Lead Dashboard

This is a dashboard through which the alliances can track the leads referred to us on a real time basis. The exact stage of the referred lead would be reflected on this dashboard.

Methods

Operation Method Code
View 1

Request Parameters:

Parameters Required Description
user_id * User Id As provided By Cashcow.ai.
password * Password As provided By Cashcow.ai.
secret_key * Secret Key As provided By Cashcow.ai.
function * Function Code ‘3’
method * Method Code ‘1’.

Request Parameters Data Defination:


Parameters Type Description
user_id Text User Id As provided By Cashcow.ai, without white space
password Text Password As provided By Cashcow.ai, without white space
secret_key Text Secret Key As provided By Cashcow.ai, without white space
function Int Function Code ‘3’
method Int Method Code ‘1’.

Request Example:

$data = array(
'user_id' => 'user',//Required
'password' => 'password', //Required
'secret_key' => 'hkdfksd53sf1df', //Required
'function' => '1', //Required
'method' => '1', //Required
);

Response Example:

[{
"advisor_name":"DEMO",
"advisor_number":"9999999999",
"lead_id":"3",
"product_type":"PL",
"product_value":"100000",
"creation_date":"22-01-2018",
"customer_name":"DEMO",
"customer_number":"1234567890",
"bank_name":"HDFC",
"pincode":"400067",
"state":"MAHARASHTRA",
"city":"MUMBAI",
"salary":"12310",
"pan_number":"BXXXX3323G",
"date_of_birth":"13-01-2018",
"lead_status":"Lead Refer"
}]

Error Example:

{"status":"fail" , "status_code":"8" , "msg":"No Record Found"}

Error Codes:

Error Parameters Description Status Codes Sub Error Codes status
Authentication Error Invalid Authentication Details 100 fail
Internal Error Server Error 2 fail
Function Invalid Function Code 3 fail
Method Invalid Method Code 4 fail
No Records No Record Found 8 fail

Lead Dashboard Offline Documentation



If you are looking out for Loan's API From Cashcow Please Contact.


Contact Us