Tutorial: PayPal Payment Gateway Setup
Role: Journal Manager
Time: 20โ30 minutes
OJS Version: 3.5+
OJS includes a built-in PayPal Payment Plugin that allows your journal to accept payments for Article Processing Charges (APCs), subscription fees, and other journal charges via PayPal.
Before You Startโ
- You have Journal Manager access in OJS.
- You have a PayPal Business account at paypal.com. A personal account is not sufficient.
- You have enabled Payments in OJS Distribution settings (see Step 1).
Step 1 โ Enable Payments in OJSโ
- Go to Settings โ Distribution โ Payments.
- Toggle Payments to Enabled.
- Select your currency (e.g., USD, EUR).
- Click Save.
Step 2 โ Enable the PayPal Pluginโ
- Go to Settings โ Website โ Plugins โ Installed Plugins.
- Find PayPal Fee Payment in the list (under Payment Plugins).
- Toggle to Enabled.
- Click the Settings icon next to the plugin.
Step 3 โ Configure PayPal Credentialsโ
You will need PayPal API credentials:
Step 3a โ Get PayPal API Credentialsโ
- Log in to your PayPal Business account.
- Go to Account Settings โ API access โ NVP/SOAP API integration (Classic).
- Click Manage API credentials.
- Note your API Username, API Password, and Signature.
Step 3b โ Enter in OJSโ
In the PayPal Plugin Settings:
| Field | Value |
|---|---|
| Test mode | Enable during setup; disable for live payments |
| PayPal account | Your PayPal Business email address |
| API username | From PayPal API credentials |
| API password | From PayPal API credentials |
| Signature | From PayPal API credentials |
Click Save.
Step 4 โ Configure Payment Typesโ
Define what your journal charges for:
- Go to Settings โ Distribution โ Payments.
- Under Author Fees, set an APC amount if applicable.
- Under Reader Fees, configure subscription pricing if applicable.
- Under General Fees, add any other charges.
- Click Save.
Step 5 โ Test the Payment Flowโ
- In PayPal Plugin Settings, ensure Test mode is enabled.
- Submit a test article as an author.
- At the payment step, you will be redirected to PayPal Sandbox.
- Use a PayPal Sandbox test account to complete the payment.
- Verify the payment appears in the OJS submission record.
- Once confirmed, disable Test mode to go live.
warning
Never process real payments while in test mode. Disable test mode and re-enter production API credentials before going live.
Step 6 โ PayPal Express Checkout (Alternative)โ
For a simpler setup without API credentials, you can configure PayPal Express Checkout:
- In the PayPal Plugin, use your PayPal Business email as the account.
- Leave API fields blank โ OJS will redirect to PayPal standard checkout.
This method is simpler but provides fewer integration features.
Troubleshootingโ
| Problem | Solution |
|---|---|
| Payment button not appearing | Check that Payments are enabled in Distribution settings |
| PayPal redirects but returns an error | Verify API credentials; ensure test/live mode matches your credentials |
| Currency mismatch | Ensure the OJS currency setting matches your PayPal account currency |
| PayPal account not accepting payments | Ensure your PayPal account is a Business account and is verified |
Next Stepsโ
- Third-Party Payment Gateway Setup โ configure Stripe or other payment gateways
- Distribution & Access Settings โ manage open access, subscriptions, and fees
- Subscription Manager Role โ manage journal subscriptions