General guides

PAYMENT PROVIDER CONFIGURATION GUIDE

💳 Payment Provider Configuration Guide Configure one or more payment providers to accept online payments securely in your system. 🔍 What is a Payment Provider? A payment...

2025-12-27Article 11 of 12

💳 Payment Provider Configuration Guide

Configure one or more payment providers to accept online payments securely in your system.

🔍 What is a Payment Provider?

A payment provider allows your customers to pay invoices, bills, and services online using cards, bank transfers, or digital wallets.

Once configured, your system can:

  • Generate payment links
  • Accept online payments
  • Automatically mark invoices as paid
  • Support multiple payment gateways simultaneously

⚙️ Multiple Providers Supported

You can configure more than one payment provider at the same time. The system will automatically use the available providers when generating payment links.

💡 This allows you to offer customers multiple payment options (e.g. PayPal + Stripe).

✅ Supported Payment Providers

🟡 PayPal

Global · Wallet & card payments

View Setup
🔵 Stripe

Cards · Subscriptions · API-first

View Setup
🟢 Paystack

Africa-focused · Local payments

View Setup

🧩 Payment Provider JSON Structure

Payment providers are configured using a JSON editor . Each provider has its own object, and you may enable one or more providers. 

        {
          "paypal": { ... },
          "stripe": { ... },
          "paystack": { ... }
        }

🟡 PayPal Payment Provider Setup

🔍 Overview

PayPal allows customers to pay using their PayPal balance, debit cards, or credit cards. It supports both Sandbox (testing) and Production (live) environments.

🌐 PayPal Website: https://www.paypal.com/developer

Step 1 — Create a PayPal Developer Account

  1. Visit the PayPal Developer Portal
  2. Create or log in with your PayPal account
  3. Access the Developer Dashboard

Step 2 — Create REST API Credentials

  1. Go to Apps & Credentials
  2. Create a new app
  3. Copy the Client ID for Sandbox and Production

Step 3 — Enter Configuration in JSON Editor 

        {
          "paypal": {
            "environment": "production",
            "production": "PAYPAL_LIVE_CLIENT_ID",
            "sandbox": "PAYPAL_SANDBOX_CLIENT_ID"
          }
        }
💡 Use sandbox for testing and production when going live.

🔵 Stripe Payment Provider Setup

🔍 Overview

Stripe is a developer-friendly payment platform supporting cards, wallets, and subscriptions.

🌐 Stripe Website: https://dashboard.stripe.com

Step 1 — Create a Stripe Account

  1. Sign up or log in to Stripe
  2. Access the Stripe Dashboard

Step 2 — Get API Keys

  1. Go to Developers → API Keys
  2. Copy the Publishable Key
  3. Enable Live Mode when ready

Step 3 — Enter Configuration in JSON Editor 

        {
          "stripe": {
            "production": "pk_live_xxxxxxxxxxxxxxxxx"
          }
        }

🟢 Paystack Payment Provider Setup

🔍 Overview

Paystack is a popular payment provider in Africa, supporting cards and local bank payments.

🌐 Paystack Website: https://paystack.com

Step 1 — Create a Paystack Account

  1. Sign up at Paystack
  2. Verify your business details

Step 2 — Get API Keys

  1. Go to Settings → API Keys
  2. Copy your Public Key

Step 3 — Enter Configuration in JSON Editor 

        {
          "paystack": {
            "production": "pk_live_xxxxxxxxxxxxxxxxx"
          }
        }
✅ Paystack is now enabled for accepting payments.