ghl_payment_transaction_list
Lists payment transactions with pagination and filters for name, status, date range, contact, subscription, and source type, enabling targeted transaction retrieval.
Instructions
List Transactions 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. Endpoint: GET /payments/transactions (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/transactions.readonly Pagination params: limit, offset — pass them to page through full result sets.
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": {
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_payment_transaction_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | AltId is the unique identifier e.g: location id. | |
| endAt | No | Closing interval of transactions. | |
| limit | No | The maximum number of items to be included in a single page of results | |
| offset | No | The starting index of the page, indicating the position from which the results should be retrieved. | |
| search | No | The name of the transaction for searching. | |
| altType | Yes | AltType is the type of identifier. | |
| startAt | No | Starting interval of transactions. | |
| entityId | No | Entity id for filtering of transactions. | |
| contactId | No | Contact id for filtering of transactions. | |
| locationId | No | LocationId is the id of the sub-account. | |
| paymentMode | No | Mode of payment. | |
| subscriptionId | No | Subscription id for filtering of transactions. | |
| entitySourceType | No | Source of the transactions. | |
| entitySourceSubType | No | Source sub-type of the transactions. |