Request Method :: POST
Description -
This API is used to onboard the merchant with the requirement parameters given below.
URL: To be shared later.

 

Request Body Parameters

Parameters Parameter description (with examples) Data Type Mandatory/Optional
batch_id Batch ID.
E.g. -1130008		 String Mandatory
vendor_id Vendor ID.
E.g. - iserveu		 String Mandatory
vendorData Vendor Data   Mandatory
channel Channel.
E.g. - api		 String Mandatory
request_id Request ID.
E.g. - QR_00911_270122_6633188		 String Mandatory
branch_code Branch Code.
E.g. - DP001		 String Mandatory
merchant_name Merchant Name.
E.g. - Bijayini Dalai		 String Mandatory
merchant_delivery_address Merchant Delivery Address.
E.g. - sum		 String Mandatory
merchant_delivery_pincode Merchant Delivery Pincode.
E.g. - 751003		 String Mandatory
merchant_mobile Merchant Mobile.
E.g. - 9878000001		 String Mandatory
merchant_email Merchant Email.
E.g. - [email protected]		 String Mandatory
state State.
E.g. - Maharashtra		 String Mandatory
mcc Merchant Category Code.
E.g. - 0743		 String Mandatory
Vpa_id Virtual Payment Address ID.
E.g. - 6633188@abc		 String Mandatory
requested_on Requested Date.
E.g. - 2023-01-21 19:30:13		 String Mandatory
qr_string QR String.
E.g. - upi://pay? pa=testmerchant_27@abc&pn=TestMerchant_2701_0001&
mc=0743& tr=1234567887654321&
tn=Pay to Merchant&am=0&mam=0& cu=INR&
refUrl=http://npci.org/upi6633188/schema/		 String Mandatory
bank_name Bank Name.
E.g. - ABC Bank		 String Mandatory
checksum Check Sum.
E.g. - 84c3e9c22f4a5f20434cfb373dcc8971f85c03dfd9
4c95989990e58eb4073a629f38 853d452211badb5482bfb
1da5102bfcc3050a6ae7e7f0a33bcb11bbcb81b		 String Mandatory

 

Sample Request Body

Response Body Parameters

Parameters Parameter description(with examples) Data Type
batch_id Batch ID.
E.g. - 1130008		 Integer
vendor_id Vendor ID.
E.g. - iserveu		 String
statuscode Status Code.
E.g. - 200		 String
status Status.
E.g. - Success		 String
message Message.
E.g. - 1 record out of 1 successfully captured.		 String
vendorData Vendor Data. String
Message Message.
E.g. - success		 String
request_id Request ID.
E.g. - QR_00911_270122_6633188		 String
serial_number Serial Number.
E.g. - xbAg1DRtsBsVgYJCBTIdaSqTz93r4X		 String
Merchant ID Merchant ID.
E.g. - ABC000000012		 String
vpa_id VPA ID.
E.g. - 6633188@abc		 String
checksum Checksum.
E.g. -		 String
ErrorMessage Error Message (Only for Failed Responses).
E.g. -		 String

 

Sample Response Body
Success

{
"batch_id": "1130008",
"vendor_id": "iserveu",
"statuscode": 200,
"status": "Success",
"message": "1 record out of 1 successfully captured.",
"vendorData": [
{
"Message": "success",
"request_id": "QR_00911_270122_6633188",
"serial_number": "xbAg1DRtsBsVgYJCBTIdaSqTz93r4X",
"Merchant ID": "ABC000000012",
"vpa_id": "6633188@abc"
}
],
"checksum":"84c3e9c22f4a5f20434cfb373dcc8971f85c03dfd94c95989990e58eb4073a629f38
853d4
52211badb5482bfb1da5102bfcc3050a6ae7e7f0a33bcb11bbcb81b"
}

FAILED

{
"batch_id": "1130008",
"vendor_id": "iserveu",
"statuscode": 200,
"status": "Success",
"message": "0 record out of 1 successfully captured.",
"vendorData_resp": [
{
}
"Message": "failed",
"request_id": "QR_00911_270122_6633188",
"ErrorMessage": "Record with VPA_ID 00553312@abc, Request_ID
QR_00911_270122_6633188, or
QR_String upi://pay?
pa=testmerchant_27@abc&pn=TestMerchant_2701_0001&mc=0743&tr=1234567887654321
&tn=Pay
to Merchant&am=0&mam=0&cu=INR&refUrl=http://npci.org/upi00553312/schema/ already
exists"
],
"checksum":"84c3e9c22f4a5f20434cfb373dcc8971f85c03dfd94c95989990e58eb4073a629f38
853d452211badb5482bfb1da5102bfcc3050a6ae7e7f0a33bcb11bbcb81b"
} 

Error Codes

Errors Status Code
Validation Error 403 with validation message
Decryption Error 406 with message
Encryption Error 200 with message