HighLevel: Record Order Payment

← Payments operations · Get started

Operation gohighlevel.record_order_payment

Provider route: POST /payments/orders/{orderId}/record-payment. 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"]["recordOrderPayment"]>[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.recordOrderPayment(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.record_order_payment(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.orderId	string	Required within parent
body	Model	Required within parent	Expand Record Order Payment — request body — body

Referenced models: Record Order Payment — 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 Record Order Payment — response body

Referenced models: Record Order Payment — response body

Schemas

Record Order Payment — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Success status of the request

Record Order Payment — 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
amount	number	Optional	Amount to be paid against the invoice.
card	JSON	Optional	Details of Card if used for payment
card (allOf 1)	Model	All variants apply	Expand Record Order Payment — request body — body / card / type: visa, mastercard, other
cheque	JSON	Optional	Details of the Cheque if used for payment
cheque (allOf 1)	Model	All variants apply	Expand Record a manual payment for an invoice — request body — body cheque
isPartialPayment	boolean	Optional	Indicates if the order is intended to be a partial payment.
meta	object	Optional	Meta data to be recorded with the transaction
mode	string	Required within parent	manual payment method One of: cash, card, cheque, bank_transfer, other
notes	string	Optional	Any note to be recorded with the transaction

Referenced models: Record a manual payment for an invoice — request body — body cheque, Record Order Payment — request body — body / card / type: visa, mastercard, other

Record a manual payment for an invoice — request body — body cheque

Field	Type	Presence	Description and constraints
$	object	Root
number	string	Required within parent	check number

Record Order Payment — request body — body / card / type: visa, mastercard, other

Field	Type	Presence	Description and constraints
$	object	Root
last4	string	Required within parent	Last 4 digit of the card
type	string	Required within parent	One of: visa, mastercard, other

Policy, approvals and errors

SDK function policy ID: gohighlevel.record_order_payment. Catalog operation: record-order-payment. 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/orders.collectPayment"]

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

Official provider source