Retrieving Transaction Details by External Transaction ID (Query Transaction By ExternalUniqTranId)
When should this function be used?
This function is recommended when a business uses the Do Transaction function to charge tokens or credit card details and wants to find transactions made with a specific external ID.
What does this function return?
This function provides the same data available through the List of Transactions function.
It provides details about the transaction associated with a specific external ID, including credit card details, the generated token, customer details, the number of the document issued, and more.
Below is a link to the JSON function.
Request method: POST.
Query Transaction By ExternalUniqTranId
https://secure.cardcom.solutions/api/v11/Transactions/GetTransactionByExternalUniqTran
The following parameters must be passed to the Query Transaction By ExternalUniqTranId function.
Legend:
Red parameter - required
Bold parameter - recommended
Parameter that is neither red nor bold - optional
No. | Parameter | Example values | Description |
1 | TerminalNumber | 1000 | Terminal number - the internal terminal number, not the SW terminal number. |
2 | ApiName | "test2025" | API name. |
3 | ExternalUniqTranId | "h9rZs#4VxTp!7kLb0wUeG3zC" | Unique external transaction ID. The value of this parameter is returned by the Do Transaction function. |
Query Transaction By ExternalUniqTranId RESPONSE
No. | Parameter | Example values | Description |
1 | ResponseCode | 0 | Response code. If it equals zero, the function was executed successfully. Any other response indicates that the operation was unsuccessful. |
2 | Description | "OK" | Response description. “OK” indicates success. |
3 | TranzactionId | 203990118 | Internal transaction number. |
4 | TerminalNumber | 1001 | Terminal number. |
5 | Amount | 500 | Transaction amount. |
6 | CoinId | 1 - Shekel 2 - Dollar For additional currency codes - Currency Code List | Transaction currency. |
7 | CouponNumber | 38022395 | Voucher number on the receipt slip. It can sometimes be used for reconciliation. |
8 | CreateDate | "2025-03-12T08:46:45" | Transaction creation date. |
9 | Last4CardDigits | 5796 | Last four digits of the card. INT |
10 | Last4CardDigitsString | "5796" | Last four digits of the card. String. |
11 | FirstCardDigits | 440066 | First six digits. |
12 | JParameter | 0 - Default according to the credit card companies' settings. 2 - Verification of the check digit only. 5 - Obtaining approval from the credit card companies. | J parameter - type of verification to perform on the card. |
13 | CardMonth | 12 | Card expiration month. |
14 | CardYear | 2021 | Card expiration year. |
15 | ApprovalNumber | 009491B | Approval number. Essential in the case of J5. If J5 was used and the business wants to charge the held amount later, the approval number is required. |
16 | FirstPaymentAmount | 50.00 | First payment amount. |
17 | ConstPaymentAmount | 20.00 | Amount of each additional payment. |
18 | NumberOfPayments | 5 | Number of payments. |
19 | CardInfo | "Israeli" | Card type. |
20 | CardOwnerName | "daniel" | Cardholder name. |
21 | CardOwnerPhone | "0522222222" | Cardholder phone number. |
22 | CardOwnerEmail | "test@gmail.com" | Cardholder email address. |
23 | CardOwnerIdentityNumber | "213654987" | Cardholder national ID number. |
24 | Token | "4cf8e168-261e-4613-8d20-000332986b24" | Token number. Be sure to save it in the database. |
25 | CardName | "Regular Visa" | Card name. |
26 | SapakMutav | 1234 | Customer number in the multi-beneficiary system. |
27 | Uid | "21121517002429612920744" | Unique transaction identifier. If a chargeback, refund, or cancellation is performed from the transaction, the UID of the new action will be identical to that of the original transaction. If a refund is performed outside the transaction, for example as a new transaction using a token, the UID will be new. |
28 | ConcentrationNumber | "6518" | Deposit/concentration number. |
29 | DocumentNumber | 300394 | Document number. |
30 | DocumentType | "NULL" - No document issued. "TaxInvoiceAndReceipt" - Tax invoice and receipt "TaxInvoiceAndReceiptRefund" - Credit invoice and refund "Receipt" - Non-VAT receipt "ReceiptRefund" - Non-VAT credit receipt (refund) "Quote" - Quote "Order" - Order "OrderConfirmation" - Order confirmation from the website "OrderConfirmationRefund" - Credit for website order confirmation "DeliveryNote" - Delivery note "DeliveryNoteRefund" - Return note "ProformaInvoice" - Transaction invoice "DemandForPayment" - Demand for payment "DemandForPaymentRefund" - Cancellation of demand for payment "ProformaDealInvoice" - Pro forma transaction receipt "ProformaDealInvoiceRefund" - Credit for pro forma transaction receipt "TaxInvoice" - Tax invoice "ProformaInvoiceRefund" - Credit for transaction invoice "TaxInvoiceRefund" - Credit tax invoice "ReceiptForTaxInvoice" - Receipt for a tax invoice "DonationReceipt" - Donation receipt "DonationReceiptRefund" - Credit donation receipt (refund) "ReceiptForTaxInvoiceRefund" - Customer refund (credit receipt) | Document type. |
31 | Rrn | "500301575449" | Identification number at the credit card companies. |
32 | Brand | "PrivateCard" "MasterCard" "Visa" "Maestro" "AmericanExpress" "Isracard" "JBC" "Discover" "Diners" | Card brand. |
33 | Acquire | "Unknown" "Isracard" "CAL" "Diners" "AmericanExpress" "Laumicard" "CardCom" "PayPal" "Upay" "PayMe" | Acquiring company. |
34 | Issuer | "NonIsrael" "Isracard" "CAL" "Diners" "AmericanExpress" "JCB" "Laumicard" | Issuing company. |
35 | PaymentType | "Unknown" "Standard" "SpecialCredits" "ImmediateCharge" "CreditClub" "SuperCredit" "InstallmentCredit" "Payments" "ClubPatments" | Credit type - regular charge / payment / credit / discounting. |
36 | CardNumberEntryMode | "MagneticStip" "SelfService" "GasStationSelfService" "Contactless" "EmvContactless" "MobileContactless" "EmvMobileContactless" "MobileNumber" "Emv" "Phone" "SignatureOnly" "Internet" "Fallback" "EmptyCandidateList" | Transaction source - online / EMV / telephone, etc. |
37 | DealType | "Information" "Debit" "Discharge" "ForcedCharge" "CashBack" "CashTransaction" "Recurring" "BalanceQuery" "Cancel" "Refund" "Recharge" | Transaction type and source - cancellation / charge / standing order / refund. |
38 | IsRefund | Boolean - true / false | Whether this was a refund transaction. |
39 | DocumentUrl | Provides the document URL. | Link to the document. |
40 | CustomFields | Id - 20 Value - "value" | Values of the custom fields. |
41 | IsAbroadCard | Boolean (true/false) | Whether the card was issued outside Israel. |
Below is an example of the function together with its response.
Request for transaction details using the external ID:
{
"TerminalNumber": "1000",
"ApiName": "test2025",
"ExternalUniqTranId": "h9rZs#4VxTp!7kLb0wUeG3zrC"
}Response received for the request:
{
"ResponseCode": 0,
"Description": "The transaction was completed successfully",
"TranzactionId": 205078134,
"TerminalNumber": 1000,
"Amount": 10.0,
"CoinId": 1,
"CouponNumber": "38024885",
"CreateDate": "2025-03-24T08:45:08",
"Last4CardDigits": 0,
"Last4CardDigitsString": "0000",
"FirstCardDigits": 458000,
"JParameter": "0",
"CardMonth": 5,
"CardYear": 36,
"ApprovalNumber": "12345",
"FirstPaymentAmount": 0.0,
"ConstPaymentAmount": 0.0,
"NumberOfPayments": 1,
"CardInfo": "Israeli",
"CardOwnerName": "",
"CardOwnerPhone": "",
"CardOwnerEmail": "",
"CardOwnerIdentityNumber": "",
"Token": "4cf8e168-261e-4613-8d20-000332986b24",
"CardName": "Regular Visa",
"SapakMutav": "",
"Uid": "21121517002429612920744",
"ConcentrationNumber": null,
"DocumentNumber": 0,
"DocumentType": "Error",
"Rrn": "",
"Brand": "Visa",
"Acquire": "Laumicard",
"Issuer": "CAL",
"PaymentType": "Standard",
"CardNumberEntryMode": "Phone",
"DealType": "Debit",
"IsRefund": false,
"DocumentUrl": null,
"CustomFields": [],
"IsAbroadCard": false
}