Bridge API DocsBridge API Docs
Bridge API Docs
Woocommerce plugin

Configuration

Configure the Bridge WooCommerce Plugin for your store

Configuration

Configure the Bridge WooCommerce Plugin to start accepting payments in your store.

Accessing Configuration

  1. Go to WooCommerce > Settings > Payments in your WordPress admin
  2. Find "Bridge" in the payment methods list
  3. Click Set up to configure the plugin

Basic Configuration

API Settings

API Username

  • Field: API Username
  • Description: Your Bridge API username
  • Required: Yes
  • Example: BP1I1rG7CWQ3_C4PHYMSMrB9KWPNrIYHZTPJ28W-FKGNSW1IVFD=WM2WUU35

API Password

  • Field: API Password
  • Description: Your Bridge API password
  • Required: Yes
  • Example: B39W-rAMG64HrT_G8=K2_4YD1M=A89_91_9A=3HrS5BWWKEW38_-YZZ-611r

Service ID

  • Field: Service ID
  • Description: Your unique service identifier
  • Required: Yes
  • Example: 1

Environment Settings

Test Mode

  • Field: Test Mode
  • Description: Enable for testing payments
  • Default: Enabled
  • Note: Always test before going live

API Host

  • Field: API Host
  • Description: Bridge API endpoint
  • Default: https://api.bridgeagw.com
  • Note: Don't change unless instructed

Payment Methods Configuration

Mobile Money Settings

Enable Mobile Money

  • Field: Enable Mobile Money
  • Description: Allow customers to pay via mobile money
  • Default: Enabled

Supported Networks

  • MTN: Enable MTN Mobile Money payments
  • VOD: Enable Telecel Cash payments
  • AIR: Enable AirtelTigo Money payments

Mobile Money Settings

{
  "networks": {
    "MTN": {
      "enabled": true,
      "name": "MTN Mobile Money",
      "icon": "mtn-icon.png"
    },
    "VOD": {
      "enabled": true,
      "name": "Telecel Cash",
      "icon": "telecel-icon.png"
    },
    "AIR": {
      "enabled": true,
      "name": "AirtelTigo Money",
      "icon": "airteltigo-icon.png"
    }
  }
}

Card Payment Settings

Enable Card Payments

  • Field: Enable Card Payments
  • Description: Allow customers to pay with cards
  • Default: Enabled

Supported Card Types

  • Visa: Enable Visa card payments
  • Mastercard: Enable Mastercard payments
  • Local Cards: Enable country-specific cards

Bank Transfer Settings

Enable Bank Transfers

  • Field: Enable Bank Transfers
  • Description: Allow customers to pay via bank transfer
  • Default: Enabled

Bank Transfer Instructions

  • Field: Bank Transfer Instructions
  • Description: Instructions shown to customers
  • Default: "Please complete your bank transfer and we'll process your order."

Callback Configuration

Callback URL

  • Field: Callback URL
  • Description: URL to receive payment notifications
  • Default: {site_url}/wc-api/bridge_callback
  • Note: Don't change unless you have a custom endpoint

Callback Security

  • Field: Callback Security
  • Description: Enable callback verification
  • Default: Enabled
  • Note: Recommended for production

Test Callback

  • Field: Test Callback
  • Description: Test callback functionality
  • Action: Click to test callback URL

SMS Configuration

Enable SMS Notifications

  • Field: Enable SMS
  • Description: Send SMS notifications to customers
  • Default: Enabled

Sender ID

  • Field: Sender ID
  • Description: SMS sender identifier
  • Required: Yes
  • Max Length: 11 characters
  • Example: YOURAPP

SMS Templates

Payment Confirmation

  • Field: Payment Confirmation SMS
  • Description: SMS sent when payment is successful
  • Default: "Payment of {amount} {currency} received. Order #{order_id}"

Payment Failure

  • Field: Payment Failure SMS
  • Description: SMS sent when payment fails
  • Default: "Payment failed for order #{order_id}. Please try again."

Order Update

  • Field: Order Update SMS
  • Description: SMS sent for order status updates
  • Default: "Order #{order_id} status updated to {status}"

Order Management

Order Status Mapping

Successful Payment

  • Bridge Status: 000 (Success)
  • WooCommerce Status: Processing
  • Action: Update order status and send confirmation

Failed Payment

  • Bridge Status: 001 (Failed)
  • WooCommerce Status: Failed
  • Action: Update order status and notify customer

Pending Payment

  • Bridge Status: 002 (Pending)
  • WooCommerce Status: Pending Payment
  • Action: Keep order in pending state

Order Notes

  • Field: Add Order Notes
  • Description: Add transaction details to order notes
  • Default: Enabled

Order Meta

  • Field: Store Transaction Data
  • Description: Store transaction ID and network details
  • Default: Enabled

Currency Settings

Supported Currencies

  • GHS: Ghana Cedi (Primary)
  • USD: US Dollar
  • EUR: Euro
  • GBP: British Pound

Currency Conversion

  • Field: Enable Currency Conversion
  • Description: Convert prices to supported currencies
  • Default: Disabled
  • Note: Requires currency conversion API

Currency Display

  • Field: Currency Display Format
  • Description: How to display currency amounts
  • Default: {symbol}{amount}
  • Example: GHS 100.00

Advanced Settings

Logging

  • Field: Enable Logging
  • Description: Log API requests and responses
  • Default: Enabled
  • Location: /wp-content/uploads/bridge-logs/

Debug Mode

  • Field: Debug Mode
  • Description: Enable detailed debugging
  • Default: Disabled
  • Note: Only enable for troubleshooting

Timeout Settings

  • Field: API Timeout
  • Description: API request timeout in seconds
  • Default: 30
  • Range: 10-120

Retry Settings

  • Field: Retry Attempts
  • Description: Number of retry attempts for failed requests
  • Default: 3
  • Range: 1-5

Testing Configuration

Test Mode Setup

  1. Enable Test Mode: Check "Test Mode" in API Settings
  2. Use Test Credentials: Use sandbox API credentials
  3. Test Payments: Make test payments with test phone numbers
  4. Verify Callbacks: Ensure callbacks are received

Test Phone Numbers

  • MTN: 0541234567
  • Telecel: 0201234567
  • AirtelTigo: 0271234567

Test Card Numbers

  • Visa: 4111111111111111
  • Mastercard: 5555555555554444
  • Expiry: Any future date
  • CVV: Any 3-digit number

Production Configuration

Going Live Checklist

  • Test mode disabled
  • Production API credentials entered
  • SSL certificate installed
  • Callback URL tested
  • SMS notifications tested
  • All payment methods tested
  • Order status mapping verified
  • Logging enabled
  • Backup created

Security Checklist

  • Strong API credentials
  • SSL certificate valid
  • Callback security enabled
  • Admin access restricted
  • Regular security updates
  • Monitoring enabled

Troubleshooting

Common Configuration Issues

Issue: API credentials not working

Solution: Verify credentials with Bridge support

Issue: Callbacks not received

Solution: Check callback URL accessibility and SSL

Issue: SMS not sending

Solution: Verify sender ID and SMS balance

Issue: Payment methods not showing

Solution: Check payment method enablement and currency

Configuration Validation

The plugin validates your configuration and shows warnings for:

  • Missing required fields
  • Invalid API credentials
  • Inaccessible callback URL
  • Invalid sender ID
  • Unsupported currencies

Getting Help

If you need help with configuration:

  1. Check the validation messages
  2. Review this documentation
  3. Contact support@thebridgesolutions.com
  4. Include your configuration details (without credentials)