קבלת פרטי עסקה לפי מזהה עסקה חיצוני - (Query Transaction By ExternalUniqTranId)
מתי להשתמש בפונקציה זו?
עדיף להשתמש בפונקציה זאת במקרה שבו בית העסק משתמש בפונקציה Do Transaction לחיוב אסימונים או פרטי אשראי ורוצה למצוא עסקאות שנעשו תחת מזהה חיצוני ספציפי.
מה מקבלים מהפונקציה הזאת?
הפונקציה הזו מספקת את אותם הנתונים שניתן לקבל בעזרת פונקציית List of Transactions.
היא מספקת פרטים אודות העסקה שקשורה למזהה חיצוני ספציפי, כולל: פרטי אשראי, טוקן שנוצר, פרטי לקוחת, מספר המסמך שהופק ועוד.
להלן קישור לפונקציה בJSON.
שיטת בקשה - POST.
Query Transaction By ExternalUniqTranId
https://secure.cardcom.solutions/api/v11/Transactions/GetTransactionByExternalUniqTran
להלן הפרמטרים שצרים להעביר בפונקציה Query Transaction By ExternalUniqTranId.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | TerminalNumber | 1000 | מספר מסוף. - מספר מסוף פנימי לא שבא |
2 | ApiName | "test2025" | שם API. |
3 | ExternalUniqTranId | "h9rZs#4VxTp!7kLb0wUeG3zC" | מזהה עסקה ייחודי חיצוני, פרמטר שהערך שלו מגיע מהפונקציה Do Transaction |
RESPONSE של Query Transaction By ExternalUniqTranId.
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ResponseCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
2 | Description | "OK" | תיאור התשובה. ''OK'' זה טוב. |
3 | TranzactionId | 203990118 | מספר עסקה פנימי. |
4 | TerminalNumber | 1001 | מספר מסוף. |
5 | Amount | 500 | מחיר עסקה. |
6 | CoinId | 1 - שקל 2 - דולר לקודי מטבע נוספים - רשימת קודי מטבעות | סוג מטבע לעסקה. |
7 | CouponNumber | 38022395 | מספר שובר של הפתקית. לפעמים יכול לשמש להתאמות |
8 | CreateDate | "2025-03-12T08:46:45" | תאריך יצירת עסקה |
9 | Last4CardDigits | 5796 | ארבע ספרות אחרונות של אשראי INT |
10 | Last4CardDigitsString | "5796" | ארבע ספרות אחרונות של אשראי string |
11 | FirstCardDigits | 440066 | שש ספרות ראשונות. |
12 | JParameter | 0 - ברירת מחדל לפי הגדרות חברות האשראי. 2 - בדיקה בלבד של ספרת ביקורת 5 - קבלת אישור מול חברות האשראי | J- פרמטר , סוג בדיקה לביצוע על הכרטיס |
13 | CardMonth | 12 | חודש כרטיס |
14 | CardYear | 2021 | שנת כרטיס |
15 | ApprovalNumber | 009491B | מספר אישור. חיוני במקרה של J5. אם יש J5 והבית עסק ירצה לחייב מאוחר יותר את מסגרת התפוסה, המספר אישור, יהיה חיוני לחיוב המסגרת. |
16 | FirstPaymentAmount | 50.00 | סכום תשלום הראשון |
17 | ConstPaymentAmount | 20.00 | סכום מספר התשלומים הנוספים |
18 | NumberOfPayments | 5 | מספר התשלומים |
19 | CardInfo | "Israeli" | סוג הכרטיס |
20 | CardOwnerName | "daniel" | שם בעל הכרטיס |
21 | CardOwnerPhone | "0522222222" | מספר טלפון של בעל הכרטיס |
22 | CardOwnerEmail | "test@gmail.com" | אימייל בעל הכרטיס |
23 | CardOwnerIdentityNumber | "213654987" | מספר תעודת זהות |
24 | Token | "4cf8e168-261e-4613-8d20-000332986b24" | מספר האסימון, חוה לשמור בבסיס הנתונים. |
25 | CardName | "ויזה רגיל" | שם כרטיס |
26 | SapakMutav | 1234 | מספר לקוח בעבודה ברב מוטב |
27 | Uid | "21121517002429612920744" | מזהה עסקה יחודי. במידה ועשו הכחשה \ זיכוי \ ביטול מתוך העסקה, הUID של הפעולה החדשה הזאת יהיה זהה לעסקה המקורית. אם עשו זיכוי מחוץ לעסקה, למשל כעסקה חדשה עם אסימון, הUID יהיה חדש. |
28 | ConcentrationNumber | "6518" | מספר הפקדה / ריכוז
|
29 | DocumentNumber | 300394 | מספר מסמך |
30 | DocumentType | "NULL" - לא הופק מסמך. "TaxInvoiceAndReceipt" – חשבונית מס וקבלה "TaxInvoiceAndReceiptRefund" – חשבונית זיכוי והחזר כספים "Receipt" – קבלה מלכ''ר "ReceiptRefund" – קבלה מלכ"ר זיכוי ( החזר כספים) "Quote" – הצעת מחיר "Order" – הזמנה "OrderConfirmation" – אישור הזמנה - מאתר "OrderConfirmationRefund" – זיכוי אישור הזמנה - מאתר "DeliveryNote" – תעודת משלוח "DeliveryNoteRefund" – תעודת החזרה "ProformaInvoice" – חשבון עסקה "DemandForPayment" – דרישה לתשלום "DemandForPaymentRefund" – ביטול דרישה לתשלום "ProformaDealInvoice" – חשבון קבלה פרופורמה "ProformaDealInvoiceRefund" –חשבון קבלה זיכוי "TaxInvoice" – חשבונית מס "ProformaInvoiceRefund" – זיכוי חשבון עסקה "TaxInvoiceRefund" – חשבונית מס זיכוי "ReceiptForTaxInvoice" – קבלה (לחשבונית) "DonationReceipt" – קבלה על תרומה "DonationReceiptRefund" – זיכוי קבלה תרומה (החזר כספים) "ReceiptForTaxInvoiceRefund" – החזר כספים לקוחות (קבלה זיכוי) | סוג מסמך |
31 | Rrn | "500301575449" | מספר זיהוי אצל חברות האשראי |
32 | Brand | "PrivateCard" "MasterCard" "Visa" "Maestro" "AmericanExpress" "Isracard" "JBC" "Discover" "Diners" | מותג כרטיס |
33 | Acquire | "Unknown" "Isracard" "CAL" "Diners" "AmericanExpress" "Laumicard" "CardCom" "PayPal" "Upay" "PayMe" | חברה סולקת
|
34 | Issuer | "NonIsrael" "Isracard" "CAL" "Diners" "AmericanExpress" "JCB" "Laumicard" | חברה מנפיקה |
35 | PaymentType | "Unknown" "Standard" "SpecialCredits" "ImmediateCharge" "CreditClub" "SuperCredit" "InstallmentCredit" "Payments" "ClubPatments" | סוג אשראי - חיוב רגיל \ תשלום \ קרדיט \ ניכיון |
36 | CardNumberEntryMode | "MagneticStip" "SelfService" "GasStationSelfService" "Contactless" "EmvContactless" "MobileContactless" "EmvMobileContactless" "MobileNumber" "Emv" "Phone" "SignatureOnly" "Internet" "Fallback" "EmptyCandidateList" | מקור עסקה - אינטרנטית \ EMV \ טלפונית... |
37 | DealType | "Information" "Debit" "Discharge" "ForcedCharge" "CashBack" "CashTransaction" "Recurring" "BalanceQuery" "Cancel" "Refund" "Recharge" | סוג + מקור עסקה - ביטול \ חיוב \ הוראת קבע \ זיכוי |
38 | IsRefund | boolean - true \ false | האם זו הייתה עסקה זיכוי |
39 | DocumentUrl | נותן את הURL של המסמך | קישור למסמך. |
40 | CustomFields | Id - 20 Value - "value" | הערכים של השדות המותאמים אישית. |
41 | IsAbroadCard | boolean (true\false) | האם הכרטיס הוא כרטיס מחו''ל? |
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
הבקשה לקבלת פרטי העסקה עם המזהה החיצוני:
{
"TerminalNumber": "1000",
"ApiName": "test2025",
"ExternalUniqTranId": "h9rZs#4VxTp!7kLb0wUeG3zrC"
}
התשובה המתקבלת מהבקשה:
{
"ResponseCode": 0,
"Description": "העסקה בוצעה בהצלחה",
"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": "ויזה רגיל",
"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
}