Skip to content

Commit

Permalink
[README] Add installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
weoka committed Sep 18, 2021
1 parent f8f6ce2 commit 222998d
Showing 1 changed file with 10 additions and 35 deletions.
45 changes: 10 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,15 @@
# WHMCS Sample Third Party Payment Gateway Module #
# DogeCash WHMCS gateway

## Summary ##
Accepting DogeCash on your store has several benefits: instant arrival, no chargebacks, and 0 fees. Follow the steps below to install the plugin in your WHMCS store and start accepting payments in DogeCash.

Payment Gateway modules allow you to integrate payment solutions with the WHMCS
platform.
1. Be sure you're running WooCommerce 2.1+ in your shop.
2. Upload the entire `dogecash-whmcs-gateway.zip` file to your main `whmcs` directory
3. Extract the zip file contents into the WHMCS folder. The extracted files should be located at: public_html/your_whmcs_folder/modules/gateways/
4. Activate the DogeCash Gateway through the **Setup > Payments > Payment Gateways > All Payment Gateways** menu in WHMCS
5. Go to **Manage Existing Gateways**, select "DogeCash Gateway", add your DogeCash Address, confirmation preferences.
6. You're ready to enjoy the DogeCash benefits!

There are two types of gateway module:

* Third Party Gateways - these are payment solutions where checkout occurs
on a remote website, usually hosted by the payment gateway themselves.

* Merchant Gateways - these are payment solutions where credit card details
are collected - usually within the WHMCS application, though more and more
often this will be done remotely, typically via an iframe, with a page hosted
remotely by the payment gateway enabling tokenised storage.

The sample files here demonstrate how we suggest a Third Party Payment Gateway
module for WHMCS be structured and implemented.

For more information, please refer to the documentation at:
https://developers.whmcs.com/payment-gateways/

## Recommended Module Content ##

The recommended structure of a third party gateway module is as follows.

```
modules/gateways/
|- callback/gatewaymodule.php
| gatewaymodule.php
```

## Minimum Requirements ##
## Minimum Requirements

For the latest WHMCS minimum system requirements, please refer to
https://docs.whmcs.com/System_Requirements
Expand All @@ -40,8 +18,5 @@ We recommend your module follows the same minimum requirements wherever
possible.

## Useful Resources
* [Developer Resources](https://developers.whmcs.com/)
* [Hook Documentation](https://developers.whmcs.com/hooks/)
* [API Documentation](https://developers.whmcs.com/api/)

[WHMCS Limited](https://www.whmcs.com)
- [DogeCash Website](https://dogecash.org/)

0 comments on commit 222998d

Please sign in to comment.