Private & Confidential

Enterprise API Document

GetRetailerOnboardingLink

CustomerKycDetails API

Supermoney <> CSquare Integration

Page 1 | 8
Private & Confidential

Table of Contents
GetRetailerOnboardingLink API......................................................................................................................................................3

API Objective ..................................................................................................................................................................................... 3

Request Details.................................................................................................................................................................................3

Sample Request Body:................................................................................................................................................................... 3

Request Parameter Description .................................................................................................................................................3

Sample Response: ........................................................................................................................................................................... 4

Sample Response – Success........................................................................................................................................................4

Sample Response - Error ..............................................................................................................................................................4

Error Response 1 ........................................................................................................................................................................4

Error Response 2 ........................................................................................................................................................................ 4

Response Parameter Description: .............................................................................................................................................5

Error Codes ........................................................................................................................................................................................5

CustomerKycDetails API .................................................................................................................................................................... 6

API Objective ..................................................................................................................................................................................... 6

Request Details................................................................................................................................................................................. 6

Sample Request Body:................................................................................................................................................................... 6

Request Parameter Description .................................................................................................................................................7

Sample Response: ........................................................................................................................................................................... 7

Sample Response – Success........................................................................................................................................................7

Sample Response - Error ..............................................................................................................................................................7

Error Response 1 ........................................................................................................................................................................7

Response Parameter Description: .............................................................................................................................................8

Error Codes ........................................................................................................................................................................................8

Page 2 | 8
Private & Confidential

GetRetailerOnboardingLink API

API Objective
This RESTful API helps to get Retailer onboarding links.

Request Details

https://devenv.mintwalk.com/externalService/CSquare/getRetailerOnboardingLink/?retailer_code=ABC
DEV URL D&phone_number=9930722100&address=House no 1, Gali no 2, South Delhi, Delhi,
100036&onboarding_distributor_code=PQRS&pan_no=CEMPH1234R&gst_no=123434APCP34

HTTP Request
GET
Type

Content -Type application/json

Sample Request Body:

None

Request Parameter Description

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS

Need to provide
retailer_code Yes String 100
that Request
phone_number No String 100 Not compulsory
address No string 100 Not compulsory
onboarding_distributor_code No String 100 Not compulsory
pan_no No string 100 Not compulsory
gst_no No string 100 Not compulsory

Page 3 | 8
Private & Confidential

Sample Response:

Sample Response – Success

{
"onboarding_link":
"https://www.supermoney.in/MODev/#/?retailer_code=ABCD&phone_number=9930722100&address=House+no
+1%2C+Gali+no+2%2C+South+Delhi%2C+Delhi%2C+100036&onboarding_distributor_code=PQRS&pan_no=CE
MPH1234R&gst_no=123434APCP34&cp=CSQUARE&cn=CSQUARE",
"error_code": 200,
"error_description": ""
}

Sample Response - Error

Error Response 1

{
"onboarding_link": "",
"error_code": 400,
"error_description": "Bad Request, retailer code is required."
}

Error Response 2

{
"onboarding_link": "",
"error_code": 405,
"error_description": "POST is not allowed"
}

Page 4 | 8
Private & Confidential

Response Parameter Description:

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS

onboarding_link Yes String
Possible Values:
error_code Yes Integer
200,400, 405

Possible Values:
error_description No String Specified in Error
Codes Table

Error Codes

ERROR CODE ERROR DESCRIPTION

400 Bad request, retailer_code is required
500 Something went wrong, please try again later
405 POST is not allowed
200 success

Page 5 | 8
Private & Confidential

CustomerKycDetails API

API Objective
This RESTful API helps to store the retailer details.

Request Details

DEV URL https://devenv.mintwalk.com/kycServices/CustomerKycDetails/

HTTP Request
POST
Type

Content -Type application/json

Sample Request Body:

{
"data":[
{
"data":{
"gst_no":"APCPY123456789A",
"retailer_code":"R1234",
"distributor_code":"D1234",
"address":"chandiwali",
"name":"nagendra",
"pan_no":"APCPY3567P"
},
"source":"anchor"
}
],
"profile_id":"827494",
"kyc_verification_id":"61",
Request Parameter Description
"customer_id":"385413"
}

Page 6 | 8
Private & Confidential

Request Parameter Description

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS

gst_no No String 100 Need to provide that Request
retailer_code Yes String 100 Need to provide that Request
distributor_code Yes string 100 Need to provide that Request
address No String 100 Need to provide that Request
pan_no No string 100 Need to provide that Request
name Yes string 100 Need to provide that Request

Sample Response:

Sample Response – Success

{
"data": {},
"successFlag": true,
"errorDetails": {
"errorMessage": "",
"errorCode": 200
}

Sample Response - Error

Error Response 1

{
"data": {},
"successFlag": false,
"errorDetails": {
"errorMessage": "row not created",
"errorCode": 200
}

Page 7 | 8
Private & Confidential

Response Parameter Description:

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS

successFlag Yes Boolean Possible Values: true or false
error_code Yes Integer Possible Values: 200
Possible Values:
errorMessage Yes String • “row created successfully”
• "row not created"

Error Codes
ERROR CODE ERROR DESCRIPTION
200 success

Page 8 | 8