HighLevel · Schema

GetTxnResponseSchema

CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation

Properties

Name Type Description
_id string The unique identifier for the transaction.
altType string AltType is the type of identifier.
altId string AltId is the unique identifier eg: location id.
contactId string Contact id corresponding to the transaction.
contactSnapshot object Contact details of the transaction.
currency string Currency in which transaction was made.
amount number Transaction value.
status object Transaction status.
liveMode boolean Transaction is in live / test mode.
createdAt string The creation timestamp of the transaction.
updatedAt string The last update timestamp of the transaction.
entityType string Entity type of transaction (eg: order).
entityId string Entity id for the transaction. e.g: order id
entitySource object Entity source details for the transaction.
chargeId string Charge id for transaction.
chargeSnapshot object Charge snapshot of transaction.
invoiceId string Invoice id for the transaction.
subscriptionId string Subscription id for transaction.
paymentProvider object Payment provider details of the transaction.
ipAddress string Ip address from where transaction was initiated.
meta object Meta details of the transaction.
markAsTest boolean Is test transaction.
isParent boolean Is parent transaction.
amountRefunded number Transaction amount refunded.
receiptId string Receipt id for transaction.
qboSynced boolean Is transaction qbo synced.
qboResponse object Qbo details of the transaction.
traceId string Trace id of the transaction.
mergedFromContactId string ID of the contact that was merged from.
createdBy string User ID who created the transaction.
View JSON Schema on GitHub

JSON Schema

highlevel-get-txn-response-schema-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-get-txn-response-schema-schema.json",
  "title": "GetTxnResponseSchema",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/highlevel-payments-openapi.json#/components/schemas/GetTxnResponseSchema",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "The unique identifier for the transaction."
    },
    "altType": {
      "type": "string",
      "description": "AltType is the type of identifier."
    },
    "altId": {
      "type": "string",
      "description": "AltId is the unique identifier eg: location id."
    },
    "contactId": {
      "type": "string",
      "description": "Contact id corresponding to the transaction."
    },
    "contactSnapshot": {
      "type": "object",
      "description": "Contact details of the transaction."
    },
    "currency": {
      "type": "string",
      "description": "Currency in which transaction was made."
    },
    "amount": {
      "type": "number",
      "description": "Transaction value."
    },
    "status": {
      "type": "object",
      "description": "Transaction status."
    },
    "liveMode": {
      "type": "boolean",
      "description": "Transaction is in live / test mode."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "The creation timestamp of the transaction."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "The last update timestamp of the transaction."
    },
    "entityType": {
      "type": "string",
      "description": "Entity type of transaction (eg: order)."
    },
    "entityId": {
      "type": "string",
      "description": "Entity id for the transaction. e.g: order id"
    },
    "entitySource": {
      "description": "Entity source details for the transaction.",
      "allOf": [
        {
          "$ref": "#/$defs/OrderSource"
        }
      ]
    },
    "chargeId": {
      "type": "string",
      "description": "Charge id for transaction."
    },
    "chargeSnapshot": {
      "type": "object",
      "description": "Charge snapshot of transaction."
    },
    "invoiceId": {
      "type": "string",
      "description": "Invoice id for the transaction."
    },
    "subscriptionId": {
      "type": "string",
      "description": "Subscription id for transaction."
    },
    "paymentProvider": {
      "type": "object",
      "description": "Payment provider details of the transaction."
    },
    "ipAddress": {
      "type": "string",
      "description": "Ip address from where transaction was initiated."
    },
    "meta": {
      "type": "object",
      "description": "Meta details of the transaction."
    },
    "markAsTest": {
      "type": "boolean",
      "description": "Is test transaction."
    },
    "isParent": {
      "type": "boolean",
      "description": "Is parent transaction."
    },
    "amountRefunded": {
      "type": "number",
      "description": "Transaction amount refunded."
    },
    "receiptId": {
      "type": "string",
      "description": "Receipt id for transaction."
    },
    "qboSynced": {
      "type": "boolean",
      "description": "Is transaction qbo synced."
    },
    "qboResponse": {
      "type": "object",
      "description": "Qbo details of the transaction."
    },
    "traceId": {
      "type": "string",
      "description": "Trace id of the transaction."
    },
    "mergedFromContactId": {
      "type": "string",
      "description": "ID of the contact that was merged from."
    },
    "createdBy": {
      "type": "string",
      "description": "User ID who created the transaction."
    }
  },
  "required": [
    "_id",
    "altType",
    "altId",
    "createdAt",
    "updatedAt"
  ],
  "$defs": {
    "OrderSource": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "funnel",
            "website",
            "invoice",
            "calendar",
            "text2Pay",
            "document_contracts",
            "membership",
            "mobile_app",
            "communities",
            "point_of_sale",
            "manual",
            "form",
            "survey",
            "payment_link",
            "external"
          ]
        },
        "subType": {
          "type": "string",
          "enum": [
            "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"
          ]
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "meta": {
          "type": "object"
        }
      },
      "required": [
        "type",
        "id"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/highlevel-get-txn-response-schema"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.