ביטול מסמך - (Cancel document and refund credit card)
מתי להשתמש בפונקציה זו?
ניתן להשתמש בפונקציה זו על מנת לבטל מסמך שהופק ולבטל את העסקה שקשורה אליו.
בניגוד לפונקציות אחרות שבהן ניתן לזכות אשראי, כגון Create a new Iframe Redirect page, Do Transaction ו-Refund By Transaction Id, הפונקציה הזאת מאפשרת לבטל עסקה ספציפית וליצור עליה מסמך קשור.
פונקציה זו דומה ל-Refund By Transaction Id, אך במקרה הזה, היא יוצרת מסמך מתאים ומאפשרת לבטל רק את הסכום המלא של העסקה.
להלן קישור לפונקציה בJSON.
https://secure.cardcom.solutions/api/v11/Documents/CancelDoc
להלן הפרמטרים שצרים להעביר בפונקציה Cancel document and refund credit card.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
| מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ApiName |
test2025 | שם משתמש ממשקים. יש לקבל פרמטר זה מבית העסק. |
| 2 | ApiPassword |
"kzFKfohEvL6AOF8aMEJz" | סיסמת API, מיועד לזיכוי וביטול עסקאות. |
| 3 | DocumentNumber | 2489 | מספר מסמך. |
| 4 | DocumentType |
1 - חשבונית מס קבלה 2 - חשבונית זיכוי והחזר כספים 50- הצעת מחיר 100 - הזמנה (ללא תשלום) 101 - אישור הזמנה - מאתר ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה 300 - חשבון עסקה 301 - דרישה לתשלום 302 - ביטול דרישה לתשלום 305 - חשבונית מס 330 - חשבונית זיכוי 410 - החזר כספים לקוחות(קבלה זיכוי) 405 - קבלה על תרומה 406 - זיכוי קבלה תרומה(החזר כספים) 303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי |
מספר מסמך. |
| 5 | IsCancelEmailSend | boolean - true \ false. כלומר אם מעבירים כאן true המסמך לא ישלח | האם לא לשלוח מסמך זיכוי לאימייל? |
| 6 | IsSendSMS | boolean - true \ false | האם לשלוח SMS על המסמך שהופק? |
| 7 | IsCreditCardCancelOnly | boolean - true \ false | האם לדלג על ביטול המסמך במקרה ויש שם אמצעי תשלום באשראי? |
RESPONSE של Cancel document and refund credit card.
| מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ResponseCode | 0 |
0 - הפעולה תקינה ,אחרת שגוי - שגיאת פיתוח. |
| 2 | Description | "העסקה בוצעה בהצלחה" | תיאור התשובה , במידה ומתקבל תשובה שונה, העסקה לא בוצעה בהצלחה. |
| 3 | NewDocumentNumber | 5198 | המספר מסמך החדש שהופק. |
| 4 | NewDocumentType |
1 - חשבונית מס קבלה 2 - חשבונית זיכוי והחזר כספים 50- הצעת מחיר 100 - הזמנה (ללא תשלום) 101 - אישור הזמנה - מאתר ( מסמך פנימי לא להנח"ש) - הזמנה ששולמה 300 - חשבון עסקה 301 - דרישה לתשלום 302 - ביטול דרישה לתשלום 305 - חשבונית מס 330 - חשבונית זיכוי 410 - החזר כספים לקוחות(קבלה זיכוי) 405 - קבלה על תרומה 406 - זיכוי קבלה תרומה(החזר כספים) 303 - חשבון קבלה (כמו חשבונית לעוסק פטור , נדיר לשימוש) 304 - חשבון קבלה זיכוי |
מספר סוג מסמך זיכוי חדש שהופק. |
| 5 | AccountID | "5154" | מספר כרטיס לקוח. |
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
הקריא לביטול המסמך:
התשובה המתקבלת: