סייר
 
אפשריות
Rss קטגורייות

Direct Debit API

מספר מאמר: AA-00444 צפיות: 3528 נוצר: 30/03/2016 14:55 עדכון אחרון: 15/04/2018 09:31 0 דירוג/ מצביע


יצירה והוספת הוראת קבע ב API

 

ממשק API להוראת קבע נותן אוטומטיזציה והשלמה למערכת הידנית . כול מה שניתן לבצע ידני ניתן לבצע עם מערכת הוראת קבע.

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

מתי להשתמש בממשקים במערכת הוראת קבע:

  1. גיוס הלקוחות מתבצע גם באופן ידני ע"י אנשים.
  2. מוצרים רבים : ומחיר שונה לכול מוצר.
  3. הנחות  : ניתן מבחינה עסקית לתת הנחות ללקוחות.
  4. גמישות מרבית בניהול הגביה וחייבים - כול לקוח חשוב ישי לטפל בו ידני במידה ויש חוב.
  5. מערכת פחות גמישה לשינוים -> מנוהל ומתוחזק ע"י קארדקום בע"מ רק שינויים שמתאימים לכלל המשתמשים יכנסו למערכת.

 

מתי להשתמש באסימונים:

  1. גיוס הלקוחות מתבצע באופן אוטומטי.
  2. מחירון והמוצרים הם קבועים וקשיחים מראש.
  3. אין התערבות אנושית בלקוחות חייבים - לא שילם נסגר המוצר הנמכר אוטומטי.
  4. מערכת גמישה מאוד לשינוים -> מנוהל ומתוחזק על-ידי המפתח שלכם.

 

מאמר שמסביר כיצד לעבוד ידני עם מערכת הוראת הקבע, כול מה שרואים בידני ניתן להעביר בממשק. יש ללמוד את המערכת הידנית (בכללי ) לפני התחלת פיתוח הממשקים : הוראת קבע ידני : http://kb.cardcom.co.il/article/AA-00426/0 

שלבים להוספת לקוח למערכת הוראת הקבע בכרטיס אשראי ( להוראה בנקאית ראה הערות בסוף):

שלב 1 :

יש לבצע עסקת פרופיל נמוך(redirect / iframe ) של יצירת אסימון בלבד או (חיוב ויצירת אסימון) בכדי שפרטי האשראי ישמרו במערכת לפי מאמר :

http://kb.cardcom.co.il/article/AA-00402/0

שלב 2:

יש לשלוח בקשה לביצוע חיוב מחזורי לעסקה שבוצעה. שם לב !

שדות החובה הם בהוספה בלבד!

בעדכון יש לשלוח רק את השדות שרוצים לעדכן.

ממשק Name to Value

https://secure.cardcom.solutions/interface/RecurringPayment.aspx

  1. התשובה המתקבלת היא במבנה :Name=Value&Name2=Value2&Name3=Value3.

ממשק Web Service

https://secure.cardcom.solutions/Interface/BillGoldService.asmx

פעולה:

https://secure.cardcom.solutions/Interface/BillGoldService.asmx?op=AddUpdateRecurringOrder

 



טבלת פרמטרים :


פרמטר תיאורערכים אפשריים לדוגמה

TerminalNumber
מספר הטרמינל
1000

 UserName שם משתמש ממשקים
 barak9611

 Operation

 NewAndUpdate  -

הוסף לקוח ואו/ הוראה לחיוב חדשה.  אם לקוח לא נמצא ייוצר לקוח חדש. למשתמש גם להוספה של הוראה חדשה ללקוח קיים על ידי העברה מזהה יחודי לקוח AccountId

Update - עדכון בלבד. אם לקוח / הוראה לחיוב לא נמצא תוחזר שגיאה.

 NewAndUpdate - הוסף חדש אם קיים עדכן.
Update - עדכן בלבד.

 LowProfileDealGuid קוד הפרופיל נמוך של עסקת החיוב הראשונה של הלקוח החדש שחוייב בפרופיל נמוך (דרך פרמטר זה נלקח הפרטי אשראי של הלקוח)
  72183f28-75fa-404e-b5de-5a1a5287f094

 Account.AccountIdמזהה יחודי של הלקוח בקארדקום
- יש להעביר בעדכון בלבד.
 123

Account.CompanyNameשם הלקוח / שם החברה שעליה תצא החשבונית
 Test Company

Account.RegisteredBusinessNumberמספר ח.פ / עוסק מורשה / ת.ז לקוח (ממולץ להעביר)
040617649

Account.SiteUniqueIdמספר לקוח יחודי במערכת שלכם. 0406176491

Account.FirstNameשם פרטי
 eli

Account.Cityמקום / עיר
holon

 Account.Street1כתובת שורה 1 (רחוב)
