לאחר שחיבור פעיל, אפשר לשלוף את החשבונות והתנועות שלו דרך ה-API. שתי הקריאות מחזירות נתונים של ה-userId שעבורו הונפק הטוקן.
שליפת חשבונות
GET /v2/data/accounts // scope: read:accounts
פרמטרים נפוצים (כולם אופציונליים):
connectionId– סינון לפי חיבור.accountType– סינון לפי סוג חשבון.limit– מספר תוצאות (מקסימום 500),nextPage– עימוד,sort–1/-1,includeDuplicates–0/1.
שליפת תנועות
GET /v2/data/transactions // scope: read:transactions
פרמטרים נפוצים (כולם אופציונליים):
dateFrom/dateTo– טווח תאריכים בפורמטYYYY-MM-DD.accountId/connectionId/providerId– סינון לפי חשבון, חיבור או ספק.type–BANKאוCARD.limit– מספר תוצאות (ברירת מחדל 500, מקסימום 2000).sort–1לעולה,-1ליורד.includeDuplicates–0(ברירת מחדל) או1.
עימוד (Pagination)
כשיש יותר תוצאות, התשובה מחזירה nextPage (טוקן). העבר אותו בפרמטר nextPage בבקשה הבאה, וחזור עד שאין עוד עמודים. הטוקן תקף לאותה בקשה/משתמש בלבד.
טריות הנתונים
הנתונים מתעדכנים במחזורי סנכרון מהבנק, כך שתנועה חדשה עשויה להופיע בהשהיה. ראה: למה התנועות או היתרה לא מתעדכנות.
תיעוד מלא
למבנה התשובה המלא וכל הפרמטרים: docs.open-finance.ai.