HTML Form Integration¶
Input parameters¶
No. | Field Name | Description | Required | Data type | Example |
---|---|---|---|---|---|
1 | merchant_name | Merchant name | Yes | 1-100 characters | Demo Shop |
2 | Merchant | Merchant username | Yes | 1-50 Characters | sales@demoshop.com |
3 | Custom | Merchant defined feild | Yes | 1-25 characters | C0000001 |
4 | order_id | Unique transaction ID if the order | Yes | 1-25 characters | AT000001 |
5 | Amount | The total amount the buyer needs to pay | Yes | Float | 23.45 |
6 | item_name | Name of Item | Yes | 1-250 characters | Call Credit |
7 | item_price | Price per item | Yes | float | 2.50 |
8 | currency_code | 3 letter code of the currency of the amountbased on ISO 4217 | Yes | 3 Characters | USD |
9 | Quantity | The number of items | Yes | int | 1 |
10 | mage_url | Merchants logo image to show during payment. | No | 1-250 Characters | https://www.flocash.com/wp-content/themes/flocash/images/logo.png |
11 | return_url | The return URL is where buyers will automatically redirected to or invited to go to by clicking a link afte rsuccessful payment. | No | 1-250 characters | |
12 | cancel_url | The cancel URL is the page to which FloCash redirects buyers browser if the buyer does not approve the payment. | No | 1-250 character | |
13 | flo_user_XYZ |
flo_user_cabin, flo_user_origincount ry... |
No | 1-250 character | |
14 | Country | 2-letter country co de ISO 3166-1 alph a-2 | No | 2 characters | KE |
15 | user_firstName | First name of customer | No | 1-250 characters | John |
16 | user_lastName | Last name of Customer |
No | 1-250 characters | Smith |
17 | user_address | Customer Address | No | 1-250 characters | |
18 | user_city | City of Customer | No | 1-250 characters | |
19 | user_state | State of Customer | No | 2 characters | |
20 | user_postalCode | Postal code of customer | No | 1-250 characte rs | |
21 | user_email | Customer e-mail | No | 1-250 characte rs | |
22 | user_mobile | Customer mobile number | No | 1-250 character |
Example of html form
<html>
<body>
<form action="http://sandbox.flocash.com/ecom/ecommerce.do" method="post">
<input type="hidden" name="cancel_url" value="http://examples.com/cancel.html">
<input type="hidden" name="notify_url" value="http://examples.com/notify.html">
<input type="hidden" name="return_url" value="http://examples.com/return.html">
<table width="100%" border="0" cellspacing="0" cellpadding="5">
<tr>
<td>Merchant Account</td>
<td><input name="merchant" size="50" value="merchant@test.com"></td>
</tr>
<tr>
<td>Merchant Name</td>
<td><input name="merchant_name" size="50" value="John"></td>
</tr>
<tr>
<td>Order Id</td>
<td><input name="order_id" size="50" value="12345678"></td>
</tr>
<tr>
<td>Customer Id</td>
<td><input name="custom" size="50" value="1234567890"></td>
</tr>
<tr>
<td>Item name</td>
<td><input name="item_name" size="50" value="Merchant Credit"></td>
</tr>
<tr>
<td>Item price</td>
<td><input name="item_price" size="50" value="1"></td>
</tr>
<tr>
<td><input name="currency_code" size="50" value="USD"></td>
<tr>
<td>Quantity</td>
<td><input name="quantity" size="50" value="10"></td>
</tr>
<tr>
<td>Amount</td>
<td><input name="amount" size="50" value="10"></td>
</tr>
<tr>
<td>Customer Account</td>
<td><input name="customer_acc" size="50" value="customer@test.com"></td>
</tr>
<tr>
<td colspan="2">Customer Information:</td>
</tr>
<tr>
<td>Country</td>
<td><input type="text" name="country" value="KE"></td>
</tr>
<tr>
<td>First Name</td>
<td><input type="text" name="user_firstName" value="Tom"></td>
</tr>
<tr>
<td>Last name</td>
<td><input type="text" name="user_lastName" value="Cruise"></td>
</tr>
<tr>
<td>Address</td>
<td><input type="text" name="user_address" value="address"></td>
</tr>
<tr>
<td>City</td>
<td><input type="text" name="user_city" value="city"></td>
</tr>
<tr>
<td>State</td>
<td><input type="text" name="user_state" value="user State"></td>
</tr>
<tr>
<td>Postal Code</td>
<td><input type="text" name="user_postalCode" value="postal Code"></td>
</tr>
<tr>
<td>E-mail</td>
<td><input type="text" name="user_email" value="email"></td>
</tr>
<tr>
<td>Mobile</td>
<td><input type="text" name="user_mobile" value="mobile"></td>
</tr>
<tr>
<td colspan="2"><input type="submit" value="Pay!"></td>
</tr>
</table>
</form>
</body>
</html>
Output parameters¶
No. | Field Name | Description | Data type | sample |
---|---|---|---|---|
1 | merchant | Merchant username | 1-50 Characters | sales@demoshop.com |
2 | sender_acct | Sender Account | 1-50 Characters | 1-50 Characters |
3 | order_id | Unique transaction ID of the order | 1-25 Characters | AT000001 |
4 | Amount | The total amount the buyer needs to pay | float | 23.45 |
5 | item_name | Name of Item | 1-250 Characters | Call Credit |
6 | item_price | Price per item | float | 2.50 |
7 | currency_code | 3-letter code of the currency of the ammo unt based on ISO4217 | 3 Characters | USD |
8 | Quantity | The number of items | Int | Characters |
9 | trans_id | Unique transaction ID. If error, the va lue is 0 | 1-20 characters | |
10 | fpn_id | Unique FloCash ID | 1-20 characters | |
11 | Custom | Customer Id | 1-25 characters | |
12 | Customer | Customer Name | 1-250 character | |
13 | Status | Transaction Status Refer to status code in Appendix A | Int | |
14 | status_msg | Status message | 1-250 characters | |
15 | payer_email | Buyers email | 1-250 characters | |
16 | payment_channel | Payment channel buyer used mobile, card, wallet | 1-250 characters | |
17 | txn_partner_ref | Transaction reference returned back from bank | 1-250 characters |