זיכוי עסקה חלקית \ מלא לפי מספר עסקה - (Refund By Transaction Id)
מתי להשתמש בפונקציה זו?
בתי עסקים אשר רוצים לנהל ולזכות את העסקאות מהצד שלהם ולא להיכנס לממשק של קארדקום יכולים להשתמש בפונקציה זאת.
הערה: הזיכוי עסקה לא מפיק מסמך.
להלן קישור לפונקציה בJSON.
שיטת בקשה - POST.
https://secure.cardcom.solutions/api/v11/Transactions/RefundByTransactionId
להלן הפרמטרים שצרים להעביר בפונקציה Refund By Transaction Id.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ApiName | "test2025" | שם API. |
2 | ApiPassword | "test5000$" | סיסמת API. |
3 | TransactionId | 204961310 | מספר עסקה פנימית. |
4 | PartialSum | 100 | סכום חלקי לזיכוי. |
5 | CancelOnly | boolean - true \ false | ביטול עסקה בלבד - עד מועד ההפקדה. |
6 | SapakMutav |
| מספר לקוח בעבודה ברב מוטב. |
7 | AllowMultipleRefunds | boolean - true \ false | האם ניתן לעשות כמה זיכויים חלקיים על אותה עסקה. אם לא נשלח לאחר הזיכוי הראשון, לא יהיה אפשרי לעשות זיכויים חלקיים. |
8 | CustomFields | Id - 20 Value - "value" | הערכים של השדות המותאמים אישית. |
שימו לב! - כאשר מבצעים בדיקות על מסוף הבדיקות של קארדקום יש להשתמש בפרטי הAPI שנמצאים בהגדרות > הגדרות חברה ומשתמשים > ניהול מפתחות API ולא בפרטים שקיבלתם מהנציג.
RESPONSE של Refund By Transaction Id.
מספר | פרמטר | ערכים אפשריים לדוגמא | תיאור |
1 | ResponseCode | 0 | 0 - הפעולה תקינה |
2 | Description | "העסקה בוצעה בהצלחה" | תיאור התשובה , במידה ומתקבל תשובה שונה, העסקה לא בוצעה בהצלחה. |
3 | NewTranzactionId | 204972703 | מספר עסקת ביטול. |
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
דוגמא לביטול עסקה:
https://secure.cardcom.solutions/api/v11/Transactions/RefundByTransactionId
{
"ApiName": "kzFKfohEvL6AOF8aMEJz",
"ApiPassword": "FIDHIh4pAadw3Slbdsjg",
"TransactionId": 204966999,
"CancelOnly": true,
"AllowMultipleRefunds": true
}
דוגמא לזיכוי עסקה חלקי:
{
"ApiName": "kzFKfohEvL6AOF8aMEJz",
"ApiPassword": "FIDHIh4pAadw3Slbdsjg",
"TransactionId": 204966999,
"PartialSum": 200,
"CancelOnly": false,
"AllowMultipleRefunds": true
}
דוגמא לתשובה המתקבלת:
{
"ResponseCode": 0,
"Description": "עסקה זוכתה בהצלחה",
"NewTranzactionId": 204972703
}