איך פונים אל דף תשלום באמצעות API
מפתחים יקרים,
על מנת לבצע אינטגרציה אל פיי פלוס באמצעות שימוש בהרשאות API ופנייה אל דף התשלום שלנו
1.תצטרכו ראשית, להקים אצלנו חשבון באמצעות לינק הרישום הנ"ל עבורכם כבית התוכנה או עבור בית העסק הראשון שאתם מעוניינים לחבר.
על מנת לבצע אינטגרציה אל פיי פלוס באמצעות שימוש בהרשאות API ופנייה אל דף התשלום שלנו
1.תצטרכו ראשית, להקים אצלנו חשבון באמצעות לינק הרישום הנ"ל עבורכם כבית התוכנה או עבור בית העסק הראשון שאתם מעוניינים לחבר.
לאחר מכן ניצור אתכם קשר על מנת להכיר את המוצר שלכם ולאפיין עבורכם את פתרון הסליקה הטוב ביותר עבורכם ועבור לקוחותיכם.
אנו נפעל להקים עבורכם בהתאם לצורך - סביבת טסטים שבה תקבלו פרמטרים כגון: API KEY/SECREY KEY/PAGE UID לצורך טסטים.
אנו נפעל להקים עבורכם בהתאם לצורך - סביבת טסטים שבה תקבלו פרמטרים כגון: API KEY/SECREY KEY/PAGE UID לצורך טסטים.
Reference<<Payment Pages>>Generate payment link
2. ניתן להיכנס למסמך ה-API בנושא: Payment Pages באמצעות הלינק המצורף שם תוכלו לראות את התבנית של ה-Request הרלוונטית עבורכם:
https://jsapi.apiary.io/apis/payplus/reference/0/recurring-payments/add.html
יש לפנות שם אל POST של סביבת Test(Staging)- סביבת הטסטים שאליה אתם פונים בכל Request ומקבלים מאתנו Response
https://jsapi.apiary.io/apis/payplus/reference/0/recurring-payments/add.html
יש לפנות שם אל POST של סביבת Test(Staging)- סביבת הטסטים שאליה אתם פונים בכל Request ומקבלים מאתנו Response
https://restapidev.payplus.co.il/api/v1.0/
3. במבוא שלפניכם נסביר תחילה על הפרמטרים שהינם שדות חובה בכל פנייה אל דף התשלום של פיי פלוס
ולאחר מכן נתאר פרמטרים נוספים שנחשבים שימושיים
*שימו לב: לא ניתן לפנות מה Front של Local host אלינו
יש צורך לעשות קריאה לשרת שלכם ושהשרת שלכם יפנה אלינו
יש צורך לעשות קריאה לשרת שלכם ושהשרת שלכם יפנה אלינו
שדות חובה בכל פנייה - Required
תחת לשונית Attributes - תכונות:
- payment_page_uid מזהה דף התשלום אותו תוכלו למצוא ולהעתיק מתוך ממשק פיי פלוס ע"י לחיצה על דפי תשלום ומצד שמאל
- charge_method אופי החיוב מאפיין את סוג החיוב בדף התשלום ומגדיר אותו כברירת מחדל , יש להגדיר את אופי החיוב על פי מספר ולהלן האפשרויות:
*סליקה רגילה( J4 Charge ) פרמטר 1 - שהינה כרטיס האשראי חיוב מידי / או עסקאות תשלומים
*סליקה באמצעות השהיית חיוב( J5 Approval ) פרמטר 2- חיוב מושהה - *תלויה באישור חברת האשראי שלכם
תופס מסגרת אשראי ללקוח ומאפשרת לכם לבחור מתי לחייב את הכרטיס (לדוגמא לאחר שביצעתם בדיקה שהפריט קיים במלאי)
*סליקה באמצעות חיוב מחזורי (Recurring Payments) פרמטר 3
*על מנת לעבוד בתצורה זו עליכם להוסיף מסוף הנתמך בממשק הוראות הקבע של פיי פלוס הנועד ליצירת חיוב מחזורי באופן אוטומטי בדף התשלום.
* בדיקה בלבד (J2) - פרמטר 0 -אפשרות זו מאפשרת לבדוק את תקינות תבנית כרטיס האשראי ואינה מבצעת עסקה מכיוון שאינה יוצרת כלל תקשורת עם המסוף הדיגיטלי. - amount סכום העסקה - יש להגדיר במספר את גובה הסכום לחיוב
- currency_code קוד המטבע - יש להגדיר string אחד - מבין המטבעות הבאים: ILS / USD / EUR / GBP / AUD / CAD
- sendEmailApproval האם תרצו שיישלח אימייל אישור אל הלקוח עבור עסקה מוצלחת ? יש להגדיר True או False
- sendEmailFailure האם תרצו שיישלח אימייל סירוב אל הלקוח עבור עסקה שנכשלה לאחר מס' ניסיונות.
*שימו לב: לאחר כ-5 ניסיונות לבצע עסקה ללא הצלחה - האפשרות תינעל מטעמי אבטחה.
שדות שימושיים נוספים Callback ועוד
כעת נסביר על פרמטרים נוספים שאינם מוגדרים כשדות חובה אך נחשבים למאוד שימושיים:
- refURL_callback - Callback מכיל מידע על שובר האשראי, לצורך כך תצטרכו לציין את כתובת ה-URL שלכם
פונקציית ה-Callback נועדה להשיב לכם מידע על העסקה בעת סיומה - עסקת חיוב/ או עסקת זיכוי שעברו בהצלחה.
לפונקציה ה-Callback יש דיליי קל אך נועדה לעבוד באופן אוטומטי על מנת להשיב אליכם את המידע על העסקה.
*פרמטר payment_request_uid ישלח אליכם רק אם העסקה בוצעה בהצלחה. - IPN FULL - Instant Payment Notification - קבלת מידע מידי על עסקה + חשבונית באופן מידי
מעוניינים לקבל מידע גם על עסקה וגם על חשבונית ובאופן מהיר יותר?
היכנסו אל הלינק המצורף :https://www.payplus.co.il/developers#/reference/0/payment-pages/ipn-full - create_token - יצירת טוקן - יש לבחור - True או False
שירות טוקנים נועד על מנת לשמור את פרטי כרטיס האשראי באופן מוצפן במערכות פיי פלוס,
לצורך חיוב עתידי/מחזורי המתבצע באופן ידני על ידכם.
*שימו לב: שירות זה הינו שירות נוסף הניתן רק עבור משתמשים שרכשו שירות טוקנים והמסוף שלהם פטור מחובת CVV (באישור חברת האשראי בלבד).
שירות זה הינו שירות שעובד באופן ידני ולא באופן אוטומטי.
אם תהיו מעוניינים ליצור חיוב מחזורי שיחייב באופן אוטומטי - צרו קשר עם פיי פלוס למידע על ממשק הוראות הקבע Recurring Payments - initial_invoice - הפקת מסמך באופן אוטומטי לאחר ביצוע עסקה - יש לבחור True או False
נועד עבור פעולות חיוב/זיכוי - המסמך יופק ע"פ הגדרת סוג המסמך מתוך ממשק חשבונית +
*שימו לב: שירות זה הינו שירות נוסף הניתן בתוספת עלות - ניתן לרכישה באזור האישי ע"י לחיצה מצד ימין על שירות חשבונית +
שם תוכלו לבחור חבילה הרלוונטית ולהצטרף באופן דיגיטלי - hide_identification_id - הסתרת שדה תעודת זהות - יש לבחור True או False
רלוונטי בעיקר עבור עסקים שסולקים בחו"ל. - more_info - מזהה ייחודי של העסקה שיוחזר חזרה לאתר בית העסק - יש לציין כתובת URL
מעוניינים לקבל בחזרה את מס' ההזמנה ושדות נוספים - זה המקום, ניתן לבחור לקבל חזרה עד 19 תווים.
