xbilling manual

3
xBilling Manual Website Settings This section of the module shows a list of settings required for the module to run smoothly as intended. Be sure to fill in all fields appropriately. Service Periods This is where you administer all service periods you want to offer for every enabled package there is on your ZPanel installation. e.g. 1 month, 3 months. Hosting Packages This section pulls all the packages you have setup on ZPanel (Reseller => Package Manager). There on you can select options for specific package (enabled, free, et al). You can also manage service period prices for each and every package you have listed. Payment Options This section of the module allows for the management of payment options which you can in return use to manage “Payment Methods”. However, the “Payment Options” menu is only visible to the “zadmin” user. How to setup Payment Gateways If for example, you decide to add XYZ Payment gateway and you receive the following HTML code with instructions to place it on your website. <form action="https://www.xyzpay.biz" method="post"> <input type="hidden" name="business_email" value="YOUR_EMAIL_HERE"> <input type="hidden" id="payment_method_id" name="CUSTOM_FIELD_NAME_HERE" value="CUSTOM_FIELD_VALUE_HERE"> <input type="hidden" name="country_code" value="COUNTRY_CODE_HERE”> <input type="hidden" name="item_name" value="INVOICE_DESCRIPTION_HERE"> <input type="hidden" name="amount" value="INVOICE_AMOUNT_HERE"> <input type="hidden" name="invoice" value="INVOICE_ID_HERE"> <input type="hidden" name="currency_code" value="CURRENCY_CODE_HERE"> <input type="hidden" name="callback_url" value="CALL_BACK_URL_HERE"> <input type="submit" value="Pay Now!" name="submit" /> </form> Replace the following: <input type="hidden" name="country_code" value="COUNTRY_CODE_HERE”> <input type="hidden" name="item_name" value="INVOICE_DESCRIPTION_HERE"> <input type="hidden" name="amount" value="INVOICE_AMOUNT_HERE"> <input type="hidden" name="invoice" value="INVOICE_ID_HERE"> <input type="hidden" name="currency_code" value="CURRENCY_CODE_HERE"> <input type="hidden" name="CUSTOM_FIELD_NAME_HERE" value="CUSTOM_FIELD_VALUE_HERE"> With: input type="hidden" name="country_code" value="{{country_code}}”> <input type="hidden" name="item_name" value="{{invoice_desc}}"> <input type="hidden" name="amount" value="{{invoice_amount}}"> <input type="hidden" name="invoice" value="{{invoice_id}}"> <input type="hidden" name="currency_code" value="{{currency}}"> <input type="hidden" name="CUSTOM_FIELD_NAME_HERE" value="{{payment_method_id}}"> ZPanel xBilling Module Usage Manual Written by Aderemi Adewale

Upload: iklananda

Post on 12-Nov-2014

40 views

Category:

Documents


2 download

DESCRIPTION

Xbilling Manual

TRANSCRIPT

Page 1: Xbilling Manual

xBilling Manual

Website SettingsThis section of the module shows a list of settings required for the module to run smoothly as intended. Be sure to fill in all fields appropriately.

Service PeriodsThis is where you administer all service periods you want to offer for every enabled package there is on your ZPanel installation. e.g. 1 month, 3 months.

Hosting PackagesThis section pulls all the packages you have setup on ZPanel (Reseller => Package Manager).

There on you can select options for specific package (enabled, free, et al).

You can also manage service period prices for each and every package you have listed.

Payment OptionsThis section of the module allows for the management of payment options which you can in return use to manage “Payment Methods”.

However, the “Payment Options” menu is only visible to the “zadmin” user.

How to setup Payment GatewaysIf for example, you decide to add XYZ Payment gateway and you receive the following HTML code with instructions to place it on your website.

<form action="https://www.xyzpay.biz" method="post"><input type="hidden" name="business_email" value="YOUR_EMAIL_HERE"><input type="hidden" id="payment_method_id" name="CUSTOM_FIELD_NAME_HERE" value="CUSTOM_FIELD_VALUE_HERE"><input type="hidden" name="country_code" value="COUNTRY_CODE_HERE”><input type="hidden" name="item_name" value="INVOICE_DESCRIPTION_HERE"><input type="hidden" name="amount" value="INVOICE_AMOUNT_HERE"><input type="hidden" name="invoice" value="INVOICE_ID_HERE"><input type="hidden" name="currency_code" value="CURRENCY_CODE_HERE"><input type="hidden" name="callback_url" value="CALL_BACK_URL_HERE"><input type="submit" value="Pay Now!" name="submit" /></form>

Replace the following:<input type="hidden" name="country_code" value="COUNTRY_CODE_HERE”><input type="hidden" name="item_name" value="INVOICE_DESCRIPTION_HERE"><input type="hidden" name="amount" value="INVOICE_AMOUNT_HERE"><input type="hidden" name="invoice" value="INVOICE_ID_HERE"><input type="hidden" name="currency_code" value="CURRENCY_CODE_HERE"><input type="hidden" name="CUSTOM_FIELD_NAME_HERE" value="CUSTOM_FIELD_VALUE_HERE">

With:input type="hidden" name="country_code" value="{{country_code}}”><input type="hidden" name="item_name" value="{{invoice_desc}}"><input type="hidden" name="amount" value="{{invoice_amount}}"><input type="hidden" name="invoice" value="{{invoice_id}}"><input type="hidden" name="currency_code" value="{{currency}}"><input type="hidden" name="CUSTOM_FIELD_NAME_HERE" value="{{payment_method_id}}">

ZPanel xBilling Module Usage Manual Written by Aderemi Adewale

Page 2: Xbilling Manual

By default, the module replaces the tags below.{{country_code}}{{invoice_desc}}{{invoice_id}}{{invoice_amount}}{{currency}}{{payment_method_id}}

Also, if you want to include a custom (or other) tag to be used by your payment processor, you need to include it as such.

e.g. notify_url = {{notify_url}}

And in return, you need to handle whatever data sent back to your custom callback url by your selected payment processor.

NOTE: Your callback url has to be a script written by you or someone with programming knowledge (preferably PHP), you can have a look at “ipn_listener.php” to have a general idea of how to go about this.

Payment OptionsOnly the “zadmin” user has the ability to add payment options.

Fig. 1.0

You can add as much fields as required to a payment option, just make sure you have a corresponding field in the HTML code.

e.g. In the example above, the fields “my_field_1” and “my_field_2” are custom fields that have not been included in the HTML code above.

To add them to the HTML code, 2 additional fields has to be added to the HTML code as such (using the field names);

<input type="hidden" name="field_1" value="{{my_field_1}}”><input type="hidden" name="field_2" value="{{my_field_2}}”>

ZPanel xBilling Module Usage Manual Written by Aderemi Adewale

Page 3: Xbilling Manual

The system in return, replaces the values of these fields with its appropriate values specified in the “Payment Method” section.

Payment Methods

Fig. 1.1

Only the enabled payment options shows in the dropdown selection in the above picture and whatever you specify as the value of “Field 1” and “Field 2” above(Fig 1.2) will replace “{{my_field_1}}” and “{{my_field_2}}” as specified in Fig. 1.0 above.

ZPanel xBilling Module Usage Manual Written by Aderemi Adewale