HighLevel: Get Transaction by ID

← Payments operations · Get started

Operation gohighlevel.get_transaction_by_id

Provider route: GET /payments/transactions/{transactionId}. 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"]["getTransactionById"]>[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.getTransactionById(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.get_transaction_by_id(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.transactionId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Optional
query.altId	string	Required within parent
query.altType	string	Required within parent

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 Get Transaction by ID — response body

Referenced models: Get Transaction by ID — response body

Schemas

Get Transaction by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the transaction.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Transaction value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountRefunded	JSON	Optional
amountRefunded (anyOf 1)	number	Alternative	Transaction amount refunded.
amountRefunded (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
chargeId	string	Optional	Charge id for transaction.
chargeSnapshot	object	Optional	Charge snapshot of transaction.
contactId	string	Optional	Contact id corresponding to the transaction.
contactSnapshot	object	Optional	Contact details of the transaction.
createdAt	string	Required within parent	The creation timestamp of the transaction. Format: date-time
createdBy	string	Optional	User ID who created the transaction.
currency	string	Optional	Currency in which transaction was made.
entityId	string	Optional	Entity id for the transaction. e.g: order id
entitySource	JSON	Optional	Entity source details for the transaction.
entitySource (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
entityType	string	Optional	Entity type of transaction (eg: order).
invoiceId	string	Optional	Invoice id for the transaction.
ipAddress	string	Optional	Ip address from where transaction was initiated.
isParent	boolean	Optional	Is parent transaction.
liveMode	boolean	Optional	Transaction is in live / test mode.
markAsTest	boolean	Optional	Is test transaction.
mergedFromContactId	string	Optional	ID of the contact that was merged from.
meta	object	Optional	Meta details of the transaction.
paymentProvider	object	Optional	Payment provider details of the transaction.
qboResponse	object	Optional	Qbo details of the transaction.
qboSynced	boolean	Optional	Is transaction qbo synced.
receiptId	string	Optional	Receipt id for transaction.
status	object	Optional	Transaction status.
subscriptionId	string	Optional	Subscription id for transaction.
traceId	string	Optional	Trace id of the transaction.
updatedAt	string	Required within parent	The last update timestamp of the transaction. Format: date-time

Referenced models: Get Order by ID — response body — source id, meta, name, sub Type, type

Get Order by ID — response body — source id, meta, name, sub Type, type

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent
meta	object	Optional
name	string	Optional
subType	string	Optional	Known values: one_step_order_form, two_step_order_form, upsell, tap_to_pay, card_payment, store, contact_view, email_campaign, payments_dashboard, shopify, subscription_view, store_upsell, woocommerce, service, meeting, imported_csv, qr_code, saas_one_time, saas_subscription
type	string	Required within parent	Known values: funnel, website, invoice, calendar, text2Pay, document_contracts, membership, mobile_app, communities, point_of_sale, manual, form, survey, payment_link, external

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_transaction_by_id. Catalog operation: get-transaction-by-id. 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/transactions.readonly"]

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

Official provider source