API Specification



Request Parameter

Parameter Description Format Required
walletOwnerId Patner Id of the merchant AN[a-zA-Z0-9] Yes
merchantEmail Email address of the customer. AN[a-zA-Z0-9] Yes
toTelnocc Country code of the merchant. AN[0-9] Optional
toMobile Mobile number of the merchant AN[0-9] Optional
merchantTransactionId This reference number is provided by the merchant, should be unique for the transactions and is visible on the end customer’s statement. AN100[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,100} Yes
amount Amount of the transaction. AN[0-9] Yes
fromCurrencyCode Currency of the transaction. A3[0-9]{3} Yes
consumerId Student ID N20[0-9] Yes
consumerName Name of the student A255 Yes
consumerCountry Country of Student AN2[a-zA-Z0-9]{2,1000} Yes
telnocc Country code of the customer AN[0-9] Optional
fromMobile Mobile number of the cutomer AN[0-9] Optional
customerEmail Email address of the customer. AN[a-zA-Z0-9] Yes
description Description of the payment string Yes
merchantRedirectUrl Redirect url where the customer to be redirected after processing. Redirect URL provided in request will redirect customer on merchant's website. AN2048([htpfs]{3,5}\\:?\\/\\/[\\w\\.\\:\\/]*\\??[a-zA-Z0-9]*) Yes
notificationUrl This URL will receive the asynchronous notification where applicable.This URL must be sent URL encoded. AN2048([htpfs]{3,5}\\:?\\/\\/[\\w\\.\\:\\/]*\\??[a-zA-Z0-9]*) Yes
ip IP address of the customer. AN255(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) Yes
verificationHash The text/data included when generating the hash String Yes
invoiceDetails List of invoice objects containing detailed billing information. Array Yes
invoiceDetails.ref Unique reference number of the invoice. String Yes
invoiceDetails.description Description of the invoice item (e.g., Exam, Tuition Fee). String Yes
invoiceDetails.date Invoice creation date in YYYY-MM-DD format. Date Yes
invoiceDetails.due_date Due date for the invoice payment in YYYY-MM-DD format. Date Yes
invoiceDetails.original_amount Total original amount of the invoice before any payments. String (Decimal) Yes
invoiceDetails.balance Remaining unpaid balance of the invoice. String (Decimal) Yes

Response Parameter

Response Code Message
1 Success
2 Fail
3 Invalid Verification Hash
40 Invalid Amount
33 Invalid Wallet Owner Id
19 Invalid Currency
20 Account Not Exists
65 Your transaction is already being processed, please use unique merchantTransactionID.
54 This Functionality is not supported. Please contact support for more details.