# Examples of Transaction Inquiries This page provides several examples of using the `inquireTransactions` command with different identifiers, as well as with date ranges. ## Using the "cgUid" identifier When you send an inquiry request using the `cgUid` identifier, the Hyp API returns all technical transactions related to the same financial transaction. This includes payment page requests. Normally, you can retrieve a `cgUid` value from the query string parameters in the [payment completion redirect](/enterprise/payment-page-integration/integrating-hyps-payment-page-and-accepting-payment.md#handle-payment-completion-redirect). If you then use this value for a transaction inquiry, Hyp will return two `transaction` elements in the response: one for the initial payment page request and another for the actual debit transaction. Another example would be a debit transaction that is later [refunded](/enterprise/additional-payment-scenarios/refunds-and-cancellations.md): both the debit and the refund request will share the same `cgUid` value. Suppose that after a successful payment using Hyp's payment page, you as a merchant receive and save a `cgUid` value of `119187087`. You can then use this value to inquire about all transactions related to this identifier by including the following XML payload in the `int_in` parameter: ```xml 2000 ENG inquireTransactions {terminalNumber} 119187087 ``` The response will include two transactions: one representing the initial payment page request (where the `validation` element has the value `TxnSetup`) and the other representing a one-phase sale (where `validation` is set to `AutoComm`).

Show response

```xml inquireTransactions 2025-08-04 15:15 119253309 000 Permitted transaction Permitted transaction 2000 Eng 000 Permitted transaction 0882819014 CG CGGMPI 5 xGMPI Credit RegularDebit Payments ILS Internet 35000 10 TxnSetup MPIServer 119187087 Jenny Parkington 100 Permitted transaction Permitted transaction 4da3e4c4-c594-4362-baf7-fa2286f8655e Other 119187087 2025-07-31 22:21:18 000 Permitted transaction 0882819014 1092880571131111 411111 411111******1111 16 xxxxxxxxxxxx1111 0328 Foreign Credit Foreign Visa Alphacard RegularDebit RegularCredit ILS Internet 35000 0 AutoComm Absent NotValidated CreditCompany 4760370 95 085 760 7 300012 119187087 Jenny Parkington 350521607519 4121 25073122213808828190927 NoAuthNumber CreditCompanyAuthorized 0 100 100 Permitted transaction Permitted transaction 4da3e4c4-c594-4362-baf7-fa2286f8655e Transmitted 119187092 085760 2025-07-31 22:21:38 2025-07-31 23:02:27 04382356 1587949 2 2 ```

## Using the "tranId" identifier If you're using the `tranId` identifier for a transaction inquiry, you will always receive a single `transaction` element in the response. This is because `tranId` is a unique identifier for each technical transaction processed by Hyp, and it is never shared across multiple steps of a financial transaction. `tranId` is not returned in the query string of the payment completion redirect. Instead, you need to retrieve it from the response to a transaction inquiry that uses a different search criterion, such as `cgUid` or `user`. Here is a sample XML payload you can pass in the `int_in` parameter to search by a `tranId` value of `119187092`: ```xml 2000 ENG inquireTransactions {terminalNumber} 119187092 ``` The response will include exactly one transaction:

Show response

```xml inquireTransactions 2025-08-04 15:35 119253896 000 Permitted transaction Permitted transaction 2000 Eng 000 Permitted transaction 0882819014 1092880571131111 411111 411111******1111 16 xxxxxxxxxxxx1111 0328 Foreign Credit Foreign Visa Alphacard RegularDebit RegularCredit ILS Internet 35000 0 AutoComm Absent NotValidated CreditCompany 4760370 95 085 760 7 300012 119187087 Jenny Parkington 350521607519 4121 25073122213808828190927 NoAuthNumber CreditCompanyAuthorized 0 100 100 Permitted transaction Permitted transaction 4da3e4c4-c594-4362-baf7-fa2286f8655e Transmitted 119187092 085760 2025-07-31 22:21:38 2025-07-31 23:02:27 04382356 1587949 1 1 ```

## Using the "user" field It's a good practice to include a unique identifier in the `user` field of all your [payment page requests](/enterprise/payment-page-integration/integrating-hyps-payment-page-and-accepting-payment.md). This value should match the user ID from your customer database or another internal system. Note that this approach only works if the user ID is no more than 19 digits long. If you follow this practice, you can use the `user` field as a lookup element when performing transaction inquiries: ```xml 2000 ENG inquireTransactions {terminalNumber} 1eee7e8a-b1f2-4b5c ``` This user has only made one online purchase, so the response will include two transactions: one for the initial payment page request, and another for the one-phase sale.

Show response

```xml inquireTransactions 2025-08-05 21:52 119284870 000 Permitted transaction Permitted transaction 2000 Eng 000 Permitted transaction 0882819014 CG CGGMPI 5 xGMPI Credit RegularDebit RegularCredit ILS Internet 10300 TxnSetup MPIServer 1eee7e8a-b1f2-4b5c 119284853 Jenny Parkington 100 Permitted transaction Permitted transaction 2b03f7c3-fbc4-4ad7-9787-e9ff90080d6a Other 119284853 2025-08-05 21:50:25 000 Permitted transaction 0882819014 1092880571131111 411111 411111******1111 16 xxxxxxxxxxxx1111 0428 Foreign Credit Foreign Visa Alphacard RegularDebit RegularCredit ILS Internet 10300 0 AutoComm Absent NotValidated CreditCompany 4501769 90 085 984 7 1eee7e8a-b1f2-4b5c 300012 119284853 Jenny Parkington 433941177866 4121 25080521503808828198612 NoAuthNumber CreditCompanyAuthorized 0 100 100 Permitted transaction Permitted transaction 2b03f7c3-fbc4-4ad7-9787-e9ff90080d6a Captured 119284861 085984 2025-08-05 21:50:38 3 3 ```

## Using a date range The `inquireTransactions` command supports search by one of three pairs of lookup elements representing date ranges: * `fromDealDate` and `toDealDate` to search for transactions by the date they were performed by Hyp. * `fromTransmitDate` and `toTransmitDate` to search by the date they were transmitted to Shva. * `fromShiftTxnDate` and `toShiftTxnDate` to search by the `ShiftTxnDate` field in the original transaction request. In all cases, you must specify both the `from` and `to` elements. By default, Hyp allows date ranges of up to 10 days. For example, to search for transactions performed by Hyp between August 1 and August 8, 2025, include the `fromDealDate` and `toDealDate` elements in your XML payload like this: ```xml 2025-08-01 2025-08-08 ... ``` The date ranges are inclusive. If you need to search for transactions within a single day, simply set both the `from` and `to` elements to the same date. Date range–based inquiries may return many results. For performance reasons, it's recommended to use pagination in these cases. For a full example of a paginated date range search, see [Pagination in Transaction Inquiries](/enterprise/inquiring-transactions/inquire-transactions-with-pagination.md). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.hyp.co.il/enterprise/inquiring-transactions/examples.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.