פיתוח חדש למתכנת - יש לעבוד עם ממשק JSON החדש בכתובת :
ממשק JSON :
https://secure.cardcom.solutions/swagger/index.html?url=/swagger/v11/swagger.json#tag/LowProfile/operation/LowProfile_Create
ממשק API להפניה לדף תשלום בתקן PCI [דף פרופיל נמוך] : חיוב / חיוב ויצירת אסימון / יצירת אסימון / עסקה מושהית.
אם לא מובן ניתן להתקשר לתמיכה לשיחת אפיון
ניתן לפנות בטלפון: 03-9436100 ולבחור תמיכה למפתחים
אפשרות נוספות לפנות ישירות במייל ל : dev@secure.cardcom.co.il
*כשמציגים את דף התשלום כIFRAME באתר גובה ה IFRAME צריך להיות מינימום 1000 פיקסל ורוחב של 100%.
ממשק זה מתאים בעיקר:
- אתר סחר אלקטרוני עם עגלת קניות כאשר הסל קניות מנוהל בצד המתכנת
והדף תשלום הסופי של קארדקום , אם זה פלטפורמה סגורה כמו WOO יש לפנות למדריך זה - אתר עם מוצרים ומחירים דינמיים.
- במידה ואין עגלת קניות או מתכנת שיעביר פרמטרים באתר יש להשתמש בדפי אישורית זהב.
ממשק זה מאפשר לבצע :
- חיוב בלבד - חיוב רגיל של כרטיס האשראי.
- חיוב ויצירת אסימון - חיוב ויצירת אסימון לחיוב הלקוח שוב בעתיד, מתאים לאתרים עם מנויים.
- יצירת אסימון בלבד - יצירת אסימון בלבד ללא חיוב הכרטיס.
- עסקה מושהית - עסקה בהמתנה , יהיה ניתן להיכנס למערכת הניהול של אישורית זהב לבצע חיוב/ שינוי בפרטי העסקה במועד מאוחר יותר לפני החיוב.
ממשק Name To Value :
- מומלץ לבצע פנייה רק ב POST .
- חובה לבצע urlencode לכל הערכים המועברים למערכת.
כתובת: https://secure.cardcom.solutions/Interface/LowProfile.aspx
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
שלב 1 : בקשה לפתיחת דף תשלום לחיוב (דף פרופיל נמוך)
כתובת הפונקציה ב - Name to Value היא: https://secure.cardcom.solutions/Interface/LowProfile.aspx
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | Operation |
1- חיוב בלבד |
סוג הפעולה שמערכת אישורית זהב צריכה לבצע. |
2 | TerminalNumber | 1000 | המסוף שמבצע את הפעולה |
3 | UserName | MyTestUser | שם משתמש לממשקים של בית העסק |
4 | SumToBill | 100.50 | הסכום לחיוב |
5 | CoinId |
1- שקל |
מטבע לחיוב העסקה ראה גם מטבעות נוספים : רשימת קודי מטבעות |
6 | Language |
he - עברית (עיצוב 5 + 6) |
ראה שפות נוספות : שפות לדף פרופיל נמוך (שאר השפות תמיכה רק בעיצוב גירסא 5 ) |
7 | ProductName | הזמנה מספר C101G |
שם המוצר שיוצג למשתמש, אורך מקסימלי של 50 תווים. |
8 | APILevel | 10 | גרסה של API. גרסה אחרונה: 10 |
9 | Codepage | 65001 | פרמטר זה אומר את סוג הקידוד המועבר למערכת יוניקוד במקרה זה. |
10 | MaxNumOfPayments | 12 | מספר תשלומים מקסימלי שהמשתמש יכול לבחור, בנוסף יש הגדרות מדרגות תשלומים בתור המסוף שקובעות יותר-> מדרגות תשלומים לאתר (פרופיל נמוך) |
11 | MinNumOfPayments | 3 | מספר תשלומים מינימלי שהמשתמש יכול לבחור |
12 | HideCreditCardUserId | false | האם להסתיר את הקליטה של ת.ז הלקוח - משמש כאשר מחייבים לקוחות חו"ל |
13 | SuccessRedirectUrl | http://www.site.com/Success.html |
הדף אליו יופנה מחזיק הכרטיס בסיום עסקה שהסתיימה בהצלחה. |
14 | ErrorRedirectUrl | http://www.site.com/Error.html |
הדף שאליו יופנה מחזיק הכרטיס בסיום עסקה שהסתיימה בכשלון. |
15 | IndicatorUrl | http://www.site.com/hide.aspx |
webhook דף נסתר (דף דיווח קבלת פרטי עסקה) לקבלת פרטי העסקה. המערכת קוראת לדף זה לפני שהלקוח מועבר לדף הצלחה/כישלון. דגשים חשובים : 6.בכדי לקבל דיווחים גם על עסקאות סירוב יש לסמן בV את הפונקציה "תמיד בצע דיווח של עסקה" (בממשק קארדקום הגדרות -> 4.סליקה בפרופיל נמוך ->2.הגדרות כלליות) |
16 | HideCVV | false | האם להסתיר את שדה CVV, משמש למסופים של הוראת קבע שבהם אין חובה של CVV |
17 | CreditType |
1 - חיוב רגיל |
שים לב! |
18 |
ReturnValue |
AA-1234 | ערך להעביר למערכת הסליקה אשר יוחזר ל IndicatorUrl עד 250 תווים. (נהוג להעביר מספר הזמנה ממערכת הזמנות באתר). |
19 | DefaultNumOfPayments | 10 |
מספר התשלומים שיהיו בחורים מראש ללקוח. לדוגמא: אם ניתן לשלם ב12 תשלומים, ניתן להעביר את הערך 10 ואז מספר התשלומים שיהיה בחור הוא 10. |
20 | CardOwnerName | אלי כהן | שם בעל הכרטיס |
21 | HideCardOwnerName |
מחרוזת: true להסתיר |
האם לא להציג את השדה שם בעל הכרטיס. |
22 | SapakMutav | 1234 | מספר לקוח בעבודה ברב מוטב |
23 | RefundDeal | true | האם לבצע זיכוי לפרטי האשראי - פעיל בחיוב בלבד. |
24 | ShowCardOwnerPhone | true | האם להציג שדה טלפון בעל הכרטיס בפרטי האשראי |
25 | CardOwnerPhone | 0548976523 | טלפון בעל הכרטיס |
26 | ReqCardOwnerPhone | false | האם שדה טלפון בעל הכרטיס חובה |
27 | CardOwnerEmail | eli1960@gmail.com | אימייל הלקוח ( נכנס לפרטי עסקה, לא נכנס לחשבונית) |
28 | ShowCardOwnerEmail | true | האם להציג אימייל בעל הכרטיס |
29 | ReqCardOwnerEmail | true | האם אימייל בעל הכרטיס שדה חובה |
30 | ShowInvoiceHead | true |
האם להציג ולאפשר ערכיה של פרטי החשבונית ללקוח. |
31 | AutoRedirect | true | במצב טסטים, כאשר AutoRedirect=true במקום לקבל url הדף יופנה לדף התשלום ישירות. עבודה ב-GET - מומלץ במצב טסטים , במסוף אמיתי מומלץ POST. |
32 | InvoiceHeadOperation |
0 - לא ליצור חשבונית ולא להציג |
במידה ולא רוצים ליצור חשבונית אלא רק להציג את פרטי הרכישה יש להעביר את הפרמטר הזה עם ערך 2 |
33 | IsVirtualTerminalMode | true |
האם זה סליקה של בית העסק? |
34 | IsOpenSum | true | עובד רק במצב של IsVirtualTerminalMode = true הפרמטר יאפשר לסוחר לעדכן את הסכום בעת החיוב. |
35 | ChargeOnSwipe | true = בפס מגנטי יבוצע ישר חיוב | כאשר מעבירים פס מגנטי (ערוץ 2) יבוצע ישר החיוב. |
36 | DocTypeToCreate |
1- חשבונית מס קבלה |
לא חובה, מומלץ לא להעביר, המערכת יודעת לבד איזה מסמך להפיק לפי ההגדרות שמוגדרות ברמת המסוף . |
37 | CSSUrl |
https://www.site.co.il/mycss.css |
כתובת url של קוד css שהמערכת תוסיף לדף התשלום. |
38 | IsAVSEnable |
עיר, כתובת ומיקוד בעל הכרטיס |
האם להציג שדות AVS למחזיק הכרטיס בדף תשלום. |
39 |
deferMonths |
1 - חודש קדימה (שוטף 30) |
מספר חודשי דחיית העסקה , שוטף 30 + 60 וכו |
40 |
FirstPayment |
תשלום ראשון |
בעסקת תשלומים שהמתכנת רוצה מראש להגדיר מספר תשלומים כאשר התשלום הראשון גבוה משאר התשלומים (לא נתמך בסוג עסקת קרדיט) |
41 |
ConstPayment |
תשלום קבוע |
התשלום קבוע , בתשלום ראשון + קבוע |
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
39 | CreateTokenDeleteDate |
01/01/2025 |
עד מתי לשמור את פרטי האסימון בDATABASE של קארדקום? אפשר להגדיר במעמד יצירת האסימון תאריך שבו פרטי האסימון יימחקו. |
40 | CreateTokenJValidateType |
2- בדיקה J2 |
סוג הבדיקה שתבוצע על הכרטיס בעת יצירת אסימון בלבד. |
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
41 | SuspendedDealJValidateType | 2 - בדיקה J2 5 - בדיקה J5 |
סוג הבדיקה שתבוצע על הכרטיס |
42 | SuspendedDealGroup | 0 |
קוד קבוצה - משמש להצגת הלקוחות בדוח לפי חתכים בדוחות במערכת אישורית זהב. |
פרמטרים נוספים של UTM שמוחזרים לדף הצלחה וגם webhook
19 | utm_source |
|
|
20 | utm_medium | medium | |
21 | utm_campaign | campaignNAME | |
22 | utm_content | content | |
23 | utm_term | term |
|
הוספת פרמטרים ליצירת מסמך חשבונאי לפי מדריך זה - יצירת מסמך (חשבונית / קבלה וכו') לעסקת אשראי. (לעסקת פ.נמוך ראשונית או חיוב אסימון)
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ResponseCode נא לקרוא תיאור בצד |
0 |
0 - הפעולה תקינה |
2 | Description | OK |
תיאור התשובה , במידה ומתקבל שונה מ-0 יש לבצע רישום והתראה למנהל המערכת. |
3 | LowProfileCode | f47b241e-1861-4cf8-a9a2-bf0c05f9f36d |
קוד פרופיל נמוך - קוד המזהה הייחודי של העסקה. יש לשמור קוד זה על ההזמנה בבסיס הנתונים |
4 | url | https://secure.cardcom.solutions/External/lowProfileClearing/1000.aspx?LowProfileCode=f47b241e-1861-4cf8-a9a2-bf0c05f9f36d |
כתובת ב URL של הדף שנוצר שיש להעביר את מחזיק הכרטיס לביצוע סליקה. |
5 | PayPalUrl | https://secure.cardcom.solutions/External/LowProfileRedirectToPayPal.aspx?TerminalNumber=1000&LowProfileCode=f47b241e-1861-4cf8-a9a2-bf0c05f9f36d |
כתובת URL להעברת מחזיק הכרטיס ישירות ל PAYPAL - מתאים להוספת לחצן באתר "רכישה PAYPAL" ישירות מבלי לעבור דרך דף הסליקה של קארדקום - שם לב יש לבצע הגדרות של PAYPAL במסוף לפני . |
6 | BitUrl | https://public.bankhapoalim.co.il/bitcom/2.2.1/payment-modal?&transactionSerialId=FA9F5BB4-AF8B-4B62-8A03-D0D27C652435&eventSerialId=D2AA7F7A-5305-4438-8F66-FDB2BCCCDA76 |
כתובת URL להעברת מחזיק הכרטיס ישירות לאתר של BIT לתשלום |
שלב 2 : קבלה או משיכה של תשובה משרת הסליקה
פנייה למשיכה של התשובות:
לאחר שמושכים את הנתונים יש לסמן במערכת שלכם שהנתונים נמשכו, זאת כדי למנוע בעיה של משיכות חוזרות של העסקה.
ישנם מקרים שהלקוחות / CRULERS גולשים שוב לאותו דף הצלחה או מבצעים ריענון לדף.
מה שעלול לגרום לכפל עסקאות והזמנות במערכת שלכם. במידה ומסומן שהנתונים נמשכו אין לבצע משיכה שוב. הפניה מתקבלת בתצורת GET.
Web Service
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | TerminalNumber | 1000 | המסוף שמבצע את הפעולה |
2 | UserName | APIUserName | שם משתמש ממשקים |
3 | LowProfileCode | AA-BB-CC | קוד העסקה הייחודי |
4 | codepage | 65001 | סוג הקידוד המועבר |
דוגמא לפניה ב-GET:
https://secure.cardcom.solutions/Interface/BillGoldGetLowProfileIndicator.aspx?terminalnumber=1000&username=APIUserName&lowprofilecode=AA-BB-CC
מס' | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | TerminalNumber | 1000 | המסוף שמבצע את הפעולה |
2 | LowProfileCode | 5BAF4BD5-76FB-4C81-8654-DF481B22EDF3 | קוד העסקה הייחודי |
3 | Operation |
1- חיוב בלבד |
סוג הפעולה שבוצעה |
4 | ProssesEndOk | פרמטר פנימי של המערכת, לא לשימוש חיצוני! | קוד תשובה של התהליך |
5 | OperationResponse |
0 - תקין |
האם החיוב הצליח |
6 | DealResponse |
0 - תקין |
קוד תשובה של חיוב כרטיס האשראי - מועבר רק אם בוצע חיוב אשראי |
7 | InternalDealNumber | 654354685 | מספר ייחודי של עסקה שבוצעה בעת חיוב אשראי. גודל התשובה יכול להיות Int64/ BigInt |
8 | TokenResponse | 0 - תקין, אחרת שגוי | קוד תשובה של יצירת אסימון |
9 | Token | 12F678C4-BC08-4607-ACF2-755FD7FCD3DE | מספר האסימון, חוה לשמור בבסיס הנתונים. |
10 | TokenExDate | YYYYMMDD | תוקף אסימון כמו תוקף הכרטיס , חובה לשמור בבסיס הנתונים. |
11 | CoinId |
1 - שקל |
קוד מטבע שבוצעה העיסקה, ראו קודי מטבע |
12 | CardOwnerId | 012345678 | ת.ז בעל הכרטיס, חובה לשמור בבסיס הנתונים. |
13 | CardValidityYear | 2021 | תוקף הכרטיס-שנה, ביצירת אסימון יש לשמור בבסיס הנתונים. |
14 | CardValidityMonth | 12 | תוקף הכרטיס-חודש, ביצירת אסימון יש לשמור בבסיס הנתונים. |
15 | TokenApprovalNumber | 12345 | מספר אישור חד פעמי המתקבל בעת יצירת אסימון עם בדיקה מסוג J5. ביצירת אסימון יש לשמור בבסיס הנתונים על מנת לבצע חיוב עתידי לעסקה. |
16 | SuspendedDealResponseCode | 0 - תקין, אחרת כישלון | קוד תשובה לעסקה מושהית |
17 | SuspendedDealId | 1234 | מספר עסקה מושהית |
18 | SuspendedDealGroup | 90 | קבוצה של עסקה מושהית |
19 | InvoiceResponseCode | 0 - הצלחה | קוד תשובה של יצירת חשבונית |
20 | InvoiceNumber | 555 | מספר חשבונית |
21 | InvoiceType | 1 - חשבונית חיוב 2 - חשבונית זיכוי 3 - קבלה 4 - החזר כספי ללקוח (קבלה זיכוי) |
סוג מסמך להפקה בכדי לראות עוד מספרי וסוגי מסמכים ניתן לראות בלינק זה בפרמטר InvoiceType |
22 | CallIndicatorResponse | ok | תיאור התשובה מהשרת שלך בעת קריאה ל-IndicatorUrl |
23 | ReturnValue | 1234 | הערך כפי שהועבר בעת יצירה של בקשה לחיוב. |
24 | NumOfPayments | 3 | מספר תשלומים שהלקוח בוחר בטופס הסליקה. |
25 | CardOwnerEmail | eli@gmail.com | אימייל בעל הכרטיס |
26 | CardOwnerName | אלי כהן | שם בעל הכרטיס |
27 | CardOwnerPhone | 0508855881 | טלפון בעל הכרטיס |
28 | AccountId | 1001 | מספר לקוח במערכת אישורית זהב, רק אם נוצר או בוצע איחוד לכרטיס לקוח. |
29 | ForeignAccountNumber | 21451 | מספר הנהלת חשבונות של הלקוח, רק אם נוצר או בוצע איחוד לכרטיס לקוח. |
30 | SiteUniqeId | 1005412 | מספר מזהה ייחודי של הלקוח, רק אם נוצר או בוצע איחוד לכרטיס לקוח. |
31 | ExternalPaymentVector |
NoneOrUnknown = 0, |
מקור עיסקה חיצוני , כמו BIT וכו |
32 | ExternalUniqueID |
CB999872-45F3-4019-85C6-A28C22369DC2 |
מספר מזהה חיצוני לעסקות מסוג : ApplePay ,uPayBit ,PayMeBit ,GooglePay ,EmvP400Verifon CreditGuardBit |
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ExtShvaParams.Status1 | בהתאם לטבלת הודעות קודים 0-300 זהירות ! ישנם קודים ששונים מ -0 אבל עדיין אומרים עסקה תקינה ! |
קוד תשובה של הפנייה לחברות האשראי |
2 | ExtShvaParams.Sulac25 | קודים של חברה סולקת בהתאם למאמר :תיאור קודים חברות האשראי | חברה סולקת של הכרטיס |
3 | ExtShvaParams.CardNumber5 | 4580 | ארבע ספרות אחרונות של כרטיס אשראי של הלקוח ( סיומת כרטיס ) |
4 | ExtShvaParams.JParameter29 |
|
J- פרמטר , סוג בדיקה לביצוע על הכרטיס |
5 | ExtShvaParams.Tokef30 | 1229 | תוקף הכרטיס |
6 | ExtShvaParams.Sum36 | 150 | סכום שלקוח שילם באגורות - באותו מטבע - לא חייב להיות ש"ח. |
7 | ExtShvaParams.SumStars52 | 100 | סכום ששולם בכוכבים |
8 | ExtShvaParams.ApprovalNumber71 | 0 - ללא אישור , קבלת מספר האישור מחברת ש.ב.א ולא מחברות האשראי מכיוון שסכום העסקה מתחת לתקרה. אחרת מספר האישור שהתקבל מחברות האשראי או מספר האישור שהוקלד בעת ביצוע העסקה. |
מספר אישור על ביצוע עסקה |
9 | ExtShvaParams.FirstPaymentSum78 | 50.00 | סכום תשלום הראשון |
10 | ExtShvaParams.ConstPayment86 | 20.00 | סכום מספר התשלומים הנוספים |
11 | ExtShvaParams.NumberOfPayments94 | עסקה רגילה של 6 תשלומים יופיע 5. שם לב! כאשר ExtShvaParams.CreditType63=6 עסקה של 6 תשלומים יופיע 6. |
מספר תשלומים הנוספים שיחויבו . שים לב ! כאשר ExtShvaParams.CreditType63=6 שדה זה מייצג את סה"כ מספר התשלומים ! |
12 | ExtShvaParams.CardTypeCode60 | קודים של חברה סולקת בהתאם למאמר :תיאור קודים חברות האשראי | קוד חברת האשראי המנפיקה |
13 | ExtShvaParams.Mutag24 | 0 - כרטיס פרטי של חברה מנפיקה 1 - מאסטרכרד 2 - ויזה 3 - דיינרס 4 - אמקס 5 - ישראכראט 6 - JCB 7 - discover 8 - מאסטרו (כרטיס של מאסטרכארד) |
קוד מותג הכרטיס תיאור קודים חברות האשראי |
14 | ExtShvaParams.CardOwnerName | Yaniv | שם בעל הכרטיס כפי שהוקלד ע"י המשלם |
15 | ExtShvaParams.CardToken | AA-BB-CC | אסימון הכרטיס במידה ונוצר מסוג GUID |
16 | ExtShvaParams.CardHolderIdentityNumber | 040000000 | ת.ז. בעל הכרטיס |
17 | ExtShvaParams.CreditType63 | 1- רגיל 2 - ישראקרדיט, עדיף 30+ 3 - חיוב מידי 4 - אשראי מועדון 5 - סופר קרדיט 6 - קרדיט בתשלומים 8 - תשלומים 9 - מועדון בתשלומים. |
סוג חיוב האשראי |
18 | ExtShvaParams.AbroadCard119 | 0 - כרטיס ישראלי 1 - כרטיס תייר 2 - כרטיס דלק 3 - כרטיס חיוב מיידי 4 - כרטיס מתנה / נטען ( פרט לכרטיס שמופק ע"י חברת ויזה כאל בשלב זה) |
סוג כרטיס חיוב |
19 | ExtShvaParams.DealType61 | 00 - כרטיס חסום 01 - עסקת חובה רגילה 02 - עסקת חובה מאושרת 03 - עסקה מאולצת. 51 - עסקת זכות. 52 - עסקת ביטול. 53 - עסקת זכות מאושרת. |
סוג עסקה |
20 | ExtShvaParams.ChargType66 | 00 - עסקה רגילה 01 - שירות עצמי 02 - שירות עצמי בתחנות דלק 05 - contactless 06 - contactless self service 50 - עסקה טלפונית 51 - עסקת חתימה בלבד. |
קוד עסקה |
21 | ExtShvaParams.BinId | 1- כרטיס אשראי שופרסל (4580XX44) 2 - כרטיס חבר 185000000 - 195000000 |
מזהה סוג הכרטיס. במידה וישנם כרטיסים נוספים לזיהוי יש לפנות אל התמיכה להוספה |
22 | ExtShvaParams.FirstCardDigits | 123456 | 6 ספרות ראשונית של האשראי |
23 | ExtShvaParams.InternalDealNumber | 123456 | מספר עסקה פנימי של קארדקום(Int64) |
24 | ExtShvaParams.CouponNumber | 120112011 | מספר שובר - מחרוזת |
25 | ExtShvaParams.DealDate | תאריך ביצוע העסקה | |
26 | ExtShvaParams.CardOwnerPhone | טלפון בעל הכרטיס | |
27 |
ExtShvaParams.Uid |
מזהה עסקה ייחודי |
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | CustomFields.Field1 | כתובת למשלוח | שדה מותאמים אישית 1 |
2 | CustomFields.Field2 | עיר למשלוח | שדה מותאם אישית 2 |
3 | CustomFields.Field3-25 | ערך עד 50 תווים | שדה מותאם אישית נוספים.. |
LowProfile-Operation1(step_1) - קוד לפתיחת דף תשלום בלבד , ללא מסמך
LowProfile-Operation1+invoice.(step_1) - קוד לפתיחה דף תשלום + מסמך חשבונאי
GetLowProfileIndicator(step_2) - משיכה הנתונים לאחר הדיווח לפרמטר IndicatorUrl
לינק למאמר של שלב 3 - חיוב באסימונים
הערות
0 הערות
היכנס למערכת כדי להגיב.