Street 1

 Account.Street2 כתובת שורה 2 (רחוב)Street 2

Account.ZipCodeמיקוד12345

 Account.PhLineטלפון נייח
040617649

  Account.PhMobile
נייד 039619611

   Account.Email
כתובת דואר אלקטרוני - Email
DemoEmail@Site.co.il

  Account.VatFree
הקמת לקוח ללא מע"מ (ללקוחות חו"ל / אילת )
 true

 Account.IsDocumentLangEnglish שפת מסמך שיופק ללקוח באנגלית (ללקוחות חו"ל)
true

  Account.Comments
הערות לחשבון הלקוח
"לקוח שילם במזומן בסוף"

Account.ContactName
שם איש קשר
avi

 Account.DontCheckForDuplicate האם לא לבצע בידקה של כפילויות לקוח ותמיד לפתוח כרטיס לקוח חדש בעת הוספת הוראת קבע.
במידה ב "true" תמיד יתוסף לקוח חדש ולא יבוצע בדיקת  כפילויות.
 

RecurringPayments.RecurringId
מספר ההוראה לחיוב שרוצים לעדכן (במצב עידכון בלבד)
2000

RecurringPayments.InternalDecription
תאור שם להוראה לחיוב
"קורס השתלמות"

RecurringPayments.NextDateToBill
תאריך הבא לתחילת החיוב בהוראת קבע
31/12/2016

RecurringPayments.TotalNumOfBills
מספר החיובים בהוראת קבע
999999 - ללא סוף (מנוי)
12 - 12 תשלומים של שנה

RecurringPayments.FinalDebitCoinId
מטבע לחיוב בהוראת קבע
1 - שקל
2 - דולר
ועוד (ראה סוגי מטבעות)

RecurringPayments.ReturnValue
ערך החזרה שנשלח (מתאים למס' הזמנה במערכת צד ג' )
1234

RecurringPayments.IsActiveבמצב עידכון : להפוך את ההוראת למצב לא פעיל
 false - לא יבוצע חיוב
true - יבוצע חיוב 

RecurringPayments.DocTypeToCreate

סוג המסמך להפקה.
אם לא מעבירים הסוג נקבע ע"י הגדרות המסוף בבריית מחדל.
1 - חשבונית מס קבלה
3 - קבלה מלכ"ר
101 - אישור הזמנה - מאתר

RecurringPayments.FlexItem.InvoiceDescription
תאור לחשבונית שתופק
"קורס א תשלומים בהוראת קבע "

RecurringPayments.FlexItem.Price
המחיר לחיוב כל חודש בהוראת קבע
100
  RecurringPayments.DepartmentIdמספר מחלקה להוראת קבע
 http://kb.cardcom.co.il/article/AA-00487/0/
 2

RecurringPayments.FlexItem.IsPriceIncludeVat
מחיר פריט עם/בלי מע"מ
true  - הלקוח יחויב את הסכום המעובר והמע"מ יחולץ מהמסכם.( 100 יהיה 100 כולל מע"מ)
false - יתבסף מע"מ על הסכום המועבר (100 יהיה 100 + מע"מ לדוגמה 117 )
 
false

TimeIntervalId
מספר מחזור החיוב :
ברירת המחדל - חודשי 1
לפי טבלה בממשק ניהול (הגדרות 10->1)
במקרים שרוצים לבצע מרווחי חיוב שנתי/רבעוני משנים בהתאם
 1
(אופציונלי - לא חובה להעביר )

RecurringPayments.ChargeInTerminal


(אופציונלי ) אם לא מועבר - משתמשים בפרמטר טרמינל כפי שמופיע בראש הטבלה
(אופציונלי - מספר מסוף מחייב בהוראת קבע )

 

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

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

שם לב ! לחיוב הלקוח דרך חשבון בנק יש לקבל את אישור הלקוח ואת אישור הבנק במסמך חתום. ( הלקוח הולך אל הבנק והבנק חותם על אישור לגביה מהחשבון רק לחברה שלכם)

פרמטר תיאורערכים אפשריים לדוגמה
BankInfo.Bank מספר בנק1 ( INT )
 BankInfo.Branchמספר סניף 123 (INT )
BankInfo.AccountNumberמספר חשבון בנק 1233456 ( LONG)
 BankInfo.Description הערות כלליותמחרוזה 50 . 

קבצים מצורפים
AddRecurringPayment.php.txt 6.5 Kb הורדת קובץ
DisableRecurringPayment.php.txt 3.3 Kb הורדת קובץ
UpdateRecurringPayment.php.txt 4.1 Kb הורדת קובץ
הערות
  • אין הערות למאמר זה.
תמיכה 03-9436100
כל הזכויות שמורות לחברת קארדקום בע"מ