payments_create_integration
Register a custom payment provider with name, description, payment/query URLs, logo, and subscription schedule flag. This makes it available on the payments integrations page.
Instructions
Create new integration
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"description": "<description>",
"paymentsUrl": "<paymentsUrl>",
"queryUrl": "<queryUrl>",
"imageUrl": "<imageUrl>",
"supportsSubscriptionSchedule": "<supportsSubscriptionSchedule>"
},
"name": "payments_create_integration"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the custom provider | |
| imageUrl | Yes | Public image url for logo of the payment gateway displayed on the payments integrations page. | |
| queryUrl | Yes | The url used for querying payments related events. Ex. verify, refund, subscription etc. | |
| locationId | No | Location id Defaults to GHL_LOCATION_ID when omitted. | |
| description | Yes | Description of payment gateway. Shown on the payments integrations page as subtext | |
| paymentsUrl | Yes | This url will be loaded in iFrame to start a payment session. | |
| supportsSubscriptionSchedule | Yes | Whether the config supports subscription schedule or not. true represents config supports subscription schedule |