curl --request GET \
--url https://services.leadconnectorhq.com/payments/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"data": [
{
"_id": "61dd0feac077f72010f78804",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "location",
"status": "succeeded",
"entitySourceType": "funnel",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2023-11-20T10:23:36.515Z",
"fulfilledAt": "2023-11-20T10:27:36.515Z",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@gohighlevel.com",
"currency": "USD",
"amount": "100",
"liveMode": "false",
"entityType": "order",
"entityId": "61dd0fe9c077f73e67f78803",
"entitySourceSubType": "two_step_order_form",
"entitySourceName": "new funnel",
"entitySourceId": "BDBMEghdIUaqMPEsK349",
"entitySourceMeta": "{ domain: \"app.gohighlevel.com\", pageId: \"rBVhyYhMsbxbO8ZqOcei\", pageUrl: \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId: \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
"subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
"chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
"chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\", account_name: \"GHL-Testing\" }",
"paymentProviderType": "stripe",
"paymentProviderConnectedAccount": "612ca676b484b241fef9d962",
"ipAddress": "107.178.194.224",
"amountRefunded": "10",
"paymentMethod": "{ card: { \"brand\": \"discover\", \"last4\": \"0012\" } }",
"createdBy": "user123"
}
],
"totalCount": 123
}The “List Transactions” API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information.
curl --request GET \
--url https://services.leadconnectorhq.com/payments/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"data": [
{
"_id": "61dd0feac077f72010f78804",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "location",
"status": "succeeded",
"entitySourceType": "funnel",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2023-11-20T10:23:36.515Z",
"fulfilledAt": "2023-11-20T10:27:36.515Z",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"mergedFromContactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@gohighlevel.com",
"currency": "USD",
"amount": "100",
"liveMode": "false",
"entityType": "order",
"entityId": "61dd0fe9c077f73e67f78803",
"entitySourceSubType": "two_step_order_form",
"entitySourceName": "new funnel",
"entitySourceId": "BDBMEghdIUaqMPEsK349",
"entitySourceMeta": "{ domain: \"app.gohighlevel.com\", pageId: \"rBVhyYhMsbxbO8ZqOcei\", pageUrl: \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId: \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
"subscriptionId": "sub_1KGcXDCScnf89tZoVkoEMCEL",
"chargeId": "in_1KGcXDCScnf89tZohCsmImwE",
"chargeSnapshot": "{ id: \"in_1KGcXDCScnf89tZohCsmImwE\", object: \"invoice\", account_country: \"US\", account_name: \"GHL-Testing\" }",
"paymentProviderType": "stripe",
"paymentProviderConnectedAccount": "612ca676b484b241fef9d962",
"ipAddress": "107.178.194.224",
"amountRefunded": "10",
"paymentMethod": "{ card: { \"brand\": \"discover\", \"last4\": \"0012\" } }",
"createdBy": "user123"
}
],
"totalCount": 123
}Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
API Version
2021-07-28 LocationId is the id of the sub-account.
"3SwdhCu3svxI8AKsPJt6"
AltId is the unique identifier e.g: location id.
"3SwdhCu3svxI8AKsPJt6"
AltType is the type of identifier.
"location"
Mode of payment.
"live"
Starting interval of transactions.
"2024-02-01"
Closing interval of transactions.
"2024-02-13"
Source of the transactions.
"funnel"
Source sub-type of the transactions.
"two_step_order_form"
The name of the transaction for searching.
"Awesome transaction"
Subscription id for filtering of transactions.
"sub_1KGcXDCScnf89tZoVkoEMCEL"
Entity id for filtering of transactions.
"61dd0fe9c077f73e67f78803"
Contact id for filtering of transactions.
"XPLSw2SVagl12LMDeTmQ"
The maximum number of items to be included in a single page of results
20
The starting index of the page, indicating the position from which the results should be retrieved.
0
Was this page helpful?