ghl_payment_order_get
Retrieve details for a single payment order by its unique ID. Fetch order information using the order ID and location token for sub-account access.
Instructions
Get Order by ID The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID. Endpoint: GET /payments/orders/{orderId} (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/orders.readonly
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>",
"altId": "<altId>"
},
"name": "ghl_payment_order_get"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | AltId is the unique identifier e.g: location id. | |
| orderId | Yes | ID of the order that needs to be returned | |
| locationId | No | LocationId is the id of the sub-account. |