Skip to content
oabdoun edited this page Dec 4, 2014 · 6 revisions

Payment Bill

A bill is a JSON or JavaScript objects that contains data about your order (or transaction), your customer, as well as processing related information. It has the following format

{
	"merchantTxnId": "ORDER_846BCE",
	"amount": {
		"currency": "INR",
		"value": "256.32"
	},
	"returnUrl": "https://www.example.com/payment_response/citrus",
	"merchantAccessKey": "LY80PJEZK5TDFWKATHTL",
	"requestSignature": "19157bfd6eb14e50c2522631eb2dd9f978ecdb90",
		
	"userDetails": {
		"firstName": "Chhota",
		"lastName": "Bheem",
		"email": "[email protected]",
		"mobileNo": "8844662200",
		"address": {
			"street1": "Laddoo House",
			"street2": "Main Road",
			"city": "Dholakpur",
			"zip": "100024",
			"state": "Dholakpur",
			"country": "India"
		}
	},
	
	"customParameters": {
		"paramOne": "one value",
		"secundo": "online"
	}
}

where

  • merchantTxnId is your order (or transaction) identifier
  • amount.currency must be "INR"
  • amount.value is the amount of your order (or transaction); format must be identical to the one passed to signature algorithm on your server (i.e. if you have generated signature with amount equals to "1", then amount.value must be "1"; if you have generated signature with amount equals to "1.00", then amount.value must be "1.00")
  • returnUrl the URL to which CitrusPay payment gateway will have the customer's browser POST the result of the payment processing when complete; we advise to use a HTTPS URL
  • merchantAccessKey is your "merchant access key"
  • requestSignature is the request signature generated on your server
  • userDetails is self explaining ;)
  • customParameters is a map of key / value pairs that you define; to receive these parameters back in payment response, you must configure them in your CitrusPay admin-panel
Clone this wiki locally