תיעוד API

נקודת הקצה

POST /api/public/validate

מאומת דרך הכותרת x-api-key. ניתן להשתמש גם ב-Authorization: Bearer ….

גוף הבקשה

bank — קוד הבנק (מספר). למשל 10 ללאומי, 12 להפועלים.

branch — מספר הסניף (טקסט או מספר).

account — מספר החשבון כולל ספרת/ות הביקורת.

דוגמת קריאה (cURL)
curl -X POST https://banksisrael.ipfix.co.il/api/public/validate \
  -H "Content-Type: application/json" \
  -H "x-api-key: bv_xxxxxxxxxxxxxxxxxx" \
  -d '{
    "bank": 10,
    "branch": "936",
    "account": "07869660"
  }'
דוגמת קריאה (JSON)
POST https://banksisrael.ipfix.co.il/api/public/validate

Headers:
{
  "Content-Type": "application/json",
  "x-api-key": "bv_xxxxxxxxxxxxxxxxxx"
}

Body:
{
  "bank": 10,
  "branch": "936",
  "account": "07869660"
}
דוגמת קריאה (JavaScript fetch)
fetch("https://banksisrael.ipfix.co.il/api/public/validate", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "bv_xxxxxxxxxxxxxxxxxx"
  },
  body: JSON.stringify({
    bank: 10,
    branch: "936",
    account: "07869660"
  })
})
  .then(r => r.json())
  .then(console.log);
דוגמת תשובה
{
  "valid": true,
  "bank_code": 10,
  "bank_name": "בנק לאומי",
  "branch": "936",
  "account": "07869660"
}

במקרה שמספר החשבון לא תקין: valid: false + reason עם הסבר קצר.

קודי תגובה

200 — הבדיקה בוצעה (ראה valid).

400 — קלט שגוי.

401 — מפתח חסר או לא תקין.

403 — המפתח הושבת.

בנקים נתמכים
01ישראכרט
03בנק אש
04בנק יהב
06מקס איט פיננסים
09בנק הדואר
10בנק לאומי
11בנק דיסקונט
12בנק הפועלים
13בנק אגוד
14בנק אוצר החייל
15אופק אגודת אשראי
17מרכנתיל דיסקונט
18בנק וואן זירו
20בנק מזרחי-טפחות
21נימה שפע ישראל
22סיטיבנק
23HSBC
31בנק הבינלאומי
34ערבי ישראלי
35GROW
39הבנק ההודי
46בנק מסד
47גלובל רמיט
52בנק פאג"י
54בנק ירושלים
58רי-וויר
69GMT
79019 שירותי תשלום
94הפניקס גמא

לבנק ירושלים (54) ולבנק ההודי (39) אין חוקיות ספרת ביקורת — תמיד יוחזר valid: true. הבדיקה היא של חוקיות ספרת הביקורת בלבד, ולא אישור שהחשבון פעיל בבנק.