PayPal Payment Gateway Add-on

Configure the PayPal gateway add-on for TruPayments.

PayPal gateway settings in TruCMS with sensitive credential values hidden

The PayPal add-on adds its own gateway settings page. Keep all production credentials private.

The PayPal add-on extends TruPayments with PayPal processing. Install and activate the add-on through the Plugin Manager, then configure its payment settings before enabling a customer-facing method.

Requirements

You need an appropriate PayPal merchant/account setup and the credentials shown below. Never paste real secrets into screenshots or support messages.

Configuration Fields

SettingGuidance
ModeChoose Sandbox while testing and Live when real payments are ready.
Webhook URLRead-only URL shown by TruCMS; copy it into the gateway dashboard if webhook notifications are configured.
Sandbox Client IDCredential used only while the gateway Mode is Sandbox.
Sandbox Client SecretCredential used only while the gateway Mode is Sandbox.
Sandbox Webhook IDCredential used only while the gateway Mode is Sandbox.
Live Client IDCredential used only while the gateway Mode is Live.
Live Client SecretCredential used only while the gateway Mode is Live.
Live Webhook IDCredential used only while the gateway Mode is Live.
Auto CaptureControls whether approved PayPal orders are captured automatically.

How the gateway becomes available to customers

Installing/configuring the gateway add-on provides the processing capability. Then create or edit the customer-facing TruPayments Payment Method that uses this gateway. The method must be Enabled and eligible for the checkout’s module Scope, currency, and any Billing Zone restriction.

Changing credentials does not rewrite transaction history

Gateway configuration affects new processing attempts. Existing TruPayments transaction/refund records remain the place to review what happened on previous payments.

  1. Set Mode to Sandbox.
  2. Enter the sandbox/test credentials for the gateway.
  3. If applicable, configure the displayed Webhook URL in the provider dashboard.
  4. Create or edit the corresponding TruPayments Payment Method and enable it only for intended scope/currencies.
  5. Complete a low-risk sandbox payment through a connected module such as Booking or TruCommerce.
  6. Confirm the TruPayments transaction status and return/cancel behavior.
  7. Only after the sandbox flow is successful, enter live credentials and change Mode to Live.

Do not mix environments

Sandbox credentials belong with Sandbox mode; Live credentials belong with Live mode. Switching Mode changes which credential set TruPayments expects.