Shield Create

BCFI – Business Correspondent Federation of India has issued a list of entities who have been blacklisted by banks or have criminal records for forgery, murder etc. Shield create is used to add a new entity to the list who has been identified for doing malpractices with all the available details.

POST

https://kraken.airpay.co.in/airpay/ms/shield/api/create

Header

Field	Type	Description
content-type	String	application/json (required)
affiliate	Text	Will be provided by Airpay (required)
checksum	Text	$string = $param.self+ $header.code::$secret_key; sha256(<concate all values+SECRET KEY>); (required)
code	Text	Will be provided by airpay ( required)
processor-key	Text	Will be provided by airpay ( required)

Parameter

Field	Type	Required	Description
agent_name	Text	Yes	Name of the agent (length 3-70)
corporate_bc_name	Text	Yes	Corporate name for the agent (length 3-70)
mobile_no	Text	Yes	Mobile Number (length 10)
city	Text	Yes	Name of the city (length 1-70)
state	Text	No	Name of the state (length 1-70)
address	Text	Yes	Address (length 225)
pin_code	Text	No	Pincode (length 6)
aadhaar_no	Text	No	Aadhaar Number (length 4, last four digits only)
pan_no	Text	Yes	PAN card Number (length 10)
blacklisted_date	Text	No	Blacklisted date in dd-mm-yyyy format
blacklisted_reason	Text	Yes	Reason for blacklisted (length 100)
bank	Text	No	Bank name (length 100)
ifsc	Text	No	Bank IFSC code (length 15)
account_no	Text	No	Account Number (length 20)
is_police_complaint	Text	Yes	Police complaint flag. Accepted values: Y / N
complaint_no	Text	Yes*	Complaint Number (length 70). Required only if is_police_complaint is Y.
complaint_date	Date	Yes*	Complaint date in dd-mm-yyyy format. Required only if is_police_complaint is Y.
arrested	Text	No	Arrested status. Accepted values: Y / N

Request-Example:

 curl --location --request POST 'https://kraken.airpay.co.in/airpay/ms/shield/api/create' \
--header 'code: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \
--header 'affiliate: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \
--header 'checksum: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \
--header 'processor-key: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'agent_name=Arsen' \
--data-urlencode 'corporate_bc_name=corpa lithin' \
--data-urlencode 'mobile_no=9XXXXXX989' \
--data-urlencode 'city=Mumbai' \
--data-urlencode 'state=Maharashtra' \
--data-urlencode 'address=drsd' \
--data-urlencode 'aadhaar_no=0101' \
--data-urlencode 'blacklisted_reason=test reason' \
--data-urlencode 'bank=HDFC' \
--data-urlencode 'ifsc=HDFCBK002123' \
--data-urlencode 'account_no=xsdf123123' \
--data-urlencode 'is_police_complaint=Y' \
--data-urlencode 'complaint_no=123123D' \
--data-urlencode 'complaint_date=12-12-2022' \
--data-urlencode 'arrested=N'

Success 200

Field	Type	Description
status	Numeric	400- fail,200-success(length 3)
message	Text	success, fail
data	Text	Json response { “status”: status code, “message”: response message, “data”:[ {“parameter”:“array required data”}] }

Success-Response:

{
    "status": 200,
    "message": "Success",
    "data": {
        "message": "Merchant Added Successfully.",
        "merchant_id": 23
    },
    "checksum": "91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps"
}

Error-Response:

{
    "status": "400",
    "message": "Failed",
    "data": ""
}