README

Module Overview

The PeachPayments_Hosted module is an all-in-one payment solution for Magento 2, specifically designed for emerging African markets. It provides a secure and seamless integration with Peach Payments, supporting various payment flows including Hosted Payments, and Recurring Payments (Subscriptions).

Key Features

Multiple Payment Flows: Supports Hosted Payments integration method.
Recurring Payments: Full support for subscriptions and standing instructions.
Vault Support: Securely save customer payment methods for faster checkout.
Webhooks: Real-time transaction status updates and automated order processing.
Direct Buy Buttons: "Pay With Peach" shortcuts on Product Detail Pages (PDP) and Category Pages (PLP).
Refund Support: Process refunds directly from the Magento Admin.
Issue Reporting: Built-in tool for merchants to report issues directly to Peach Payments support.
Robust Logging: Comprehensive logging to both files and database for easy troubleshooting.

System Requirements

PHP: ^8.3 || ^8.4
Magento: >=2.4.8 (Framework ^103.0)

Installation

Manual Installation

Create the following directory structure in your Magento root:
```
mkdir -p app/code/PeachPayments/Hosted
```
Copy the contents of this repository into app/code/PeachPayments/Hosted.

Composer Installation

Run the following command in your Magento root:

composer require peachpayments/magento2-plugin-v2

Finalizing Installation

After installing the files, run the following Magento CLI commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Conflict Notice

This module (peachpayments/magento2-plugin-v2) conflicts with the legacy peachpayments/magento2-plugin. Ensure the legacy plugin is removed before installing this version to prevent system errors.

Admin Configuration

Log in to the Magento Admin and navigate to:
Stores > Configuration > Sales > Payment Methods > Peach Payments - Hosted

Here you can configure:

Operation Mode (Sandbox/Live)
API Credentials (Entity ID, Client ID, Secret Token, etc.)
Recurring Payment settings
Checkout appearance (Title, Description, Logos)
PDP/PLP Shortcut buttons

Cron Jobs

The module utilizes the following cron jobs (configured in the default group):

Job Name	Schedule	Purpose
`peach_payments_clean_database_logs_cronjob`	`0 3 * * *`	Cleans up old payment logs from the database.
`peach_payments_process_webhook_cronjob`	`/5 * * *`	Processes pending webhooks from Peach Payments.
`peach_payments_send_issue_report_cronjob`	`/5 * * *`	Sends queued issue reports to support.

Logging

Logs are recorded in two ways:

System Logs: Standard Magento logging (usually found in var/log/system.log).
Database Logs: Transaction-specific logs stored in the peach_payment_log table. These can be managed and viewed via the database or cleared automatically by the cleanup cron job.

Compatability matrix

Magento	Peach Payments module	ParadoxLabs Subscription module
2.4.8	Version: 2.0.0	Version: 3.7.0
2.4.8	Version: 2.0.1	Version: 3.7.0

peachpayments/magento2-plugin-v2

包简介

README 文档