Skip to content

Retrieve transactions with product details

posthttps://report.tranzila.com/v1/transaction

Returns a paginated list of transactions for the specified terminal, optionally including product line-item data.

Retrieval Methods

You must supply one of the following:

  • Date range — provide both transaction_start_date and transaction_end_date
  • Transaction index — provide transaction_index to retrieve a single specific transaction

These two methods are mutually exclusive.

Pagination

Date range queries return a maximum of page_results rows per page (default: 1,000). If the result set exceeds this, use the page parameter to retrieve subsequent pages.

Advanced Filtering Example

The following request retrieves all forced transactions (txn_type = FORCE) with an amount of 500 or more, where the contact user-defined field starts with a specific name prefix:

JSON
{
  "terminal_name": "yourTerminalName",
  "detailed": "Y",
  "ufields": [
    {
      "name": "contact",
      "operator": "starts_with",
      "value": "Cohen"
    }
  ],
  "dfields": [
    {
      "name": "txn_type",
      "operator": "equals",
      "value": "FORCE"
    },
    {
      "name": "amount",
      "operator": ">=",
      "value": "500"
    }
  ]
}

All three conditions must match simultaneously.

Request

Body

application/json
terminal_namestringrequired

Your Tranzila terminal name

Example:yourTerminalName
transaction_indexinteger

**Conditionally required** (if not using date range). The unique numeric index of a single transaction to retrieve.

Example:41711
transaction_start_datestring<date>

**Conditionally required** (if not using transaction_index). Start of date range. Format: `YYYY-MM-DD`.

Example:2024-01-01
transaction_end_datestring<date>

**Conditionally required** (if not using transaction_index). End of date range (inclusive). Format: `YYYY-MM-DD`.

Example:2024-01-31
detailedstring

When set to `Y`, the response includes the `items` array with product line-item details for each transaction.

Allowed values:YN
Example:Y
pageinteger

Page number for pagination. Use when a date range returns more rows than `page_results`.

Example:1
page_resultsinteger

Number of results to return per page. Default is 1,000.

Example:1000
order_directionstring

Sort order by transaction date. Default is `desc` (newest first).

Allowed values:descasc
Example:desc
ufieldsarray[UFieldFilter]

Filter by user-defined fields. Each entry is an AND condition. All user-defined fields are type `string`. Use string operators only: `equals`, `contains`, `starts_with`, `ends_with`. Use `/v1/terminals/settings/fields/list` to retrieve valid `name` values for your terminal.

dfieldsarray[DFieldFilter]

Filter by core transaction fields. Each entry is an AND condition. Operator must match the field's data type: - **String fields:** `equals`, `contains`, `starts_with`, `ends_with` - **Number fields:** `=`, `>`, `<`, `>=`, `<=`

Responses

Successful response — returns matching transactions

Response body

response.json
JSON
1{
2  "transactions": [
3    {
4      "index": 41711,
5      "transaction_date": "2025-10-29",
6      "transaction_time": "12:02:24",
7      "amount": 500,
8      "credit_card_token": "ab7969f6582d29a5409",
9      "expiration_month": "06",
10      "expiration_year": "29",
11      "credit_card_owner_id": "",
12      "card_issuer": 2,
13      "card_description": "ויזה רגיל",
14      "card_brand": 2,
15      "clearing_processor": 2,
16      "is_foreign": 0,
17      "authorization_number": 147934,
18      "bank": null,
19      "bank_branch": null,
20      "bank_account": null,
21      "payment_plan": 1,
22      "currency": "1",
23      "number_of_payments": 0,
24      "first_payment_amount": 0,
25      "other_payment_amount": 0,
26      "host_ip": "80.244.170.32",
27      "processor_response_code": "000",
28      "tranmode": "F",
29      "refnr": "56510713",
30      "tempref": "46001008",
31      "xid": "",
32      "cavv": "",
33      "eci": "",
34      "child_terminal": "yourTerminalName",
35      "uid": "25102911404490383603746",
36      "transtatus": 1,
37      "telauthability": 1,
38      "txnfdid": 6486,
39      "cancelfdid": null,
40      "txnfdnumber": 1000093,
41      "cancelfdnumber": null,
42      "txn_payment_method": "CC",
43      "txn_type": "FORCE",
44      "pan_entry_mode": "50",
45      "processor": "SHVA",
46      "broker": "",
47      "broker_product": "",
48      "user_defined_1": "",
49      "user_defined_2": "",
50      "user_defined_3": "",
51      "user_defined_4": "",
52      "user_defined_5": "",
53      "user_defined_6": "",
54      "user_defined_7": "",
55      "user_defined_8": "",
56      "user_defined_9": "",
57      "user_defined_10": "",
58      "user_defined_11": "",
59      "user_defined_12": "",
60      "user_defined_13": "",
61      "user_defined_14": "",
62      "user_defined_15": "",
63      "user_defined_16": "",
64      "user_defined_17": "",
65      "user_defined_18": "",
66      "user_defined_19": "",
67      "user_defined_20": "",
68      "user_defined_21": "",
69      "user_defined_22": "",
70      "user_defined_23": "",
71      "user_defined_24": "",
72      "user_defined_25": "",
73      "items": [
74        {
75          "item_id": 67099484,
76          "item_name": "Capture",
77          "quantity": "1.00",
78          "price": 500,
79          "item_type": "I"
80        }
81      ]
82    }
83  ],
84  "total": "54",
85  "rows": 1
86}
87
Was this page helpful?