payments_record_order_payment
Record payments against orders in GoHighLevel, supporting cash, card, cheque, or bank transfer, including partial payments and transaction notes.
Instructions
Record Order Payment
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": {
"orderId": "<orderId>",
"mode": "<mode>"
},
"name": "payments_record_order_payment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | No | Details of Card if used for payment | |
| meta | No | Meta data to be recorded with the transaction | |
| mode | Yes | manual payment method | |
| altId | No | location Id / company Id based on altType Defaults to GHL_LOCATION_ID when omitted. | |
| notes | No | Any note to be recorded with the transaction | |
| amount | No | Amount to be paid against the invoice. | |
| cheque | No | Details of the Cheque if used for payment | |
| altType | No | Alt Type Defaults to GHL_LOCATION_ID when omitted. | |
| orderId | Yes | Order ID | |
| isPartialPayment | No | Indicates if the order is intended to be a partial payment. |