תיעוד התממשקות לשירותי בנקאות פתוחה – סביבת Sandbox

אנו תומכים בגירסאות:

עבור הסכמות לפי גירסה 1.6 - מסמך Open Banking IL - Implementation Guidelines גרסה 1.6

עבור הלוואות  לפי גירסה 1.4 - Open Banking IL -  Implementation Guidelines -  Extended Services - AIS for Savings and Loans Accounts גרסה 1.4

יש לשים לב להבהרות שפורסמו ע"י רשות שוק ההון, ביטוח וחסכון CRM – Clarification  (Excel)

את רשימת הלקוחות וההלואות הזמינות בסביבת ה Sandbox ניתן למצוא בנספח ב'.

1. תהליך בקשת ואישור הרשאת לקוח (Consent) בסביבת הייצור

מתן שירותי מידע בבנקאות פתוחה מבוסס על מתן הרשאה מאת הלקוח המאשרת לספק המידע למסור מידע לצרכן המידע.

להלן השלבים בתהליך הקמת ואישור ההרשאה:

1.1 אופן בחירת החשבונות

 

1.1.1 הרשאה מפורטת (Detailed)

הלקוח בוחר באפליקציה של הנש"ם (TPP) את חברת כלל ביטוח ופיננסים, את סלי המידע ואת ההלוואות לגביהן הוא מוכן לשתף מידע עם הנש"ם

על הלקוח לציין את מזהה ההלוואה המנוהלת בכלל ביטוח ופיננסים בהתאם להנחיות הרגולטור באמצעות 4 מאפיינים הנכללים בקבוצת הנתונים Other:

• Identification

• schemeNameCode

• schemeNameProprietary

• issuer

 

1.1.2 הקמת הרשאת BankOffer

הלקוח יבחר את ההלוואות לגביהן הוא מבקש לשתף מידע עם הנש"מ בדף הנחיתה הייעודי באתר כלל ביטוח ופיננסים. במקרה של BankOffer הנש"מ יעביר את קבוצת הנתונים access ללא מזהים של הלוואות (קבוצות ההרשאות של accounts ו/או balances  יהיו ריקות).

 

1.2 פניה לבקשת ההרשאה לשירות PostConsent.

 

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

על פי הנחיות הרגולטור קבוצת ההרשאות של תנועות – transactions אינה נתמכת

יש להעביר בשדה PSU-ID  מספר תעודת זהות בשדה הזדהות לקוח על ידי מספר דרכון איננה נתמכת.

שדה PSU-ID-Type יש להשאיר ריק.

2. מידע Configuration Data

לקבלת כתובות ה Authorization ו- Token End Points יש להפעיל שירות GetMetadata בהתאם לתקן.

M. Jones, N. Sakimura, J. Bradley; "OAuth 2.0 Authorization Server Metadata";

June 2018, https://www.rfc-editor.org/rfc/rfc8414.html

3. אישור / דחיית הרשאה בסביבת ה Sandbox

בכלל ביטוח ופיננסים נבנו 2 שירותי סימולציה אשר מדמים את פעולת האישור/דחייה של הלקוח בדף הנחיתה לבחירת הלוואות . אי לכך לא קיימת בסביבת ה- Sandbox תמיכה באפשרות להפנות את ה Browser של הלקוח לשירות Authorization ולבצע Redirect לדף הנחיתה.

 

להלן תיאור של שני השירותים הייעודיים בסביבת ה Sandbox. לצפייה בפרטי השירות ראה קובץ YAML של שירותי סביבת ה Sandbox. לדוגמאות לשני השירותים ראה נספח א'

 

3.1 שירות אישור הרשאה – Consent Approval

השירות מקבל כקלט אינדיקציה שהלקוח בחר את כל החשבונות (AllAccountsInd) או לחלופין רשימת ResourceID's אשר מייצגים את ההלוואות שנבחרו לשיתוף מידע ע"י הלקוח (במסגרת מערך ResourceIDList). את מזהי ההלוואות הזמינות בסביבת ה Sandbox ניתן למצוא בנספח ב'.

השירות מחזיר בפרמטר Location את ה AccessCode  של ההרשאה, על מנת לאפשר את המשך התהליך עם הפעלת שירות Post Access Token

 

3.2 שירות דחיית הרשאה – Consent Disapproval

בשירות זה יש להעביר בתג DisapprovalCode ערך קבוע 1 ובתג DisapprovalDesc ערך קבוע "דחיית הרשאה".

4. קבלת Access Token

המשך התהליך ע"י פניה לשירות PostAccessToken עם ה AccessCode אשר התקבל בסעיף קודם לקבלת ה- AccessToken עבור ההרשאה.

5. בדיקת סטאטוס הרשאה

ניתן לבדוק את סטאטוס ההרשאה ע"י פנייה לשירות GetConsentStatusRequest .

6. שליפת מידע על הלוואות

במידה ותהליך אישור הסכמה הושלם בהצלחה ניתן להתחיל לפנות לשירותי שליפת המידע עם ה AccessToken לקבלת מידע על ההלוואות בהתאם להרשאה.
תוקף ה- Access Token הוא 5 דקות. במידת הצורך יש לבצע פעולת Refresh   .

7. שליפת פרטי הרשאה

ניתן לפנות לשירות Get Consent Request לקבלת פרטי ההרשאה כפי שאושרה ע"י הלקוח.

8. ביטול הרשאה

ניתן לבטל בכל עת הרשאה תקפה באמצעות הפעלת שירות Delete Consent. שירות זה מקבל את מזהה ההרשאה (ConsentID) כפרמטר בקלט.

9. אחזור מידע על הלוואות הלקוח לפי הרשאה מאושרת

לאחר סיום תהליך אישור ההרשאה ניתן לפנות ל 3 שירותי אחזור מידע על הלוואות המנוהלות בכלל ביטוח ופיננסים :

• קבלת רשימת הלוואות – שירות Read Loan Account List. השירות יחזיר את רשימת ההלוואות עם הפרטים שלהן, בהתאם להרשאות של הרשאת הגישה, כאשר לכל הלוואה משויך מזהה ההלוואה ייחודי – ResourceID

 

• קבלת פרטי הלוואה מסוימת – Read Loan Account Details – לשירות נדרש להעביר מזהה הרשאה – ResourceID. השירות יחזיר את פרטי ההלוואה ו/או את היתרות בהלוואה בהתאם להרשאה שאושרה ע"י הלקוח

 

• קבלת יתרות בהלוואה מסוימת – Read Loan Account Details – לשירות נדרש להעביר מזהה הרשאה – ResourceID. השירות יחזיר את יתרות ההלוואה במידה וניתנה הרשאת גישה מתאימה.

 

10. דוגמאות לשירותי בנקאות פתוחה

1. דוגמאות ל- GetMetaData - לצפייה לחצו כאן

2. דוגמאות ל- PostAccessToken - לצפייה לחצו כאן

3. דוגמאות ל- PostConsent - לצפייה לחצו כאן

4. דוגמאות ל- ReadLoanAccountsList - לצפייה לחצו כאן

לפתיחת רשימה לחץ אנטר יש להשתמש בחיצי המקלדת לשינוי הערך ש להקליד את שם היישוב ולעבור באמצעות חצי המקלדת בין היישובים המתאימים ברשימה ולבחור את היישוב באמצעות מקש ה-Enter