Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

The “Get Transaction by ID” API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID. 
GET https://services.leadconnectorhq.com/payments/transactions/{transactionId}

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version de la API.

​
Path parameters

​
transactionId
string
default:"61dd0feac077f72010f78804"
required
ID of the transaction that needs to be returned

​
Query parameters

​
locationId
string
default:"3SwdhCu3svxI8AKsPJt6"
LocationId is the id of the account.
​
altId
string
default:"3SwdhCu3svxI8AKsPJt6"
required
AltId is the unique identifier e.g: account id.
​
altType
string
default:"account"
required
AltType is the type of identifier.

​
Respuestas

​
_id
string
default:"61dd0feac077f72010f78804"
required
The unique identifier for the transaction.
​
altType
string
default:"account"
required
AltType is the type of identifier.
​
altId
string
default:"3SwdhCu3svxI8AKsPJt6"
required
AltId is the unique identifier eg: account id.
​
contactId
string
default:"XPLSw2SVagl12LMDeTmQ"
Contact id corresponding to the transaction.
​
contactSnapshot
object
Contact details of the transaction.
​
currency
string
default:"USD"
Currency in which transaction was made.
​
amount
number
default:"100"
Transaction value.
​
status
object
default:"succeeded"
Transaction status.
​
liveMode
boolean
default:"false"
Transaction is in live / test mode.
​
createdAt
string
default:"2023-11-20T10:23:36.515Z"
required
The creation timestamp of the transaction.
​
updatedAt
string
default:"2024-01-23T09:57:04.846Z"
required
The last update timestamp of the transaction.
​
entityType
string
default:"order"
Entity type of transaction (eg: order).
​
entityId
string
default:"61dd0fe9c077f73e67f78803"
Entity id for the transaction. e.g: order id
​
entitySource
object
Entity source details for the transaction.
​
chargeId
string
default:"in_1KGcXDCScnf89tZohCsmImwE"
Charge id for transaction.
​
chargeSnapshot
object
Charge snapshot of transaction.
​
invoiceId
string
default:"in_1KGcXDCScnf89tZohCsmImwE"
Invoice id for the transaction.
​
subscriptionId
string
default:"sub_1KGcXDCScnf89tZoVkoEMCEL"
Subscription id for transaction.
​
paymentProvider
object
Payment provider details of the transaction.
​
ipAddress
string
default:"107.178.194.224"
Ip address from where transaction was initiated.
​
meta
object
Meta details of the transaction.
​
markAsTest
boolean
default:"false"
Is test transaction.
​
isParent
boolean
default:"false"
Is parent transaction.
​
amountRefunded
number
default:"10"
Transaction amount refunded.
​
receiptId
string
default:"6492fbea489bc07892c6defb"
Receipt id for transaction.
​
qboSynced
boolean
default:"false"
Is transaction qbo synced.
​
qboResponse
object
Qbo details of the transaction.
​
traceId
string
default:"d3b16a92-a8ed-4e6b-8467-844750f78ed5"
Trace id of the transaction.
​
mergedFromContactId
string
default:"XPLSw2SVagl12LMDeTmQ"
ID of the contact that was merged from.
​
createdBy
string
default:"user123"
User ID who created the transaction.
{
  "_id": "61dd0feac077f72010f78804",
  "altType": "account",
  "altId": "3SwdhCu3svxI8AKsPJt6",
  "contactId": "XPLSw2SVagl12LMDeTmQ",
  "contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@leadwaycrm.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
  "currency": "USD",
  "amount": "100",
  "status": "succeeded",
  "liveMode": "false",
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "entityType": "order",
  "entityId": "61dd0fe9c077f73e67f78803",
  "entitySource": "{ type: \"funnel\", id: \"BDBMEghdIUaqMPEsK349\", subType: \"two_step_order_form\", name: \"new funnel\" }",
  "chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
  "chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\",  account_name:  \"GHL-Testing\" }",
  "invoiceId": "in_1KGcXDCScnf89tZohCsmImwE",
  "subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
  "paymentProvider": "{ type: \"stripe\", connectedAccount: { _id: \"612ca676b484b241fef9d962\", accountId: \"acct_1Ihw53CScnf89tZo\" } }",
  "ipAddress": "107.178.194.224",
  "meta": "{ stepId: \"af7c731e-e36f-4152-bd1a-3f69a31d6d6d\", pageId: \"A8ltotc2jZxurJba4e3Y\", pageUrl: \"/v2/preview/A8ltotc2jZxurJba4e3Y\" }",
  "markAsTest": "false",
  "isParent": "false",
  "amountRefunded": "10",
  "receiptId": "6492fbea489bc07892c6defb",
  "qboSynced": "false",
  "qboResponse": "{ domain: \"QBO\", sparse: false, Id: \"180\", SyncToken: \"0\", TotalAmt: 25 }",
  "traceId": "d3b16a92-a8ed-4e6b-8467-844750f78ed5",
  "mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
  "createdBy": "user123"
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/payments/transactions/YOUR_transactionId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'