קבלת מידע על ההיסטוריה של הוראת קבע - (Get recurring payment history)
מתי להשתמש בפונקציה זו?
פונקציה זו דומה מאוד לפונקציה Get recurring payment info, אך ההבדל המרכזי הוא שהיא מאפשרת לקבל מידע על כל החיובים שבוצעו בהיסטוריית הוראות הקבע בטווח תאריכים ספציפי.
מה מקבלים מהפונקציה הזאת?
התשובה שמתקבלת כוללת את סכום החיוב, מספרי העסקאות והמסמכים, בנוסף לפרטים נוספים על הוראות הקבע. זהו פתרון מצוין לעדכון ממשקים ומערכות CRM בהתאם לצרכים של בית העסק.
מודלים נחוצים.
מודל הוראת קבע & הוראות קבע קיימות בממשק של קארדקום.
להלן קישור לפונקציה בJSON.
שיטת בקשה - GET
https://secure.cardcom.solutions/api/v11/RecuringPayments/GetRecurringPaymentHistory
להלן הפרמטרים שצרים להעביר בפונקציה Get recurring payment history.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | apiUserName | "test2025" | שם משתמש API |
2 | apiPassword | "test5000$" | סיסמת משתמש API |
3 | RowId | "13463" | שורת חיוב הוראת קבע בהיסטוריית חיובים |
4 | AccountId | 13463 | מספר כרטיס לקוח פנימי |
5 | FromDate | DDMMYYYY - "01012025" | מתאריך |
6 | ToDate | DDMMYYYY - "17042025" | עד תאריך |
RESPONSE של Get recurring payment history.
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ResponseCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
2 | Description | "OK" | תיאור התשובה. ''OK'' זה טוב. |
ערכים של RecurringPaymentHistory (3).
מערך של אובייקטים.
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | RowId | "13463" | שורת חיוב הוראת קבע בהיסטוריית חיובים |
2 | RecurringId | 37930 | מספר הוראת קבע של הכרטיס לקוח |
3 | TerminalNumber | 1000 | מסוף הוראת קבע מחייב. |
4 | AccountID | 13744 | מספר כרטיס לקוח. |
5 | DocumentDescription | "item (תשלום 1 מתוך 99999) עבור חודש ינואר" | תיאור פריט במסמך. |
6 | LastDate | "2025-02-03T12:18:00" | תאריך אחרון לחיוב. |
7 | OriginalNextDate | "2025-01-27T00:00:00" | תאריך מקורי לחיוב. |
8 | FinalDebitCoinID | 1 | מספר מטבע. 1 - שקל 2 - דולר לקודי מטבע נוספים - רשימת קודי מטבעות |
9 | SumToBill | 100.00 | סכום לחיוב בהוראת קבע. |
10 | SumToBillNoVat | 84.75 | סכום לחיוב בהוראת קבע לפני מע''מ. |
11 | DepartmentID | 1 | מספר מחלקה שאליו הוראת הקבע משויכת. |
12 | IsDocumentCreate | boolean - true \ false | האם הוגדר להפיק מסמך לחיוב הוראת קבע? |
13 | AgentID | 1 | מספר משתמש שהקים את הוראת הקבע. |
14 | PaymentNum | 1 | מספר התשלום. |
15 | IsReNewOrder | boolean - true \ false | האם הוראת הקבע חדשה? |
16 | ProductID | (string) | קוד פנימי למוצר. |
17 | TranzactionId | 202406493 | מספר עסקה פנימי של קארדקום. |
18 | ResposeCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
19 | ProcessID | 4467 | מספר תהליך. |
20 | DocumentType | 1 - חשבונית מס קבלה 2 - חשבונית זיכוי והחזר כספים 50- הצעת מחיר 100 - הזמנה (ללא תשלום) 101 - אישור הזמנה - מאתר ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה 300 - חשבון עסקה 301 - דרישה לתשלום 302 - ביטול דרישה לתשלום 305 - חשבונית מס 330 - חשבונית זיכוי 410 - החזר כספים לקוחות(קבלה זיכוי) 405 - קבלה על תרומה 406 - זיכוי קבלה תרומה(החזר כספים) 303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי | סוג מסמך להפקה. |
21 | DocumentNumber | 18039 | מספר מסמך. |
22 | Quantity | 1 | כמות פריט. |
23 | UnitPrice | 100 | מחיר פריט. |
24 | UnitPriceNoVAT | 84.75 | מחיר פריט לא כולל מע''מ. |
25 | IsIncludesVAT | boolean - true \ false | האם המחיר כולל מע''מ. |
26 | VAT | 15.25 | מע''מ. |
27 | BillingAttempts | 1 | כמות ניסיונות החיוב של חיוב זה. |
28 | CreateDate | "2025-02-27T00:00:00" | תאריך היצירה. |
29 | ActualBillingType | 0 - Bank 1 - Credit Card | סוג הוראת קבע - דרך אשראי \ בנק.
|
30 | NumOfCreditPayments | INT | במקרה והגדירו שהוראת הקבע היא על חיוב אחד בתשלומים, יינתן המספר תשלומים בפרמטר זה. |
31 | Status | "SUCCESSFUL" / " | כעקרון אין תשובה אחרת, אם לא היה אפשרות לחייב זה ייתן מערך ריק להיסטוריה. |
הודעות מערכת בשדה URLResp – תשובת שרת
השדה URLResp מציג את תוצאת הניסיון לשלוח דיווח Webhook:
OK : empty – הדיווח נשלח בהצלחה, אך השרת המקבל החזיר תשובה ללא תוכן. אם השרת מחזיר תוכן, הוא יוצג בשדה.
ERROR : No url in config – הדיווח לא נשלח משום שלא הוגדרה כתובת URL בהגדרות דיווח ה־Webhook.
ERROR : Max Retry – המערכת הגיעה למספר ניסיונות הדיווח המרבי ולא תבצע ניסיון נוסף. בנוסף, נשלחת הודעת מייל לבית העסק לכתובת המוגדרת בהגדרות החברה לקבלת התראות.
שימו לב: אם בוצע ניסיון דיווח, השדה URLResp לא יהיה ריק.
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
קריאת GET לקבלת ההיסטורית חיוב:
{
"apiUserName": "test2025",
"apiPassword": "test5000$",
"RowId": "341344",
"AccountId": "13463",
"FromDate": "01012025",
"ToDate": "17042025"
}
התשובה המתקבלת:
{
"ResponseCode": 0,
"Description": "ok",
"RecurringPaymentHistory": [
{
"RowID": 341344,
"RecurringId": 37551,
"TerminalNumber": 1001,
"AccountID": 13463,
"DocumentDescription": "item (תשלום 2 מתוך 99999) עבור חודש פברואר",
"LastDate": "2025-02-27T12:18:00",
"OriginalNextDate": "2025-02-27T00:00:00",
"FinalDebitCoinID": 1,
"SumToBill": 100.00,
"SumToBillNoVat": 100.00,
"DepartmentID": 0,
"IsDocumentCreate": true,
"AgentID": 0,
"PaymentNum": 2,
"IsReNewOrder": false,
"ProductID": null,
"TranzactionId": 202406493,
"ResposeCode": 0,
"ProcessID": 4467,
"DocumentType": 3,
"DocumentNumber": 18039,
"Quantity": 1.00,
"UnitPrice": 100.00,
"UnitPriceNoVAT": 100.00,
"IsIncludesVAT": false,
"VAT": 0.0000,
"BillingAttempts": 1,
"CreateDate": "2025-02-27T00:00:00",
"ActualBillingType": 1,
"NumOfCreditPayments": null,
"Status": "SUCCESSFUL"
}
]
}