Private & Confidential

Enterprise API Document

GetCustomerStatus

Supermoney <> CSquare Integration

Page 1|7
Private & Confidential

Table of Contents

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

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

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

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

Sample Response:...................................................................................................................................... 3

Sample Response – Success ...................................................................................................................... 3

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

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

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

Error Response 3 ................................................................................................................................... 4

Error Response 4 ................................................................................................................................... 5

Error Response 5 ................................................................................................................................... 5

Error Response 6 ................................................................................................................................... 5

Error Response 7 ................................................................................................................................... 6

Error Response 8 ................................................................................................................................... 6

Response Parameter Description: .............................................................................................................. 7

Error Codes ................................................................................................................................................ 7

Page 2|7
Private & Confidential

API Objective

This RESTful API helps to get Retailer and Distributor onboarding status with their total and unutilized
limit amount.

Request Details

https://devenv.mintwalk.com/externalService/CSquare/getCustomerStatus/?retailer_code=1234&distri
DEV URL
buter_code=1234

HTTP Request
GET
Type

Content -Type application/json

Sample Request Body:

None

Request Parameter Description

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS
retailer_code Yes String 100 Need to provide
that Request
distributer_code Yes String 100 Need to provide
that Request

Sample Response:

Sample Response – Success

{
"retailer_code":"1234",
"distributor_code":"1234",
"total_limit":20000.0,
"unutilised_limit":10000.0,
"retailer_status":"ACTIVE",
"distributor_status":"APPROVED",
"error_code":200,
"error_description":""
}

Page 3|7
Private & Confidential

Sample Response - Error

Error Response 1

{
"retailer_code": "1234",
"distributor_code": "1234",
"total_limit": 0,
"unutilised_limit": 0,
"retailer_status": "NOT_ONBOARDED",
"distributor_status": "",
"error_code": 302,
"error_description": "Retailer not onboarded"
}

Error Response 2

{
"retailer_code": "1234",
"distributor_code": "123",
"total_limit": 0,
"unutilised_limit": 0,
"retailer_status": "",
"distributor_status": "NOT_ONBOARDED",
"error_code": 301,
"error_description": "Distributor not onboarded"
}

Error Response 3

{
"retailer_code": "",
"distributor_code": "",
"total_limit": 0,
"unutilised_limit": 0,
"retailer_status": "",
"distributor_status": "",
"error_code": 400,
"error_description": "Bad request, retailer_code is required."
}

Page 4|7
Private & Confidential

Error Response 4

{
"retailer_code": "1234",
"distributor_code": "1234",
"total_limit": 0,
"unutilised_limit": 0,
"retailer_status": "",
"distributor_status": "REJECT",
"error_code": 308,
"error_description": "Distributer rejected"
}

Error Response 5

{
"retailer_code":"1234",
"distributor_code":"1234",
"total_limit":0,
"unutilised_limit":0,
"retailer_status":"NOT_ACTIVE",
"distributor_status":"",
"error_code":304,
"error_description":"Retailer KYC pending"
}

Error Response 6

{
"retailer_code":"1234",
"distributor_code":"1234",
"total_limit":20000,
"unutilised_limit":10000.0,
"retailer_status":"ACTIVE",
"distributor_status":"APPROVED",
"error_code":200,
"error_description":""
}

Page 5|7
Private & Confidential

Error Response 7

{
"retailer_code":"1234",
"distributor_code":"1234",
"total_limit":0,
"unutilised_limit":0,
"retailer_status":"",
"distributor_status":"AWAITING_APPROVAL",
"error_code":303,
"error_description":"Distributor bank verification pending"
}

Error Response 8

{
"retailer_code": "",
"distributor_code": "",
"total_limit": 0,
"unutilised_limit": 0,
"retailer_status": "",
"distributor_status": "",
"error_code": 405,
"error_description": " Method not allowed "
}

Page 6|7
Private & Confidential

Response Parameter Description:

FIELD NAME MANDATORY DATA TYPE LENGTH REMARKS

retailer_code Yes String
distributor_code Yes String
total_limit Yes Decimal
unutilised_limit Yes Decimal
Possible Values:
retailer_status Yes String NOT_ONBOARDED,
NOT_ACTIVE, ACTIVE, REJECT
Possible Values:
NOT_ONBOARDED,
distributor_status Yes String
AWAITING_APPROVAL,
APPROVED, REJECT
Possible Values:
error_code No Integer 301,302,303,304,305,306,307,308,
309, 400, 500, 405, 200
Possible Values: Written in
error_description No String ERROR DESCRIPTION column on
Error Code Table

Error Codes

ERROR CODE ERROR DESCRIPTION

301 Distributor not onboarded
302 Retailer not onboarded
303 Distributor bank verification pending
304 Retailer KYC pending
305 Retailer account temporarily deactivated
306 Distributor account temporarily deactivated
307 Finance limit exceeded, Ask for upgrade
308 Distributer rejected
309 Retailer rejected
400 Bad request, retailer_code is required
500 Something went wrong, please try again later
405 Method not allowed
200 success

Page 7|7