(for each field, there are some characters not accepted by iPay. See Bottom of page)Y = Yes N = No O = Optional
|Parameter Name||Data Type(Data Length)||Description||Channel|
|live||numeric(1)||LIVE or DEMO mode (1 or 0). “1” By Default (live)||Y||Y||Y|
|mpesa||numeric(1)||Display Mpesa Mobile Money Channel (on or off). “on” by Default (i.e. mpesa=1)||O||O||O|
|bonga||numeric(1)||Display Safaricom's Bonga Points Channel (on or off). “on” by Default (i.e. bonga=1)||O||O||O|
|airtel||numeric(1)||Display Airtel Mobile Money Channel (on or off). “on” by Default (i.e. airtel=1)||O||O||O|
|equity||numeric(1)||Display the Equity EazzyPay Channel (on or off). “on” by Default (i.e. equity=1)||O||O||O|
|mobilebanking||numeric(1)||Display the Mobile Banking Channel (on or off). “off” by Default (i.e. mobilebanking=0)||O||O||O|
|debitcard||numeric(1)||Display the Debit Card Channel (on or off). “off” by Default (i.e. debitcard=0)||O||O||O|
|creditcard||numeric(1)||Display the Credit Card Channel (on or off). “off” by Default (i.e. creditcard=1)||O||O||O|
|mkoporahisi||numeric(1)||Display Mkopo Rahisi Channel (on or off). “off” by Default(i.e. mkoporahisi=0)||O||O||O|
|saida||numeric(1)||Display Saida Channel (on or off). “off” by Default (i.e. saida=0)||O||O||O|
|autopay NEW||numeric(1)||Push Data (on or off). “off” by Default (i.e. autopay=0) Set this parameter to 1 if you want iPay to silently trigger the callback. The CONFIRM button on the checkout page will not be present for mobile money and mobile banking NOTE Valid Callback Parameter must be provided. when this parameter is set iPay will send data to your server using GET request and the IPN should be run to verify this data.||O||O||O|
|oid||alphanumeric (34)||Order ID||Y||Y||Y|
|inv||alphanumeric (15)||Invoice Number (Set to Order ID value above if NULL)||Y||Y||Y|
|ttl||numeric (15)||Total amount (DO NOT PASS any commas as a thousands separator). e.g. ttl=1234.00 and NOT ttl=1,234.00||Y||Y||Y|
|tel||alphanumeric (15)||Customer Telephone number||Y||Y||Y|
|eml||alphanumeric (30)||Customer Email Address||Y||Y||Y|
|vid||alphanumeric (12)||Vendor ID assigned by iPay. SET IN LOWER CASE||Y||Y||Y|
|curr||alphanumeric (3)||Currency Type (USD or KES) * KES By Default||N||N||Y|
|p1||alphanumeric (15)||Optional field. allows sending & receiving your custom parameters||O||O||O|
|p2||alphanumeric (15)||Optional field. allows sending & receiving your custom parameters||O||O||O|
|p3||alphanumeric (15)||Optional field. allows sending & receiving your custom||O||O||O|
|p4||alphanumeric (15)||Optional field. allows sending & receiving your custom parameters||O||O||O|
|cbk||alphanumeric (100)||This parameter holds the value of the URL on your server to which iPay
will send back payment processing data to.
Please note that the call back URL parameter is ONLY required if the cURL parameter (crl) is set to zero (0), meaning that you want a browser redirect back to your website.
|lbk||alphanumeric (100)||In the event that the client cannot check out successfully, iPay will return the customer to our gateway. This parameter holds the value of the URL on your server to which the customer will be able to voluntarily use to link back to your website. If there is no value provided, then by default, (if this link is clicked) the customer will be redirected back to the previous page on your website.||O||O||O|
|cst||numeric (1)||The customer email notification flag of value 1 or 0. (Set to “1” By Default to allow customer to receive txn notifications from iPay for online txns)||Y||Y||Y|
|crl||numeric (1)||Name of the cURL flag input field (1 character).
|hsh||alphanumeric (64)||The computed iPay Hash Code||Y||Y||Y|
The following characters are NOT ALLOWED as part of your incoming parameters:
The variables p1, p2, p3 and p4 are used by you if you want to pass certain variables into the iPay system and receive them back intact on your end for your own personal reasons. They are not processed in any way. The mc variable is used to notify you of the actual mobile money transferred by the user.