מרכז הידע / ממשקים API

שאלו את ה-AI

✦ תשובת ה-AI

חושב…

מקורות

    שינוי סטטוס היסטורית חיובים בהוראת קבע (Update debit order history item to irrevocable status)

    מתי להשתמש בפונקציה זו?

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

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

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

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

    איך אפשר לזהות בAPI חוב שנוצר להוראת קבע?

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

    הראשונה היא באמצעות Webhook (דיווח אוטומטי) על הוראות קבע. כשיש כשלון בחיוב, המערכת שולחת דיווח מיידי על כך שהחיוב לא עבר בצורה תקינה, כלומר שנוצר חוב.

    הדרך השנייה היא להשתמש בפונקציה Get recurring payment history (היסטוריית חיובים של הוראת קבע). באמצעות הפונקציה הזו, אפשר לבדוק את סטטוס החיובים בהיסטוריה של הוראת הקבע. אם מתקבל הסטטוס DEBTAUTOBILLING (חוב לגבייה אוטומטית), זה אומר שנוצר חוב עבור החיוב הספציפי הזה.

    Get recurring payment history

    להלן קישור לפונקציה בJSON.

    שיטת בקשה - POST.

    Update debit order history item to irrevocable status

    https://secure.cardcom.solutions/api/v11/RecuringPayments/ChangeStatusForHistoryRecurringToIrrevocable 

     

    להלן הפרמטרים שצרים להעביר בפונקציה Update debit order history item to irrevocable status.

    מקרא:

    פרמטר אדום - חובה

    פרמטר מודגש - מומלץ

    פרמטר לא אדום ולא מודגש - אופציונלי

    מספר
         		פרמטר ערכים אפשריים לדוגמא תיאור
    1

    ApiUserName

    		 "test2025" שם משתמש API.
    2

    ApiPassword

    		 "test5000$" סיסמת משתמש API.
    3 RowID int מספר שורת חיוב פנימי של בכרטיס לקוח.
    4 AccountId 37452 מספר כרטיס לקוח.
    5 ChangeTo

    "DebtForTracking"

    ----------------------------

    "NoOtherPaymentMethod"

    ----------------------------

    "BadDebt"

    ChangeTo - לאיזה סטטוס לשנות את החוב.

    --------------------------

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

    --------------------------

    NoOtherPaymentMethod - שולם באמצעי אחר, במקרה והלקוח שילם עם מזומן, הוראת קבע או כל אמצעי אחר שלא עובר דרך קארדקום, אפשר לבחור בסטטוס זה. המערכת תפסיק לנסות לחייב אותו בצורה אוטומטית.

    --------------------------

    BadDebt - חוב אבוד. המערכת תפסיק לנסות לחייב את החוב בצורה אוטומטית.

     

    RESPONSE של Update debit order history item to irrevocable status.
     
    מספר
         		פרמטר ערכים אפשריים לדוגמא תיאור
    1 ResponseCode 0 קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה.
    2 Description "Successful operation" תיאור התשובה. ''OK'' זה טוב.

     

    להלן קוד לדוגמא לפונקציה ביחד עם התשובה.

    קריאת POST לשינוי סטטוס חיוב.

    {
      "ApiUserName": "test2025",
      "ApiPassword": "test5000$",
      "AccountId":37452,
      "RowID": "340642",
      "ChangeTo": "BadDebt"
    }
     

    התשובה המתקבלת:


    {
        "ResponseCode": 0,
        "Description": "Successful operation"
    }
     

    האם המאמר הזה עזר לך?