מה שרצית לדעת ועוד...

מרכז הידע

סליקה אינטרנטית

חיבור והרשאות API

איך פונים אל דף תשלום באמצעות API

איך פונים אל דף תשלום באמצעות API

מדריך אינטגרציה ל־PayPlus – קריאה אל דף תשלום (Payment Page)

💬 הקדמה

מפתחים יקרים,
כדי לבצע אינטגרציה אל PayPlus באמצעות הרשאות API ופנייה אל דף התשלום שלנו, פעלו לפי הסדר הבא:

1. פתחו אצלנו חשבון

התחילו בפתיחת חשבון חדש בקישור:
https://payplus.co.il/signup?a_id=19

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

2. קבלת סביבת טסטים והפרמטרים הדרושים

בהתאם לצורך, נקים עבורכם סביבת טסטים (Staging) ונמסור לכם את פרטי ההתחברות:
API KEY / SECRET KEY / PAYMENT PAGE UID

פרטים אלו מאפשרים לכם לבצע קריאות מאובטחות ל־API של PayPlus.

3. עיון במסמכי ה־API

ניתן לעיין במסמך ה־API בנושא Payment Pages כאן:
https://docs.payplus.co.il/reference/post_paymentpages-generatelink

שם תמצאו את תבנית הבקשה (Request) הרלוונטית עבורכם.

4. ביצוע קריאות לסביבת הטסטים

לאחר קבלת ההרשאות, ניתן לבצע פניות אל סביבת ה־Test (Staging) בכתובת:
https://restapidev.payplus.co.il/api/v1.0/PaymentPages/generateLink

כל בקשה (Request) תקבל תשובה (Response) מהשרת שלנו.

⚠️ חשוב לדעת:

אין אפשרות לפנות אלינו ישירות מה־Frontend של localhost.
הפנייה חייבת להיעשות דרך השרת שלכם (Server-side).
מומלץ להתנסות תחילה עם Postman לוודא תקינות לפני עלייה לאוויר.

🔑 פרמטרים חובה להתחברות ראשונית

פרמטר	תיאור	קבוע/משתנה
API_KEY	מפתח ה־API הראשי שלכם	קבוע
SECRET_KEY	המפתח הסודי המשויך ל־API שלכם	קבוע
payment_page_uid	מזהה ייחודי של דף התשלום במערכת PayPlus	משתנה לפי הדף המבוקש

🎥 סרטון קצר (40 שניות) – איך למשוך את שלושת הפרמטרים האלו מהאזור האישי:
קישור לסרטון

🔹 charge_method – סוגי חיוב אפשריים

ערך	סוג החיוב	תיאור שימוש	🟢 מתי להשתמש
1	חיוב רגיל (J4)	ברירת המחדל לרוב העסקים. משמש לעסקה רגילה או לעסקאות בתשלומים.	✅ רוב העסקאות והסליקות הרגילות.
2	חיוב מושהה (J5)	תפיסת מסגרת בלבד (על גובה סכום העסקה) – הסכום לא מחויב מיידית תצורה זו מוכרת בבתי עסקים המנהלים מלאי, ליקוטים וכו' שמעוניינים לבצע את החיוב רק לאחר בדיקת מלאי - פעולת החיוב הנוספת הינה ידנית.	⏳ כשאתם רוצים לאשר עסקה ולחייב במועד מאוחר יותר.
3	חיוב מחזורי (Recurring)	הוראת קבע באשראי. ⚠ חובה לשלוח גם פרמטרים נוספים שיפורטו בהמשך.	🔄 למנויים, תשלומים חודשיים או שירותים מתמשכים.
0	בדיקה (J2)	עסקת סימולציה/בדיקה – אינה מחייבת את הכרטיס בפועל.	🧪 לבדיקה לפני מעבר לאוויר (Staging/Test).

📌 פרמטרים מרכזיים בבקשה ל־Payment Page

פרמטר	תיאור	ערך לדוגמה / אופציות
charge_method	🔹 סוג החיוב – קובע את סוג החיוב שיבוצע בדף התשלום.	ראה טבלה למעלה
amount	סכום החיוב	150.00
currency_code	קוד מטבע: ILS / USD / EUR וכו׳	"ILS"
sendEmailApproval	שליחת מייל הצלחה ללקוח (true/false)	true
sendEmailFailure	שליחת מייל כישלון ללקוח (true/false)	false

🛠 פרמטרים אופציונליים שימושיים

