Request Body Parameters
Parameters | Parameter description (with examples) | Data type | Mandatory/Optional |
batch_id | Batch ID. E.g. -1130008 |
String | Optional |
vendor_id | Vendor ID. E.g. - iserveu |
string | Optional |
vendor_id | Vendor ID. E.g. - iserveu |
string | Optional |
vendorData | Vendor Data | Optional | |
channel | Channel. E.g. - api |
string | Optional |
request_id | Request ID. E.g. - QR_00911_270122_6633188 |
string | Mandatory |
branch_code | Branch Code. E.g. - DP001 |
string | Optional |
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 | Optional |
state | State. E.g. - Maharashtra |
string | Optional |
mcc | Merchant Category Code. E.g. - 0743 |
string | Optional |
Vpa_id | Virtual Payment Address ID. E.g. - 6633188@cnrb |
string | Mandatory |
requested_on | Requested Date. E.g. - 2023-01-21 19:30:13 |
string | Optional |
qr_string | QR String. E.g. - upi://pay? pa=testmerchant_27@ab c&pn=TestMerchant_270 1_0001& mc=0743& tr=1234567887654321& tn=Pay to Merchant&am=0&mam= 0& cu=INR& refUrl=http://npci.org/ upi6633188/schema/ |
string | Optional |
bank_name | Bank Name. E.g. - ABC Bank |
string | Optional |
checksum | Check Sum. E.g. - 84c3e9c22f4a5f20434cf b373dcc8971f85c03dfd 9 4c95989990e58eb4073a 629f38 853d452211badb5482bf b 1da5102bfcc3050a6ae7 e7f0a33bcb11bbcb81b |
string | Optional |
Sample Request Body
Encrypted 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. - 84c3e9c22f4a5f20434cfb373dcc8971f85c03dfd9 4c95989990e58eb4073a629f38 853d452211badb5482bfb 1da5102bfcc3050a6ae7e7f0a33bcb11bbcb81b |
string |
ErrorMessage | Error Message (Only for Failed Responses). E.g. - Checksum mismatch. Aborting onboarding. |
String |
Sample Response Body
SUCCESS:
Encrypted Sample Response Body(SUCCESS)
FAILED:
IF VPA_ID,REQUEST_ID, QR_STRING is duplicate:
IF Checksum is mismatched:
Encrypted Sample Response Body(FAILED)