Invoice API Specifications

Introduction

We created a complete and detailed description of the Platform API. Here you can find all parameter descriptions.

Hosts

Test:
Live:

Security / Authentication

All requests must be sent over SSL (Secure Socket Layer).

You need to generate an Authentication token to authenticate your request. Authentication parameters needs to be send in the header with each request. To generate authentication token please refer Auth token API.

Member ID and checksum can also be required in some cases. Please refer specific APIs for more details.

Authentication parameters need to be pass as POST parameters. You can find more details about these parameters in Authentication parameters.

Basic Payment

This reference list lists all the standard flow parameters to be send in request.

Parameter	Description	Format	Required
amount	Transaction request amount. Decimal format needs to be followed	N13 [0-9]{1,10}\.[0-9]{2}	Yes
currency	Transaction request currency	A3 [a-zA-Z]{3}	Yes
paymentBrand	It specifies the brand type of payment for the request	AN32 [a-zA-Z0-9] {1,32}	Yes
paymentMode	It specifies the mode of payment for the request	AN32 [a-zA-Z0-9] {1,32}	Yes
merchantInvoiceId	It specifies the ID of created merchant's invoice	N10 [0-9]	Conditional
cancelReason	It specifies the reason for cancelling invoice	AN50 [A-Za-z0-9]	Yes
orderDescription	It takes description of the order placed by customer	AN255	Yes
invoiceId	This reference number is provided by the merchant, When he wants to cancel, regenerate the invoice	[0-9]	Yes
merchantRedirectUrl	This URL will receive the result of an asynchronous payment. It must be sent URL encoded.	AN2048 ([htpfs]{3,5}\\:?\\/\\/[\\w\\.\\:\\/]\\??[a-zA-Z0-9])	Yes

Authentication

Authentication data is required in all requests. You can find a set of valid credentials in the tutorials. But if you want to set up another credential for your terminal please contact us.

Parameter	Description	Format	Required
authentication.memberId	Merchant's unique ID assigned by to authenticate a transaction request	N10 [0-9]	Yes
authentication.checksum	Cryptographic hash generated by MD5 as follows. All the processes has different combination of parameters to generate hash (all values separated by pipe). Kindly refer sample given in tutorial for each case	AN255 [a-zA-Z0-9]	Yes
authentication.terminalId	Merchant's terminal ID provided by	N4 [0-9]	No

Merchant

Merchant data is required if Invoice funcationality is used by Merchant user.

Parameter	Description	Format	Required
merchant. username	Merchant’s username credential	AN50 [a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-\|\]{space}	No

Request Parameters

All the information about the customer like his name, contact details and identification documents are hold by the customer object.

Parameter	Description	Format	Required
customer.givenName	Name of the customer	AN [a-zA-Z0-9\\p{Space}\\,.:'"-=+)({}[]]+	No
customer.phone	Phone number of the customer	AN25 [a-zA-Z0-9\+-.]{6,25}	No
customer.telnocc	Telephonic country code of the customer	N4 [0-9]{1,4}	No
customer.email	Email address of the customer	AN [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}	No
customer.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]?)	No
customer.street	Building name, and/or street name of the customer's address	AN1000 [a-zA-Z0-9\\p{Space}\\,]+	Conditional
customer.city	City of the customer's address	AN50 [a-zA-Z0-9\\\\#&\\p{Space}\\p{L}\\p{M}\\-;.,~` ]{0,1000}	Conditional
customer.state	State or region of the customer's address	AN50 [\\ra-zA-Z0-9\\\\!@#$*%^&{}\\[\\]()_+\\p{L}\\p{M}\\-=,.~'` ]{0,1000}	Conditional
customer.postcode	Zip code of the customer's address	AN10 [A-Za-z0-9]{1,10}	Conditional
customer.country	Country of the customer's address	AN3 [a-zA-Z0-9]{2,3}	Conditional
initial	Initial appended for every transaction id.	A2 [A-Z]{2}	Conditional
invoiceExpirationPeriod	Set invoice expiry in days.	N3 [0-9]{3}	Conditional
gst	Set GST for invoice.	N [0-9]{2,3}	Conditional
actionType	Get or post	AN3 [a-zA-Z0-9]{2,3}	Conditional
pagination	According to pagination you will get the invoice list.	N [0-9]	Conditional

Response Parameters

Parameter	Description	Format	Required
invoiceId	It is necessary to identify the invoice request later. Later you can use this value as invoice ID.	N10 [0-9]	Yes
amount	Amount of the request	N13 [0-9]{1,10}\.[0-9]{2}	Conditional
currency	Currency of the request	A3 [a-zA-Z\\p{Space}\\,]+	Conditional
result.code	The unique response code that indicates the response status of the request. See the Response codes for more detailed information	AN11 [0-9\.]{2,11}	Yes
result.description	Response description of the response code	AN255 [a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+	No
merchantTransactionId	Unique transaction id which merchant gave while inquiring invoice	AN255 [a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+	Yes
descriptor	Descriptor of the invoice	AN255 [a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+	Yes
email	Email address of the customer	AN255 Email format	No
Other	The response can also contain each of the resources listed above, such as `customer` and `shipping address`	n/a	Conditional
timestamp	Shows at what time the transaction has been placed	date yyyy-MM-dd hh:mm:ss	Yes
statusInvoiceResult	Shows at what time the transaction has been placed	date yyyy-MM-dd hh:mm:ss	Yes
merchantOrderDescription	Shows description of Merchant order.	A255	Conditional
transactionStatus	It will give transaction status on basis of failed or success.	A255	Yes
dtstamp	It will show invoice creation time.	date yyyy-MM-dd hh:mm:ss	Yes
systemInvoiceId	It will give unique invoice id.	N10 [0-9]	Yes
invoiceStatus	It will show the invoice status such as generated, regenerated, expire etc.	A255 [a-zA-Z]	Yes