לדלג לתוכן הראשי

סוגי יתרה (balanceType) ב-GET accounts — לפי סוג חשבון

מה כל balanceType אומר בתשובת GET /v2/data/accounts, ואילו סוגי יתרה רלוונטיים לעו"ש, כרטיסים, פקדונות והלוואות.

נכתב על ידי Eliron Giny

בתשובת GET /v2/data/accounts כל חשבון מכיל מערך balances, וכל יתרה מורכבת מ-balanceType (סוג היתרה) ו-balanceAmount (מטבע + סכום). אותו balanceType יכול לקבל משמעות שונה לפי סוג החשבון (accountType: CHECKING / CARD / LOAN / SAVINGS). מאמר זה מסביר מה כל סוג יתרה אומר ואילו סוגים רלוונטיים לכל חשבון. ההגדרות עוקבות אחר לוגיקת ISO20022 / Berlin Group, ואינן כוללות מסגרות אשראי אלא אם creditLimitIncluded=true.

GET /v2/data/accounts        // scope: read:accounts
// ?accountType=CHECKING | CARD | LOAN | SAVINGS

טבלת סיכום מהירה

balanceType

עו"ש

כרטיסים

פקדונות

הלוואות

closingBooked

✔ (חובה)

expected

interimAvailable

✔ (עתידי)

interimBooked

forwardAvailable

openingBooked

✘ לא נתמך


עו"ש (CHECKING)

החשבון העשיר ביותר ביתרות:

  • closingBooked (חובה) — היתרה בספרים המעודכנת ביותר למועד הפנייה. "היתרה הרשמית", רק תנועות סופיות שנרשמו.

  • expected — תנועות שנרשמו + תנועות ידועות שטרם סופיות; משקפת את יתרת סוף היום אם הכול ייסגר ולא תתקבל תנועה נוספת.

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

  • interimBooked — יתרת ביניים רשומה בספרים; על בסיס תנועות זכות/חובה שכבר נרשמו בספרים בפרק זמן החישוב.

  • forwardAvailable — יתרה זמינה עתידית לתאריך שצוין. אם הבנק לא מפרסם זאת באתר — לא חייב לדווח; אם יש ערך שונה לסניף ולאתר, מדווחים את מה שהלקוח רואה באתר.


כרטיסי אשראי וחיוב (CARD)

בכרטיסים משתמשים בעיקר ב-3 יתרות: closingBooked, interimBooked, interimAvailable. המשמעות משתנה לפי סוג הכרטיס:

  • חשבון הכרטיס המאוחדclosingBooked = היתרה בפועל בחשבון הכרטיס; interimBooked = העסקאות שנצברו בכל הכרטיסים וטרם חויבו (חובה); interimAvailable = המסגרת הפנויה / OPEN TO BUY (חובה).

  • כרטיס אשראי (חיוב נדחה) — אופציונלי; אם הבנק מממש, מצופה לתת את שלוש היתרות: closingBooked = הסכום שחויב במחזור האחרון; interimBooked = חיובים שנצברו ממועד החיוב האחרון ועד הבא וטרם חויבו; interimAvailable = המסגרת הפתוחה לניצול בכרטיס/באוסף הכרטיסים.

  • כרטיס נטען (Prepaid)interimAvailable = היתרה הנוכחית בכרטיס (חובה); closingBooked = optional.

  • כרטיס חיוב מיידי (Debit) — יתרות לא רלוונטיות (N.R), מאחר שהיתרה משתקפת בעו"ש עצמו. מדווחים רק את התנועות.


פקדונות (SAVINGS)

  • closingBooked — היתרה בספרים עדכנית לשליפה (כמה כסף בפקדון כרגע).

  • expected — שווי הפקדון לתחנה / לסוף התקופה (יתרה משוערת, למשל כולל ריבית צפויה, לתאריך הרלוונטי).

interimAvailable / interimBooked / forwardAvailable / openingBooked אינם רלוונטיים לפקדונות. (בכוונת BOI להוסיף בעתיד accumulatedAmount — הסכום הצבור בחיסכון.)


הלוואות (LOAN) — כולל משכנתא ומסגרת עו"ש

הלוואה ומשכנתא:

  • closingBooked — שני שימושים: (1) היתרה בספרים עדכנית לשליפה (כמה נשאר לשלם); (2) לשיקוף סכום ההלוואה המקורי — מדווחים closingBooked עם referenceDate של תאריך פתיחת ההלוואה.

  • expected — יתרה בספרים + תנועות צפויות באותו יום.

  • interimAvailable (עתידי) — המסגרת המקורית עם תאריך העמדתה + היתרה העדכנית לניצול (במשכנתא: מדווח כחלק מהריסורס של ההלוואה הראשית).

  • interimBooked — יתרת ביניים רשומה בספרים, מחושבת במהלך יום העסקים על בסיס תנועות זכות/חובה שנרשמו בספרים.

מסגרת עו"ש (Overdraft): closingBooked = המינוס (השימוש בפועל במסגרת); expected = המינוס + תנועות צפויות באותו יום; interimAvailable (עתידי) = המסגרת המקורית + מסגרת עדכנית פנויה.


מילון סוגי היתרה

  • closingBooked — יתרת סוף תקופת הדיווח: יתרת הפתיחה + כל התנועות שנרשמו בתקופה. תנועות סופיות בלבד.

  • expected — תנועות שנרשמו + פריטים ממתינים הידועים; השלכת יתרת סוף היום.

  • interimAvailable — יתרה זמינה המחושבת במהלך יום העסקים, נתונה לשינויים, על בסיס תנועות שנרשמו.

  • interimBooked — כמו interimAvailable אך מתייחסת לתנועות שכבר נרשמו בספרים.

  • forwardAvailable — יתרה זמינה לתאריך עתידי.

  • openingBooked — יתרת פתיחה (= יתרת הסגירה של הדיווח הקודם). לא נתמך בשוק הישראלי.

  • nonInvoiced — לכרטיסים בלבד; טרם הוגדר סופית.


תיעוד מלא

למבנה התשובה המלא וכל הפרמטרים של ה-endpoint: Get accounts by user — docs.open-finance.ai.

האם קיבלת תשובה לשאלתך?