refURL_callback – כתובת לקבלת התראה (Webhook) על השלמת עסקה
create_token – שמירת פרטי כרטיס לטוקן לחיובים עתידיים (true/false)
initial_invoice – הפקת חשבונית אוטומטית לאחר עסקה (true/false)
more_info – שדה חופשי עד 19 תווים - להחזיר מידע נוסף כגון: מספר הזמנה, פרטי משלוח ועוד

📄 חשוב לדעת – הפקת חשבונית/קבלה בסיום עסקה

מעוניינים להפיק חשבונית/קבלה בסיום עסקה מוצלחת? אצלנו זה הכול תחת קורת גג אחת.
לאחר שפתחו לכם אצלנו חשבון –
היכנסו לאזור האישי של PayPlus ובצעו את הסרטון הקצר המצורף (40 שניות).

לאחר ביצוע ההגדרות הראשוניות, תוכלו לבצע קריאה ל־API ולשרשר את הפרמטר הבא:

"initial_invoice": true

כך תופק אוטומטית חשבונית/קבלה בסיום עסקה מוצלחת

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

פרמטר	סוג	חובה	הערות
customer_name	string	כן	יש לציין את שם הלקוח. חשוב במיוחד למטרת הפקת חשבונית/קבלה על השם שלו בסיום עסקה.
email	string	כן	יש לציין את כתובת האימייל של הלקוח. שדה זה משמש לזיהוי הלקוח ולייעוד התשלום אליו.

🔧 דוגמה לבקשה (POST)

POST https://restapidev.payplus.co.il/api/v1.0/PaymentPages/generateLink
Content-Type: application/json
Authorization: Bearer <API_KEY>

{
  "payment_page_uid": "uid789",
  "charge_method": 1,
  "amount": 99.90,
  "currency_code": "ILS",
  "sendEmailApproval": true,
  "sendEmailFailure": false,
  "refURL_callback": "https://yourserver.com/callback",
  "initial_invoice": true,
  "hide_identification_id": false,
  "more_info": "order-4567"
}

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

חשוב לדעת – הפקת חשבונית/קבלה בסיום עסקה

לאחר ביצוע ההגדרות הראשוניות, תוכלו לבצע קריאה ל־API ולשרשר את הפרמטר הבא:

"initial_invoice": true

כך תופק אוטומטית חשבונית/קבלה בסיום עסקה מוצלחת

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

פרמטר	סוג	חובה	הערות
customer_name	string	כן	יש לציין את שם הלקוח. חשוב במיוחד למטרת הפקת חשבונית/קבלה על השם שלו בסיום עסקה.
email	string	כן	יש לציין את כתובת האימייל של הלקוח. שדה זה משמש לזיהוי הלקוח ולייעוד התשלום אליו.

חיוב מחזורי - הוראות קבע באשראי

ערך 3 - חיוב מחזורי (Recurring payments)
הוראות קבע באשראי

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

דרישות מקדימות

כדי להשתמש בהגדרות חיוב מחזורי:

יש להפעיל את שירות החיוב המחזורי (Recurring payments) במערכת.
בפרמטר charge_method יש להגדיר את הערך 3.
פרמטר חובה: recurring_settings (אובייקט) – מכיל את כלל ההגדרות לחיוב המחזורי.
אם אינכם מעוניינים להשתמש בחיוב מחזורי, ניתן לשלוח אותו כ-null.

פרמטרים בתוך recurring_settings

פרמטר	סוג	חובה?	תיאור	דוגמה / ערך
instant_first_payment	boolean	כן	האם לבצע חיוב ראשון מיידי בעת ההזמנה? (`true` = חיוב מיידי, `false` = לא)	true
recurring_type	integer	כן	סוג המחזור: `0` - יומי, `1` - שבועי, `2` - חודשי	2
recurring_range	integer	כן	טווח החיוב לפי סוג המחזור. לדוגמה: אם `recurring_type = 2` ו-`recurring_range = 1` → חיוב חודשי	1
number_of_charges	integer	כן	מספר החיובים הכולל במחזור. `0` = ללא הגבלה	12
start_date_on_payment_date	boolean	כן	האם להתחיל את החיוב בתאריך התשלום (`true`) או בתאריך ספציפי בחודש (`false`)	false
start_date	integer	כן	אם `start_date_on_payment_date = false`, יש לבחור תאריך (למשל: `15`)	15
jump_payments	integer	כן	דילוג לפני חיוב ראשון (למשל 30 יום חינם → `30`)	30
successful_invoice	boolean	כן	האם להפיק חשבונית אוטומטית לאחר כל חיוב מוצלח	true
customer_failure_email	boolean	כן	האם לשלוח מייל ללקוח במקרה של כישלון בתשלום	true
send_customer_success_email	boolean	כן	האם לשלוח מייל הצלחה ללקוח לאחר כל חיוב	true
end_date	string	לא	תאריך סיום למחזור (אם לא מדובר במסלול ללא הגבלה). פורמט: YYYY-MM-DD	"2026-12-31"

