{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Installation & Activation","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"installation--activation","__idx":0},"children":["Installation & Activation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To install the new module, upload it to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/modules/gateways/"]}," folder of your WHMCS installation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the module includes a callback file, that should be uploaded to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/modules/gateways/callback/"]}," folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once uploaded, navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup > Payment Gateways"]}," to activate and configure the new module."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Important Note"]}," The process of activating a module detects the type of module that has been created. Therefore if you experience unexpected behaviours, please try deactivating and reactivating your module before continuing."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting-errors-during-activation","__idx":1},"children":["Troubleshooting errors during activation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you receive a blank page or error message within the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup > Payment Gateways"]}," page upon uploading your new payment gateway module, this indicates there could be a syntax error within the new code."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To debug this, you can turn on error reporting.  To do this, navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup > General Settings > Other"]}," and check the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Display Errors"]}," setting."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This enables PHP error reporting and should show the cause of any issues. Once resolved, remember to disable Display Errors again."]}]},"headings":[{"value":"Installation & Activation","id":"installation--activation","depth":1},{"value":"Troubleshooting errors during activation","id":"troubleshooting-errors-during-activation","depth":2}],"frontmatter":{"title":"Installation & Activation","seo":{"title":"Installation & Activation"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/payment-gateways/installation-activation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}