איך ליצור בקשת API?
לפני שנתחיל ליצור את הבקשה, נזהה קודם כל איזו פעולה נרצה לבצע.
כל המידע הרלוונטי נמצא בתוך הדוקומנטציה שלנו https://www.payplus.co.il/developers#dev
במדריך הבא נתמקד במתודה הכי פופלארית - Generate Payment Link.
שלב 1 - שליחת הבקשה
בפייפלוס יש 2 סביבות פיתוח:
Production Environment: https://restapi.payplus.co.il/api/v1.0
Staging Environment: https://restapidev.payplus.co.il/api/v1.0
Route לשליחת הבקשה:
Production Environment: POST https://restapi.payplus.co.il/api/v1.0/PaymentPages/generateLink
Staging Environment: POST https://restapidev.payplus.co.il/api/v1.0/PaymentPages/genarateLink
שלב 2 - הזנת הפרמטרים המתאימים לבקשה
בשדה של הheaders תצטרכו למשוך מתוך ממשק הפייפלוס את המפתחות הרלוונטים - תוכלו להיעזר בקישור הבא: קישור למדריך משיכת פרמטרים.
מצורף קוד של ה-headers:
שלב 3 - איפיון שדות חובה
נעבור על האיפיון וכל השדות שהם חובה לקבלת ערך.
- Payment _Page_ Uid (string) - מזהה דף התשלום תוכלו להיעזר בקישור הבא: קישור למדריך משיכת פרמטרים.
- Charge_method (num) - תצורת הסליקה (0 - לבדיקות (J2) , 1 - חיוב (J4), 2 - תפיסת מסגרת (J5), 3 - הו"ק (במידה ואתם בוחרים באופציה זו, עברו לאובייקט recurring_settings), 4 - זיכוי, 5 - חיוב בטוקן.
- Amount (num) - סכום העסקה
- Currency_code (string) - סוג המטבע
- Customer (object) - שימו לב השדות שהן חובה מייל הלקוח + שם הלקוח.
- (object) Secure3ds - במידה ורכשתם את השירות, תוכלו להטמיע בדף התשלום את מנגנון האבטחה.
בגלילה מטה יהיה קיים request לדוגמה שאותו תוכלו להעתיק ולהדביק בקוד.
תוכלו לשנות את הbody של הבקשה בהתאם לסביבה שבו אתם מפתחים (Production) ואת שפת התכנות.
שדות שימושיים נוספים
- 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
שירות טוקנים נועד על מנת לשמור את פרטי כרטיס האשראי באופן מוצפן במערכות פייפלוס,
לצורך חיוב עתידי/מחזורי המתבצע באופן ידני על ידכם.
*שימו לב: שירות זה הינו שירות נוסף הניתן רק עבור משתמשים שרכשו שירות טוקנים. - initial_invoice - הפקת מסמך באופן אוטומטי לאחר ביצוע עסקה - יש לבחור True או False
נועד עבור פעולות חיוב/זיכוי - המסמך יופק ע"פ הגדרת סוג המסמך מתוך ממשק חשבונית +
*שימו לב: שירות זה הינו שירות נוסף הניתן בתוספת עלות - ניתן לרכישה באזור האישי ע"י לחיצה מצד ימין על שירות חשבונית +
שם תוכלו לבחור חבילה הרלוונטית ולהצטרף באופן דיגיטלי - hide_identification_id - הסתרת שדה תעודת זהות - יש לבחור True או False
רלוונטי בעיקר עבור עסקים שסולקים בחו"ל. - more_info - מזהה ייחודי של העסקה שיוחזר חזרה לאתר בית העסק
מעוניינים לקבל בחזרה את מס' ההזמנה ושדות נוספים - זה המקום, ניתן לבחור לקבל חזרה עד 19 תווים.
related-questions:
משיכת פרמטרים API Key/Secret Key/Payment Page UID/Cashier UID/Terminal UID