ניהול הוראות קבע וקבלת recurring_uid

לאחר יצירת הוראת קבע בהצלחה, אם הוגדרה כתובת refURL_callback לקבלת התראות –
המערכת תחזיר אובייקט הכולל את הפרמטר recurring_uid.

באמצעות מזהה זה תוכלו:

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

דוגמה מלאה להגדרה של recurring_settings

"recurring_settings": {
  "instant_first_payment": true,
  "recurring_type": 2,
  "recurring_range": 1,
  "number_of_charges": 12,
  "start_date_on_payment_date": false,
  "start_date": 15,
  "jump_payments": 30,
  "successful_invoice": true,
  "customer_failure_email": true,
  "send_customer_success_email": true,
  "end_date": "2026-12-31"
}

טוקנים - חיוב יזום ומשתנה

מדריך חיוב לפי טוקן (Tokenization)

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

שלב 1 – יצירת עסקה ראשונה ליצירת טוקן

בשלב הראשון מבצעים קריאה ל־API של יצירת דף תשלום:

POST https://restapidev.payplus.co.il/api/v1.0/PaymentPages/generateLink

פרמטרים חובה:

payment_page_uid (string) – מזהה דף התשלום שנמסר לכם
charge_method (int) – סוג החיוב (בד"כ 1 = עסקה רגילה)
amount (number) – סכום החיוב
currency_code (string) – ברירת מחדל "ILS"

חדש לטוקניזציה:

create_token (boolean, חובה לצורך טוקניזציה) – true
customer (object, חובה) – פרטי הלקוח:
- customer_name (string, חובה) – שם הלקוח
- email (string, חובה) – אימייל הלקוח

דוגמה לבקשת POST ראשונה ליצירת טוקן:

POST https://restapi.payplus.co.il/api/v1.0/PaymentPages/generateLink
Content-Type: application/json
Authorization: Bearer <API_KEY>

{
  "payment_page_uid": "uid789",
  "charge_method": 1,
  "amount": 150.00,
  "currency_code": "ILS",
  "sendEmailApproval": true,
  "sendEmailFailure": false,
  "refURL_callback": "https://yourserver.com/callback",
  "initial_invoice": true,
  "create_token": true,
  "customer": {
    "customer_name": "ישראל ישראלי",
    "email": "[email protected]"
  }
}

Response מוצלח יכיל את:

customer_uid – מזהה הלקוח
token_uid – מזהה הטוקן לחיובים עתידיים

שלב 2 – חיוב עתידי (Recurring / Token Charge)

לאחר קבלת customer_uid + token_uid ניתן לבצע חיוב יזום ישיר ללא פרטי אשראי.

POST https://restapi.payplus.co.il/api/v1.0/Transactions/Charge

פרמטרים חיוניים:

terminal_uid (string, חובה)
cashier_uid (string, חובה)
amount (number, חובה)
currency_code (string, חובה) – ברירת מחדל "ILS"
credit_terms (int, חובה) – סוג העסקה (1 רגילה)
use_token (boolean, חובה) – true
customer_uid (string, חובה אם use_token=true)
token (string, חובה אם use_token=true)

דוגמה לחיוב עתידי עם טוקן:

POST https://restapi.payplus.co.il/api/v1.0/Transactions/Charge
Content-Type: application/json
api-key: <API_KEY>
secret-key: <SECRET_KEY>

{
  "terminal_uid": "T12345",
  "cashier_uid": "C67890",
  "amount": 150.00,
  "currency_code": "ILS",
  "credit_terms": 1,
  "use_token": true,
  "customer_uid": "cus_987654321",
  "token": "tok_abc123xyz"
}

מה שרצית לדעת ועוד...

איך פונים אל דף תשלום באמצעות API

שעות פעילות שירות לקוחות PayPlus:

שעות פעילות שירות
לקוחות PayPlus: