HighLevel: Create White-label Integration Provider

← Payments operations · Get started

Operation gohighlevel.create_integration_provider

Provider route: POST /payments/integrations/provider/whitelabel. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["payments"]["createIntegrationProvider"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.payments.createIntegrationProvider(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments.create_integration_provider(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create White-label Integration Provider — request body — body

Referenced models: Create White-label Integration Provider — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create White-label Integration Provider — response body

Referenced models: Create White-label Integration Provider — response body

Schemas

Create White-label Integration Provider — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
description	string	Required within parent	A brief description providing additional information about the integration provider.
imageUrl	string	Required within parent	The URL to an image representing the integration provider. The imageUrl should start with "https://" and ensure that this URL is publicly accessible.
provider	string	Required within parent	The type of payment provider associated with the integration provider. One of: authorize-net, nmi
title	string	Required within parent	The title or name of the integration provider.
uniqueName	string	Required within parent	A unique name given to the integration provider, uniqueName must start and end with a character. Only lowercase characters and hyphens (-) are supported

Create White-label Integration Provider — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier of the integration provider.
altId	string	Required within parent	The altId / locationId of the integration provider.
altType	string	Required within parent	The altType of the integration provider.
createdAt	string	Required within parent	The timestamp when the integration provider was created. Format: date-time
description	string	Required within parent	A brief description providing additional information about the integration provider.
imageUrl	string	Required within parent	The URL to an image representing the integration provider.
provider	string	Required within parent	The payment provider associated with the integration provider.
route	string	Required within parent	The route name associated with the integration provider.
title	string	Required within parent	The title or name of the integration provider.
updatedAt	string	Required within parent	The timestamp when the integration provider was last updated. Format: date-time

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_integration_provider. Catalog operation: create-integration provider. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["payments/integration.write"]

Pinned headers: {"Version": "v3"}

Official provider source