מרכז הידע / ממשקים API

שאלו את ה-AI

✦ תשובת ה-AI

חושב…

מקורות

    רשימת עסקאות (List of Transactions)

    מתי להשתמש בפונקציה זו?

    בתי עסקים או מפתחים המעוניינים לקבל מידע על עסקאות שנעשו מתאריך עד תאריך מסוים בעסק דרך API יכולים להשתמש בפונקציה זו.

    נותם פרטי עסקה גם על עסקאות שנכשלו.

    מה מקבלים מהפונקציה הזאת?

    הפונקציה מספקת פרטים על כל העסקאות, כולל אלו שעברו ואלו שלא עברו. בין הפרטים שניתן לקבל: פרטי אשראי, טוקן שנוצר, פרטי לקוח והמספר של המסמך שהופק.

     

    להלן קישור לפונקציה בJSON.

    שיטת בקשה - POST.
    List of Transactions

    https://secure.cardcom.solutions/api/v11/Transactions/ListTransactions

    להלן הפרמטרים שצרים להעביר בפונקציה List of Transactions.

    מקרא:

    פרמטר אדום - חובה

    פרמטר מודגש - מומלץ

    פרמטר לא אדום ולא מודגש - אופציונלי

    מספר
     
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 ApiName "test2025" שם משתמש API
    2 ApiPassword "test5000$" סיסמת משתמש API
    3 FromDate "DDMMYYYY" - "01012025" מאיזה תאריך להתחיל להביא פרטי עסקאות.
    4 ToDate "DDMMYYYY" - "17042025" עד איזה תאריך להביא פרטי עסקאות.
    5 TranStatus

    "Success"

    \

    "All"

    איזה מצב עסקה לחפש.

    רק עסקאות תקינות.

    \ 

    עסקאות תקינות ולא תקינות.

    6 Page 1 מאיזה עמוד למשוך את פרטי רשימת העסקאות .
    7 Page_size 20 מה יהיה כמות השורות בעמוד שמהם אנחנו נמשוך את פרטי רשימת העסקאות.
    8 LimitForTerminal 1000 הגבלה משיכת פרטי עסקאות למסוף.

     

    RESPONSE של List of Transactions.

    מספר
     
    פרמטר ערכים אפשריים לדוגמא תיאור
    1 ResponseCode 0 קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה.
    2 Description "OK" תיאור התשובה. ''OK'' זה טוב.
    4 Page 1 מספר דף.
    5 Page_size 20 גודל הדף.

     

    ערכים של Tranzactions (3).

    מערך של אובייקטים.

    מספר
     
    פרמטר ערכים אפשריים לדוגמא תיאור
    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

    "Auto" - אוטומטי, לפי מה שיש בהגדרות 3->4.

    "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) האם הכרטיס הוא כרטיס מחו''ל?
    42 AccountId 1001 קבלת מספר כרטיס לקוח.

     

     

    להלן קוד לדוגמא לפונקציה ביחד עם התשובה.

    הבקשה לקבלת פרטי הדוח עסקאות:

    {
      "ApiName": "test2025",
      "ApiPassword": "test5000$",
      "FromDate": "21032025",
      "ToDate": "22032025",
      "Page": "1",
      "Page_size": "20",
      "TranStatus": "All",
      "LimitForTerminal": "1000"
    }

    התשובה המתקבלת:

     

    {
        "ResponseCode": 0,
        "Description": "ok",
        "Tranzactions": [
            {
                "ResponseCode": 700,
                "Description": "עסקת בדיקה תקינה (J2)",
                "TranzactionId": 204931219,
                "TerminalNumber": 1000,
                "Amount": 0.01,
                "CoinId": 1,
                "CouponNumber": "38024575",
                "CreateDate": "2025-03-22T23:42:12",
                "Last4CardDigits": 0,
                "Last4CardDigitsString": "0000",
                "FirstCardDigits": 458000,
                "JParameter": "2",
                "CardMonth": 10,
                "CardYear": 27,
                "ApprovalNumber": "",
                "FirstPaymentAmount": 0.0,
                "ConstPaymentAmount": 0.0,
                "NumberOfPayments": 1,
                "CardInfo": "Israeli",
                "CardOwnerName": "gggg",
                "CardOwnerPhone": "0540000000",
                "CardOwnerEmail": "gggg@gggg.com",
                "CardOwnerIdentityNumber": "040617649",
                "Token": "4cf8e168-261e-4613-8d20-000332986b24",
                "CardName": "ויזה רגיל",
                "SapakMutav": "",
                "Uid": "25032223421908823955916",
                "ConcentrationNumber": "0",
                "DocumentNumber": null,
                "DocumentType": null,
                "Rrn": "",
                "Brand": "Visa",
                "Acquire": "Laumicard",
                "Issuer": "CAL",
                "PaymentType": "Standard",
                "CardNumberEntryMode": "Phone",
                "DealType": "Debit",
                "IsRefund": false,
                "DocumentUrl": null,
                "CustomFields": [
                    {
                        "Id": 1,
                        "Value": "gggg"
                    },
                    {
                        "Id": 2,
                        "Value": "0540000000"
                    },
                    {
                        "Id": 3,
                        "Value": "gggg@gggg.com"
                    }
                ],
                "IsAbroadCard": false
            },
            {
                "ResponseCode": 700,
                "Description": "עסקת בדיקה תקינה (J2)",
                "TranzactionId": 204922757,
                "TerminalNumber": 1000,
                "Amount": 0.01,
                "CoinId": 1,
                "CouponNumber": "38024573",
                "CreateDate": "2025-03-22T21:18:03",
                "Last4CardDigits": 0,
                "Last4CardDigitsString": "0000",
                "FirstCardDigits": 458000,
                "JParameter": "2",
                "CardMonth": 10,
                "CardYear": 27,
                "ApprovalNumber": "",
                "FirstPaymentAmount": 0.0,
                "ConstPaymentAmount": 0.0,
                "NumberOfPayments": 1,
                "CardInfo": "Israeli",
                "CardOwnerName": "gggggg",
                "CardOwnerPhone": "054000000",
                "CardOwnerEmail": "gregalelov@gmail.com",
                "CardOwnerIdentityNumber": "040617649",
                "Token": "4cf8e168-261e-4613-8d20-000332986b24",
                "CardName": "ויזה רגיל",
                "SapakMutav": "",
                "Uid": "25032221181008823952518",
                "ConcentrationNumber": "0",
                "DocumentNumber": null,
                "DocumentType": null,
                "Rrn": "",
                "Brand": "Visa",
                "Acquire": "Laumicard",
                "Issuer": "CAL",
                "PaymentType": "Standard",
                "CardNumberEntryMode": "Phone",
                "DealType": "Debit",
                "IsRefund": false,
                "DocumentUrl": null,
                "CustomFields": [
                    {
                        "Id": 1,
                        "Value": "gggggg"
                    },
                    {
                        "Id": 2,
                        "Value": "054000000"
                    },
                    {
                        "Id": 3,
                        "Value": "gregalelov@gmail.com"
                    }
                ],
                "IsAbroadCard": false
           },
        ],
        "Page": 1,
        "Page_size": 20
    }

    האם המאמר הזה עזר לך?