קבלת מידע על הוראת קבע (Get recurring payment info)
מתי להשתמש בפונקציה זו?
בתי עסקים המעוניינים לקבל מידע על הוראת קבע באתר קארדקום ולשלב את פרטי הוראת הקבע במערכת ה-CRM או בממשק שלהם, יכולים לעשות שימוש בפונקציה Get recurring payment info.
פונקציה זו נועדה לספק מידע באופן פרטני לצרכים האישיים של בית העסק.
מה מקבלים מהפונקציה הזאת?
הפונקציה מחזירה את כמות החיובים שנותרו, את כמות החיובים שכבר בוצעו, את השם הפנימי של הוראת הקבע, את התאריך הבא לחיוב, ביחד עם מספר פרמטרים נוספים הקשורים להוראת הקבע.
מודלים נחוצים.
מודל הוראת קבע & הוראות קבע קיימות בממשק של קארדקום.
להלן קישור לפונקציה בJSON.
שיטת בקשה- GET.
https://secure.cardcom.solutions/api/v11/RecuringPayments/GetRecurringPayment
להלן הפרמטרים שצרים להעביר בפונקציה Get recurring payment info.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 |
apiUserName |
"test2025" | שם משתמש API, |
| 2 |
apiPassword |
"test5000$" | סיסמת משתמש API |
| 3 |
AccountId |
13744 | מספר כרטיס לקוח |
| 4 |
RecurringId |
37930 | מספר הוראת קבע של הכרטיס לקוח |
RESPONSE של Get recurring payment info.
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ResponseCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
| 2 | Description | "OK" | תיאור התשובה. ''OK'' זה טוב. |
ערכים של UpdateList (3).
מערך של אובייקטים.
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | RecurringId | 37930 | מספר הוראת קבע של הכרטיס לקוח |
| 2 | InternalDecription | "פריט חמוד" | שם התיאור פנימי של הוראת הקבע |
| 3 | NextDateToBill | "2025-04-18T00:00:00" | תאריך חיוב הבא |
| 4 | TotalNumOfBills | 99999 | כמות פעמים לחיוב. |
| 5 | NumOfPaymentsAlreadyCharged | 1 | כמות הפעמים שחויב |
| 6 | IsActive | boolean - true \ false | האם עדיין פעיל? |
| 7 |
ChargeIntervals אובייקט של פרמטרים. |
TimeIntervalId - 1 -------------------------------- AddDays - 0 -------------------------------- AddWeeks- 0 -------------------------------- AddMonth - 1 -------------------------------- AddYears - 0 |
ChargeIntervals - המרווח חיוב, כמה זמן בין כל חיוב לחיוב. --------------------------- TimeIntervalId -מספר פנימי של המרווח חיוב שהוגדר בקארדקום. --------------------------- AddDays - מספר ימים של המרווח חיוב. --------------------------- AddWeeks- מספר שבועות של המרווח חיוב. --------------------------- AddMonth - מספר חודשים של המרווח חיוב. --------------------------- AddYears - מספר שנים של המרווח חיוב. |
| 8 | FinalDebitCoinId | 1 |
מספר מטבע. 1 - שקל 2 - דולר לקודי מטבע נוספים - רשימת קודי מטבעות |
| 9 | IsDocumentCreate | boolean - true \ false | האם ההדרה להפקת מסמך פעילה בהוראת קבע. |
| 10 | DocTypeToCreate |
1 - חשבונית מס קבלה 2 - חשבונית זיכוי והחזר כספים 50- הצעת מחיר 100 - הזמנה (ללא תשלום) 101 - אישור הזמנה - מאתר ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה 300 - חשבון עסקה 301 - דרישה לתשלום 302 - ביטול דרישה לתשלום 305 - חשבונית מס 330 - חשבונית זיכוי 410 - החזר כספים לקוחות(קבלה זיכוי) 405 - קבלה על תרומה 406 - זיכוי קבלה תרומה(החזר כספים) 303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי |
סוג מסמך להפקה
|
| 11 | Comment | "לקוח VIP" | הערה פנימית של הוראת הקבע, לא מוצג ללקוח. |
| 12 | IsPrintNumOfPayments | boolean - true \ false | האם מוגדרת ההגדרה להדפיס את כמות התשלומים במסמך. |
| 13 | IsPrintBillMonth | boolean - true \ false | האם מוגדרת ההגדרה להדפיס את מספר החודש של החיוב. |
| 14 | DepartmentId | INT | מספר פניני שאליו משויך הוראת הקבע. |
| 15 | UserId | INT | מספר המשתמש במנוי של קארדקום שהקים את הוראת הקבע. |
| 16 | ReturnValue | (string) | ערך להחזרה, בדרך כלל זה מספר הזמנה. |
| 17 | ChargeInTerminal | 1000 | מסוף הוראת קבע מחייב. |
| 18 |
FlexItem אובייקט עם פרמטרים בתוכו. |
DocumentLineDesc - "השואבים של משה" -------------------------------- Price - 420 -------------------------------- IsPriceIncludeVat - boolean (true \ false) -------------------------------- ProductId - (string) |
FlexItem - הפרטים של חיוב גמיש. --------------------------- DocumentLineDesc - שם הפריט לחיוב. --------------------------- Price - מחיר הפריט לחיוב. --------------------------- IsPriceIncludeVat - האם המחיר כולל מע''מ. --------------------------- ProductId - קוד פנימי למוצר. |
| 19 | IsByProducts | boolean - true \ false |
האם המחיר הוראת קבע מחושב לפי מחיר מחירון של מוצר. (ProdList)
או שהוא מחויב לפי חיוב גמיש (FlexItem).
|
| 20 |
ProdList מערך של אובייקטים. |
ProductId - (string) -------------------------------- Quantity - 5 |
ProdList - רשימת המוצרים שעליהם יהיה את החיוב הוראת קבע.
---------------------------- ProductId - המזהה הפנימי של המוצר בקארדקום. ---------------------------- Quantity - הכמות מהמוצר.
|
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
קריאת POST לקבלת מידע על הוראת הקבע:
התשובה המתקבלת מהקריאה הראשונה: