CreateCustomProvidersResponseSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-create-custom-providers-response-schema-schema.json",
  "title": "CreateCustomProvidersResponseSchema",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/highlevel-payments-openapi.json#/components/schemas/CreateCustomProvidersResponseSchema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom provider"
    },
    "description": {
      "type": "string",
      "description": "Description of payment gateway. Shown on the payments integrations page as subtext"
    },
    "paymentsUrl": {
      "type": "string",
      "description": "This url will be loaded in iFrame to start a payment session."
    },
    "queryUrl": {
      "type": "string",
      "description": "The url used for querying payments related events. Ex. verify, refund, subscription etc."
    },
    "imageUrl": {
      "type": "string",
      "description": "Public image url for logo of the payment gateway displayed on the payments integrations page."
    },
    "_id": {
      "type": "string",
      "description": "The unique identifier for the custom provider."
    },
    "locationId": {
      "type": "string",
      "description": "Location id"
    },
    "marketplaceAppId": {
      "type": "string",
      "description": "The application id of marketplace"
    },
    "paymentProvider": {
      "type": "object",
      "description": "Payment provider details."
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the config is deleted or not. true represents config is deleted"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "The creation timestamp of the custom provider."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "The last update timestamp of the custom provider."
    },
    "traceId": {
      "type": "string",
      "description": "Trace id of the custom provider."
    }
  },
  "required": [
    "name",
    "description",
    "paymentsUrl",
    "queryUrl",
    "imageUrl",
    "_id",
    "locationId",
    "marketplaceAppId",
    "deleted",
    "createdAt",
    "updatedAt"
  ]
}