Paykun WHMCS Kit

Featuring a fully featured client area control panel providing full access to order and manage services, automated provisioning and delivery, with billing and support tools. WHMCS is the only product you need to setup and run an online web hosting business.

Integrating your WHMCS site with PayKun allows you to accept payments on your WHMCS site via the PayKun Payment Gateway. Collecting online payments can be very easy with PayKun.

You can provide multiple payment options to your customer and a great checkout experience. Also, they will get all sorts of payment option that will make them buy on the spot.


Following things will be required before you can begin integration:



Installation and Integration steps

Ensure you have the latest version of WHMCS installed.

  1. Go to the library and download the Source code zip file of the required version of the plugin from here.

  2. Unzip and upload the contents of the repository to your WHMCS Installation directory. That means the content of module folder from the repository goes in module folder in your WHMCS Installation directory.

  3. Log into your site as the WHMCS administrator. This is done by adding /admin to the URL where you have installed WHMCS, for example,

  4. Navigate to Setup → Payments → Payment Gateways.

  5. Select PayKun in the dropdown and Activate it.

  6. Enter the <merchant_id>, <access_token> and <enc_key>. You can generate these from your Dashboard.

  7. Set Convert for Processing to INR if your store has a different default currency. In this case, ensure you update the exchange rate in your currency management settings.

  8. Click Save Changes.

Test your Integration (sandbox)

If you need it for testing purposes you can use our sandbox mode by sending “isLive” parameter to false.

If you need it for testing purposes you should login in Paykun dashboard using sandbox mode and get your testing merchant Id and Device API key(access token).

To test your integration in sandbox environment before going like, you can use our test environment (See how to create one) and use your test credentials, You just have to use isLive=false in your integration, You can use test card details provided here for testing purpose.

  • Log In to your PayKun Dashboard

  • ‘Go to’ the Merchant Account under the ‘Payment Gateway’ section (If you are first-time-login then you will see the ‘Become a Merchant’ option.)

  • After the merchant account login, click on your profile picture.

  • Select ‘Test mode’.

  • Select "Generate Sandbox Account" to activate your sandbox account

  • After activating sandbox account,you can click on "Sandbox Login" button to go to sandbox dashboard and use generated username and password login.

  • Now you have to generate your Device API key from sandbox account from Setting-Security tab.

  • You can get you Merchant ID clicking on profile icon from top right corner.

  • Now you have to use this API key and Merchant ID in your Demo project for testing purposes. Note: Remember that you can login in Sandbox account from your Live account.

For Live environment

If you want to do real transaction than set "isLive" parameter to true and use your Live MerchantId and AccessToken from Paykun dashboard.


The Paykun WHMCS is released under the MIT License.

For any Assistance

In case of any query, please contact to

Last updated