Skip to main content
GHL MCP Guide
CPC

Custom Provider Config

Payments & Billing · Advanced · Updated March 2026

Get, create, and disconnect configuration settings for custom payment providers including API keys, webhooks, and connection parameters.

Custom Provider Config manages the operational settings for custom payment providers. After registering a provider through Custom Providers, this is where you set up the API credentials, webhook endpoints, and connection parameters that make it functional.

What This MCP Tool Does

This tool handles the configuration layer for custom payment providers. Get current configuration, create new configurations with credentials, and disconnect configurations when providers are being removed. This is the activation step that turns a registered provider into a working payment processor.

Endpoint Reference

Get provider configuration: GET /payments/custom-provider/{providerId}/config Retrieve current configuration settings for a custom provider.

Create provider configuration: POST /payments/custom-provider/{providerId}/config Set up API credentials, webhook URLs, and connection parameters for the provider.

Disconnect provider configuration: DELETE /payments/custom-provider/{providerId}/config Remove the configuration, effectively deactivating the provider.

Authentication

Requires a Private Integration Token (PIT) with the payments scope enabled.

Key Parameters

When creating a configuration:

  • API keys or authentication tokens for the payment provider
  • Webhook endpoint URLs for transaction notifications
  • Connection parameters specific to the provider type
  • Environment setting (live vs. test mode)

Important Notes

Configuration involves sensitive credentials. API keys for payment providers have direct access to financial operations. Handle them with the same security discipline as bank account credentials.

Test your configuration in sandbox/test mode before going live. Process test transactions to verify the full flow: payment initiation, processing, confirmation, and webhook notification.

Disconnecting a configuration deactivates the provider without deleting it. The provider registration through Custom Providers remains intact. You can reconfigure later without re-registering.

Common Questions

What happens to active transactions if I disconnect a configuration? Existing completed transactions are unaffected. Pending transactions and active subscriptions through the provider will fail once the configuration is disconnected.

Can I switch between test and live mode? Update the configuration with different credentials for each environment. Never use test credentials in production or live credentials in testing.

How do I troubleshoot failed transactions? Check the webhook delivery logs, verify API credentials are current, and confirm the provider’s API is operational. Transaction failures typically stem from expired credentials, network issues, or provider-side rejections.

Back to GHL MCP Guide