Paystack Add-on Guide for LaraClassifier & JobClass

Installation

Step 1: Upload the add-on

Go to Admin panel → Extensions → Add-ons, click Upload add-on and drop the add-on's .zip file into the upload area (50 MB maximum). The archive is extracted into extensions/addons/paystack/ and Paystack appears in the list, deactivated.

Step 2: Activate the add-on

Click Activate on the Paystack card. It is a paid add-on, so a dialog asks for its purchase code, which is verified before anything else happens: an invalid code is rejected in the dialog and nothing is changed.

Once the code is accepted, activation runs in one pass: it creates the add-on's database tables (its migrations), registers its permissions, runs its seeders and publishes its public assets. Reload the page to see its new entry in the Add-ons section of the admin sidebar.

Step 3: Configure

Open Admin panel → Paystack from the Add-ons section of the sidebar and set the add-on up: see Configuration.

Purchase Code (License Key)

Paystack is sold as a separate product, so it has its own purchase code (license key), distinct from the purchase code of the main application and from the one of every other add-on. You are asked for it when you activate Paystack in Admin panel → Extensions → Add-ons.

Our products are sold on three platforms. The way you receive a purchase code depends on where you bought the product.

1. bedigit.com Store (in-site purchase)

• As soon as the order’s payment status becomes Paid, a license key is generated automatically for every licensed item in the order (one key per purchased unit: buying 3 units gives 3 distinct keys).
• It is emailed to the address used on the order, either in a dedicated license email or inside the order confirmation email. Check your inbox and your spam / junk folder.
• The key stays available in your account under My Account → My Licenses. Keys are masked in the list; open the license detail page to reveal and copy the full key, see the domains it is activated on, and deactivate a domain to free an activation slot.
• The matching invoice is under My Account → My Orders.

2. Gumroad

• A Gumroad purchase produces two separate emails: the Gumroad receipt (sent by Gumroad, giving access to the files) and a license key email (sent by bedigit.com) that contains your purchase code.
• The license key email is generated as soon as Gumroad notifies us of the sale, so it normally arrives within seconds of the payment. Here too, check your inbox and your spam / junk folder.
• When the Gumroad product uses Gumroad’s own license-key feature, the same key also appears in your Gumroad receipt and under Library → your purchase on gumroad.com.
• Use the same email address on bedigit.com as on Gumroad: your keys are then linked to your account automatically and listed under My Account → My Licenses, even if you register after the purchase. You can also add a Gumroad key manually from My Account → My Gumroad Licenses.

3. Envato Market (CodeCanyon)

• Envato purchase codes are issued and delivered by Envato Market, never emailed by us, so there is nothing to look for in your spam folder: you retrieve the code from your Envato account.
• Log in to your Envato / CodeCanyon account, open the Downloads page, find the item, and choose License certificate & purchase code from the Download dropdown. The code is written in that certificate.
• An Envato purchase code looks like 12345678-90ab-cdef-1234-567890abcdef (8-4-4-4-12 characters). It never changes, and renewing item support does not issue a new one.
• Official Envato article: Where Is My Purchase Code?

Compatibility

• v3.0.2 => LaraClassifier v19.1.0+ and JobClass v19.1.0+
• v3.0.1 => LaraClassifier v19.1.0+ and JobClass v19.1.0+
• v3.0.0 => LaraClassifier (v19.0.0 to v19.0.1) and JobClass (v19.0.0 to v19.0.1)
• v2.2.5 => LaraClassifier v18.3.0+ and JobClass v17.3.0+
• v2.2.4 => LaraClassifier v18.2.0 and JobClass v17.2.0
• v2.2.3 => LaraClassifier (v18.0.0 to v18.1.1) and JobClass (v17.0.0 to v17.1.1)
• v2.2.2 => LaraClassifier (v17.0.0 to v17.1.1) and JobClass (v16.0.0 to v16.1.1)
• v2.2.1 => LaraClassifier (v16.0.0 to v16.0.2) and JobClass (v15.0.0 to v15.0.2)
• v2.2.0 => LaraClassifier (v15.2.0 to v15.4.1) and JobClass (v14.2.0 to v14.4.1)
• v2.1.4 => LaraClassifier (v15.1.5 to v15.1.6) and JobClass (v14.1.5 to v14.1.6)
• v2.1.3 => LaraClassifier v15.1.5 and JobClass v14.1.5
• v2.1.2 => LaraClassifier v15.1.1 and JobClass v14.1.1
• v2.1.1 => LaraClassifier v15.1.1 and JobClass v14.1.1
• v2.1.0 => LaraClassifier (v15.0.0 to v15.1.0) and JobClass (v14.0.0 to v14.1.0)
• v2.0.1 => LaraClassifier v14.2.0 and JobClass v13.2.0
• v2.0.0 => LaraClassifier (v14.0.0 to v14.1.0) and JobClass (v13.0.0 to v13.1.0)
• v1.9 => LaraClassifier (v11.0.0 to v13.0.0) and JobClass (v10.0.0 to v12.0.0)
• v1.8 => LaraClassifier (v10.2.0 to v10.2.6) and JobClass (v9.2.0 to 9.2.6)
• v1.7 => LaraClassifier (v10.1.2 to v10.1.4) and JobClass (v9.1.3 to v9.1.5)
• v1.6 => LaraClassifier (v10.0.0 to v10.1.1) and JobClass (v9.0.0 to v9.1.2)
• v1.5 => LaraClassifier (v9.0.0 to v9.0.1) and JobClass (v8.0.0 to v8.0.1)
• v1.4 => LaraClassifier (v8.0.2 to v8.0.6) and JobClass (v7.0.2 to v7.0.6)
• v1.3 => LaraClassifier (v7.1.1 to 8.0.1) and JobClass (v5.9.1 to v7.0.1)
• v1.2 => LaraClassifier v7.1.0 and JobClass v5.9.0
• v1.1 => LaraClassifier v7.0.4 and JobClass v5.8.4
• v1.0 => LaraClassifier (v6.6.x to v7.0.3) and JobClass (v5.4.x to v5.8.3)

Updating

An update only replaces the add-on's files. Its database tables and data, its settings, its activation state and its recorded purchase code are all kept, so do not deactivate or remove the add-on before updating it. Back up your database first all the same.

Method 1: Upload the new version (recommended)

1. Download the latest .zip file of the add-on.
2. Go to Admin panel → Extensions → Add-ons and click Upload add-on.
3. Drop the .zip file into the upload area.
4. Because Paystack is already installed, a prompt shows the installed version and the new one. Click Replace: the extensions/addons/paystack/ folder is swapped for the new files. Cancelling the prompt discards the upload.

Method 2: Replace the files by hand

1. Over FTP or SSH, delete the extensions/addons/paystack/ folder and upload the new one in its place. Replace the whole folder rather than copying over it, so files dropped by the new version do not linger.
2. Open Admin panel → Extensions → Add-ons: the page re-reads addon.json and the card shows the new version number.

After the files are replaced

New database tables or columns. When a new version adds some, create them by running php artisan migrate --force over SSH, or without SSH by clicking Deactivate then Activate on the add-on's card: activation runs every pending migration (and asks for the purchase code again). Your data is not touched either way.

Public assets. The add-on's public files are copied to public/vendor/paystack/ when it is activated, and replacing its files does not refresh that copy. When an update changes them, republish them with php artisan vendor:publish --tag=paystack-assets --force, or click Deactivate then Activate on its card.

If your installation caches its configuration or routes (php artisan config:cache, route:cache), run php artisan optimize:clear after the update.

Configuration

Getting your API credentials

Get your public and secret keys from the API keys page of your Paystack dashboard. Paystack issues separate test and live key pairs.

Setting them up from the admin panel

The add-on adds a Paystack entry to the Add-ons section of the admin sidebar. Open it to reach Admin panel → Paystack, which is the recommended way to configure the gateway.

Click Save and the settings are applied immediately: there is nothing else to clear or rebuild.

Setting them up by hand

You can also skip the form and edit the script's /.env file directly. These are exactly the keys the admin form writes:

PAYSTACK_PUBLIC_KEY=
PAYSTACK_SECRET_KEY=
PAYSTACK_BASE_URL=https://api.paystack.co
PAYSTACK_MERCHANT_EMAIL=
PAYSTACK_CURRENCIES="NGN,GHS"
PAYSTACK_EXCEPTION_CURRENCIES=HUF

Example of use:

PAYSTACK_PUBLIC_KEY=your-paystack-public-key
PAYSTACK_SECRET_KEY=your-paystack-secret-key
PAYSTACK_BASE_URL=https://api.paystack.co
PAYSTACK_CURRENCIES="NGN,GHS" # or "NGN,GHS,USD" related to your Paystack account configuration.

Run php artisan config:clear after editing /.env by hand if your installation caches its configuration. Editing /.env does not switch the gateway on: use the Active switch on Admin panel → Paystack, or enable Paystack under Admin panel → Payment methods.

Translation

To translate this addon into your language:

• Go to the languages folder at /extensions/addons/paystack/resources/lang/
• Duplicate the folder /extensions/addons/paystack/resources/lang/en/ to /extensions/addons/paystack/resources/lang/<code>/
  NOTE: Don't forget replace <code> by your language code (e.g. "de" for German language).
• Open the file /extensions/addons/paystack/resources/lang/<code>/messages.php and translate it.
  NOTE: To translate the file, you must change the values and not the keys of the PHP array.

Uninstallation

Switching an add-on off without losing anything is a deactivation: go to Admin panel → Extensions → Add-ons, click Deactivate on the Paystack card and confirm.

• The add-on is no longer loaded: its routes, views, admin sidebar entry and front-end pages stop answering.
• Its database tables and all the data they hold are kept, and its files stay under extensions/addons/paystack/. Nothing is deleted.
• Its permissions and its recorded purchase code stay in the database. Only Remove deletes them.
• Deactivation is refused while another active add-on depends on this one: deactivate that add-on first.

Click Activate on the same card to switch it back on. As for a first activation, the purchase code is asked for and verified again; then any pending migrations run, the assets are republished, and the add-on picks up exactly where it left off.

Removing

Removing is permanent and destroys the add-on's data. The Remove button only appears on a deactivated add-on, so removal is always two steps:

1. Deactivate Paystack (see Uninstallation).
2. Click Remove on its card and confirm the prompt.

The admin panel then, in one pass:

• runs the add-on's uninstall hook, if it ships one, while its code is still on disk;
• revokes the permissions declared in its addon.json;
• rolls back its migrations (this drops its database tables and every row they hold) and purges its entries from the migrations table, so a later reinstall migrates from scratch;
• deletes its published assets: public/addons/paystack/, public/vendor/paystack/ and storage/app/public/addons/paystack/;
• deletes the add-on directory extensions/addons/paystack/;
• deletes its row in the addons table (the recorded purchase code goes with it) and clears the application cache.

Removal is refused, with an explanatory message and before anything is destroyed, when the add-on is still active, when another active add-on depends on it, or when the web server (PHP) user cannot delete extensions/addons/paystack/. In that last case, give that user write permission on the directory and on its parent, then try again.

Deleting the folder over FTP or SSH is not equivalent: the add-on is only switched off, and its tables, its entries in the migrations table and its addons row are all left behind. Use Remove in the admin panel instead.

Resources

• Laravel Paystack
• Paystack - Accept Payments
• Paystack - Test Payments