Magento

Magento Installation Guide

This guide explains how to install and configure the PayItMonthly Payment Gateway for Magento (Open Source or Adobe Commerce). The module is installed via Composer or through the Adobe Commerce Marketplace, then configured in Magento Admin using your PayItMonthly API credentials and webhook secret.

1. Install the Module

You can install the PayItMonthly Payment Gateway in two ways:
‍
• Via Composer (recommended): 
Run the following commands from your Magento root directory:

composer require payitmonthly/module-payment-gateway php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:clean  

(Optional)
Rebuild index: bin/magento indexer:reindex
Enable/disable maintenance mode:
bin/magento maintenance:enable
bin/magento maintenance:disable

• Via Adobe Commerce Marketplace: 
You can also add the PayItMonthly Payment Gateway extension to your Adobe Commerce/Marketplace account, then install it as part of your project. https://commercemarketplace.adobe.com/payitmonthly-module-payment-gateway.html

2. Get API Credentials

• Via (app.payitmonthly.uk) Log in to your PayItMonthly partner (merchant) account
• Navigate (purple section on left) to Admin ➝ Developers ➝ API Credentials
• Click “Create API User” button at top right of screen
• On drop down select “Magento Integration”
• A new row will list your “Access Key ID” and a button to show your “Secret Access Key”
• Note when you click “Show Secrete Access Key” that it will only show once so copy it right away.

3. Get the Webhook Secret

• Log in to your PayItMonthly Partner Account
• Go to Admin → Developers → Webhook Settings
• Copy the Signature Secret.

4. Configure the Gateway in Magento Admin

• Log in to Magento Admin
• Go to Stores → Settings → Configuration
• Navigate to Sales → Payment Methods → Other Payment Methods
• Enable PayItMonthly
• Choose Sandbox for testing or Live for production
• Enter the Merchant Gateway Key, Merchant Gateway Secret, and Webhook Secret from your PayItMonthly account
• Set the maximum number of instalments allowed
• Save your changes.