יצירת חיבור לבנק נעשית בקריאה אחת ל-POST /v2/connections. בתגובה מתקבל קישור (connectUrl) למסע ההסכמה — שם המשתמש בוחר בנק, עובר לבנק ומאשר את שיתוף המידע.
יצירת החיבור
שלח POST ל-/connections (דורש scope create:connections). כל השדות אופציונליים — אפשר אפילו לשלוח body ריק ולקבל קישור למסע מלא:
POST /v2/connections
{
"psuId": "123456789", // ת"ז או דרכון של המשתמש
"startDate": "2026-01-01", // מאיזה תאריך לאסוף תנועות
"providerIds": ["leumi"], // השמטה = מסך בחירת בנק
"iframe": true, // להטמעה ב-iframe
"redirectUrl": "https://your-app.com/return"
}
השדות הנפוצים (כולם אופציונליים)
psuId– תעודת הזהות או הדרכון של המשתמש (בעל החשבון).startDate– מאיזה תאריך לאסוף תנועות. ברירת מחדל: שנה אחורה, ולא ניתן להקדים מעבר לכשנה אחורה.expiryDate– מתי החיבור פג. ברירת מחדל: 3 שנים קדימה (ומקסימום פחות מ-3 שנים).providerIds– צמצום לבנק/בנקים מסוימים. השמטה = מסך בחירת בנק.iframe– להטמעה ב-iframe וקבלת אירועיpostMessage.psuCorporateId– ח"פ לחשבון עסקי. שדות נוספים:language(he/en),redirectUrl,allowBusiness,access,callbackInformation(webhooks).
התשובה
בתגובה (201) מתקבלים:
id– מזהה החיבור.connectUrl– הקישור למסע ההסכמה שאליו צריך להפנות את המשתמש.
הפניית המשתמש
הפנה את המשתמש ל-connectUrl (או הטמע אותו ב-iframe). במסע ההסכמה המשתמש:
בוחר את הבנק (אם לא צוין
providerIds).עובר לבנק ומתחבר.
מאשר את ההסכמה לשיתוף המידע.
בסיום החיבור עובר לסטטוס פעיל והמידע מתחיל לזרום. אם בחרת iframe: true, תקבל אירועי postMessage על מצב התהליך.
מזהי ספקים (providerIds)
רשימת ה-providerId הזמינים נשלפת דרך GET /v2/providers. לכל ספק יש גם גרסת -sandbox לבדיקות. אם לא תציין providerIds, המשתמש יראה מסך בחירת בנק.
תיעוד מלא
לכל הפרמטרים ושדות התשובה: docs.open-finance.ai – create connection.