| Parameter Name | Data Type (Data Length) | Description | Channel | ||
| Mobile | Kenswitch | Credit Card | |||
| live | numeric (1) | LIVE or DEMO mode (1 or 0). “1” By Default (live) |
Y | Y | Y |
| mm | numeric (1) | Display the Mobile Money Channel (on or off). “on” by Default ( i.e. mm=1 ) |
Y | Y | Y |
| mb | numeric (1) | Display the Mobile Banking Channel (on or off). “on” by Default ( i.e. mb=1 ) |
Y | Y | Y |
| dc | numeric (1) | Display the Debit Card Channel (on or off). “on” by Default ( i.e. dc=1 ) |
Y | Y | Y |
| cc | numeric (1) | Display the Credit Card Channel (on or off). “on” by Default ( i.e. cc=1 ) |
Y | Y | Y |
| mer | alphanumeric | Merchant Name | Y | Y | Y |
| oid | alphanumeric (12) | 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) | V endor ID assigned by iPay. SET IN LOWER CASE |
Y | Y | Y |
| cur | 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 parameters |
O | O | O |
| p4 | alphanumeric (15) | Optional field. allows sending & receiving your custom parameters |
O | O | O |
| cbk | alphanumeric (100) | Holds the value of the URL on your server that iPay will communicate / call back to |
Y | Y | Y |
| 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). The value is 2, 1 or 0 to specify that you want to pick call back values as a data stream. ( Set to “0” By Default ) |
O | O | O |
| 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 you need to pick via the call back URL and returned through a GET call are: status, id and ivm, and special browser-dependent variables qwh, afd, poi, uyt, ifd, agt. These variables are very important especially when you need to re-validate the transaction as shown on page 6 The extra 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.