API (Paul Merchants Ltd.
Document Title:
APIs for Paul Merchants Ltd.
Document Purpose:
To exchange data between Innerx platform and Paul Merchants Ltd.
Document Version:
Version 1.00
Document Release Date:
12th Sep 2024
Version History
Sr. No. Version Date Macro Change Description
1 1.00 12th Sep 2024 NA
Index
Sr. No. API End Point Description Page No.
1 PayMyTuitionOrder API to create order 2-3
2 PmtDocumentdetails Api create for upload document 5
3 PmtfundConfirmation Api create for fund confirmation 6
4 Cancelorder Api create for order cancellation 7
…………………………….
Page | 1
API (Paul Merchants Ltd.)
Response Formats
All endpoints return responses in JSON format.
[Link]
UAT URI: [Link]
a. Request Data:
{
"OrderID": "19",
"PortalKey": "Pml",
"PaymentInformation": {
"Country": "INDIA",
"Currency": "USD",
"Rate": "6",
"Amount": "4500",
"TotalfxAmount": "4500",
"TotalAmount": "4500",
"Taxableamount": "100",
"INRamount": "4700",
"PurposeData": [
{
"Purpose": "Tuition",
"Amount": "500"
},
{
"Purpose": "BookFees",
"Amount": "500"
}
]
},
"Payerinformation": {
"EmailID": "abc@[Link]",
"FirstName": "xyz",
"LastName": "xyz",
"Address1": "kandivali",
"Address2": "kandivali",
"State": "MAHARASHTRA",
"City": "MUMBAI",
"ZIPCode": "400101",
"PhoneNumber": "8888888888",
"Identificationtype": "passport",
"Expirationdate": "18-feb-2025",
"Identificationnumber": "0001",
…………………………….
Page | 2
API (Paul Merchants Ltd.)
"Identificationofpayer": "passport",
"Expirationdateofpayer": "15-mar-2025",
"Identificationnumberofpayer": "001",
"PayerPANnumber": "AWSPL2343D",
"Paidby": "self/other",
"Relationshipwithstudent": "parent",
"Relativename": "xyz",
},
"Studentinformation": {
"ApplicationID": "003",
"Emailaddress": "xyz@[Link]",
"FirstnameStudent": "xyz",
"LastnameStudent": "xyz",
"eMerchantnumber": "mer001"
}
}
Highlighted fields are optional
…………………………….
Page | 3
API (Paul Merchants Ltd.)
b. Response Data:
{
"VirtualAccountNo": "",
"VirtualAccountIFSC": "",
"BankName": "",
"AccountName": "",
"PmlRefNo": "12",
"GSTAmount": "180.000000",
"NostroCharge": "1000.000000",
"TCSAmount": "0.000000",
"TotalAmount": "180.000000",
"strMsg": "Staging data accepted with Staging ID: 12",
"strCode": "200"
}
…………………………….
Page | 4
API (Paul Merchants Ltd.)
2. PmtDocumentdetail
UAT URI: [Link]
a. Request Data:
{
"OrderID": "1",
"PortalKey": "Pml",
"DocumentList": [
{
"SchoolinvoiceDocumentType": "pdf",
"SchoolinvoiceDocument": "base64<string>",
"PayeridentificationDocumentType": "pdf",
"PayeridentificationDocument": "base64<string>",
"StudentidentificationDocumentType": "pdf",
"StudentidentificationDocument": "base64<string>",
"PANCardDocumentType": "pdf",
"PANCardDocument": "base64<string>"
}
]
}
b. Response Data:
{
"MSG": "Document create successfully",
"Code": "200"
}
…………………………….
Page | 5
API (Paul Merchants Ltd.)
3. PmtfundConfirmation
a. Request Data:
{
"Amount": 1000,
"VirtualNo": "VIRT123",
"PayType": "Credit",
"UniqRefNo": "REF123456789",
"BeneficiaryName": "John Doe",
"BeneficiaryIFSC": "IFSC001",
"BeneficiaryAccount": "ACC001"
}
b. Response Data:
"MSG": “successfully getting fund from pmt",
"Code": "200"
…………………………….
Page | 6
API (Paul Merchants Ltd.)
4. CancelOrder
UAT URI: [Link]
a. Request Data:
{
"OrderID": "1",
"PortalKey": "Pml"
}
b. Response Data:
[
{
"Code": 200,
"msg": "Your Order Cancel successfully"
}
]
…………………………….
Page | 7
