מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
מבוא
מונטיזציה מאפשרת לכם לפרסם למפתחים החזרים כספיים על 'עסקאות רכישה'. נניח שאתם הם מפעילי סלולר, ומציעים למפתחים ממשק API לתשלום כדי לחייב מנויים בנייד רכישה של אפליקציה או תוכן במסגרת האפליקציה. בכל פעם שמנוי משתמש ב-API ביצוע רכישה, מדובר בעסקת רכישה.
עסקאות רכישה יכולות להוביל להחזרים כספיים. לדוגמה, ייתכן שהתוכן לא יועבר, או שהצד השלישי לא מרוצה מהרכישה. במקרים כאלה, המפתח מנפיק החזר כספי לצד השלישי. מונטיזציה מאפשרת לכם לבצע החזר כספי מקביל. הדבר שרלוונטיות במיוחד לתוכניות חלוקת הכנסות.
נניח שהמפתח שהעניק את ההחזר הכספי למנוי בנייד רכש הכנסה לתוכנית שיתוף המוצר של ה-API. נניח שהתוכנית קוראת למפתח לקבל 70% המחיר נטו/נטו של עסקת הרכישה. למעשה, פרסום החזר כספי פירושו ביטול של עסקת רכישה, כלומר ניכוי של 70% מהתשלום לתשלום למפתח עבור החודש המועד שבו בוצע ההחזר הכספי (החודש עשוי להיות שונה מהחודש שבו עסקה שבוצעה ברכישה).
פרסום החזר כספי באמצעות ממשק המשתמש הקלאסי של Edge (Edge לענן פרטי בלבד)
אפשר לפרסם החזר כספי עבור כל החזר כספי בגין "הצלחה" עסקת רכישה, כלומר ה-API חייבנו בהצלחה את הצד השלישי, ועדיין לא הנפקנו עבורו החזר כספי. פרסום של החזר כספי גורם ליצירה של עסקת החזר כספי עם הורה מזהה עסקה. מזהה העסקה הוא המזהה של עסקת הרכישה.
יש לך אפשרות לפרסם החזר כספי עבור הסכום המלא של עסקת הרכישה המקורית, או עבור בסכום חלקי. אפשר גם לפרסם כמה החזרים כספיים חלקיים, אבל את הסכום הכולל של ההחזרים הכספיים לא יכול להיות גבוה מסכום הרכישה המקורי.
כדי לפרסם החזר כספי:
- בכרטיסייה 'מונטיזציה', בוחרים באפשרות 'החזרים כספיים'.
הדף 'החזרים כספיים' נפתח.
- בתפריט הנפתח 'חודש חיוב', בוחרים את החודש שבו עסקת הרכישה בוצעה.
שהתרחשו. לאחר מכן לוחצים על '+ החזרים כספיים'.
תוצג רשימה של כל עסקאות הרכישה שבוצעו בהצלחה ברכישה בחודש.
ניתן לסנן את רשימת ההחזרים הכספיים לפי שם המפתח או על ידי חיפוש העסקה.
כדי לסנן לפי מפתח, בוחרים את המפתח מתוך התפריט הנפתח 'מפתח'. הזה מציגה רשימה שכוללת רק את העסקאות שקשורות למפתח שנבחר.
כדי לסנן לפי מזהה עסקה, יש להזין את מזהה העסקה של הרכישה המקורית ברצונך לבצע החזר כספי. הפעולה הזו תחזיר את העסקה עבור המזהה הזה.
- מסמנים את התיבה 'בחירה' בשורות של העסקאות שרוצים לבצע עבורן החזר כספי.
- בתפריט הנפתח 'סוג', בוחרים באפשרות 'סה"כ' או 'חלקי'.
אם תבחרו באפשרות 'סה"כ', תקבלו החזר כספי על הסכום הכולל של הרכישה. אם בוחרים יתקבל החזר כספי חלקי על חלק מהרכישה.
אם בוחרים באפשרות 'חלקי', מזינים את הסכום של ההחזר הכספי החלקי בשדה 'סכום'. אפשר לבצע החזר כספי רק עד לסכום הכולל של הרכישה. אם כבר פרסמתם חלק החזר כספי, אפשר להזין רק סכום עד לסכום שנותר לרכישה. כמו כן, אם בעסקת הרכישה המקורית מוצגים גם מחיר ברוטו וגם מחיר נטו, צריך גם לציין אם הסכום החלקי שברצונך לקבל הוא ברוטו או נטו.
- לוחצים על 'שמירה' כדי לעבד את ההחזר הכספי (או על 'ביטול' כדי לבטל).
ההחזר הכספי יופיע בחודש של הרכישה המקורית אם חודש החיוב עדיין פתוח, אחרת ההחזר הכספי יופיע בתאריך הנוכחי.
אם מקבלים החזר כספי חלקי, מתבצע עיבוד של ההחזר הכספי בהתאם לסכום החלקי ולחלוקת ההכנסות. מנוכה לפי החלק היחסי של הסכום החלקי מתוך הסכום המלא. ב מהדוגמה שלמעלה לגבי החזר כספי חלקי, הסכום החלקי הוא 0.50/1.12 = 45% מהמחיר ברוטו, כך 45% מחלקו של המפתח בהכנסות ינוכו.
בדיקה בממשק המשתמש אם בוצע החזר כספי מעובד
כדי לבדוק אם בוצע עיבוד להחזר כספי, יש לבחור את חודש החיוב בחלק העליון של המסך בדף 'החזרים כספיים'. זהו החודש שבו בוצעה הרכישה אם חודש החיוב עדיין פתוח, או החודש הנוכחי, אם החודש לחיוב סגור. תוצג רשימה של כל ההחזרים הכספיים שפורסמו בחודש.
פרסום החזר כספי באמצעות ה-API
כדי לפרסם החזר כספי, יש לשלוח בקשת POST אל
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions
,
כאשר {package_id}
הוא המזהה של חבילת ה-API שאליה ההחזר הכספי
חל.
כששולחים את הבקשה, צריך לציין את הפרמטרים של השאילתה:
- המזהה של עסקת הרכישה שעבורה רוצים לקבל החזר.
- סוג ההכנסה (
GROSS
אוNET
) של עסקת הרכישה. - סכום ההחזר הכספי.
- הערה שמתארת את הסיבה להחזר הכספי.
לחלופין, אפשר לזהות כפרמטר של כתובת אתר חבילת API שאליה ההחזר הכספי חל.
לרשימה מלאה של כתובת ה-URL, אפשר לעיין בהגדרות התצורה של החזרים כספיים פרמטרים שניתן לציין בבקשת החזר כספי.
לדוגמה: הבקשה הבאה מנפיקה החזר כספי על עסקת רכישה. ההחזר הכספי הוא 50% מהסכום ברוטו של עסקת הרכישה.
$ curl -H "Content-Type:application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/refund-transactions?revenueType=GROSS&refundAmount=0.5&parentTxId=abf50909-2492-4bf5-8704-ade05f4d43b3&transactionNote=Refund for purchase transaction" \ -u email:password
התשובה אמורה להיראות בערך כך (מוצג רק חלק מהתשובה):
{ "application" : { ... }, "product" : [ { ... { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], ... }, "currency" : "USD", "developer" : { ... "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, ... }, "endTime" : "2013-09-01 21:59:59", "environment" : "PROD", "euroExchangeRate" : 0.8123, "gbpExchangeRate" : 0.6910, "grossPrice" : 0.5, "id" : "61f7eb88-f8cc-4cda-afd8-4a61fba3dd33", "isRevOnGrossOrNet" : "NET", "isVirtualCurrency" : false, "notes" : "Refund for purchase transaction", "itemDesc" : "test application", "netPrice" : 0.4464, "orgRevenueShareAmount" : 0.1339, "parentId" : "abf50909-2492-4bf5-8704-ade05f4d43b3", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", ... }, "ratePlanLevel" : "STANDARD", "revenueShareAmount" : 0.3125, "startTime" : "2013-09-01 21:59:59", "status" : "SUCCESS", "tax" : 0.0536, "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "REFUND", "usdExchangeRate" : 1.0724, "utcEndTime" : "2013-09-01 21:59:59", "utcStartTime" : "2013-09-01 21:59:59" }
הגדרות אישיות של החזרים כספיים ב-API
אפשר לציין את הפרמטרים הבאים של שאילתה בבקשת החזר כספי:
שם | תיאור | ברירת מחדל | חובה? |
---|---|---|---|
monetizationPackageId |
חבילת ה-API שעליה חל ההחזר הכספי. |
לא רלוונטי | לא |
parentTxId |
עסקת הרכישה שעבורה רוצים לקבל החזר כספי. |
לא רלוונטי | כן |
revenueType |
סוג ההכנסה ( |
לא רלוונטי | כן |
refundAmount |
סכום ההחזר הכספי. |
לא רלוונטי | כן |
transactionNote |
הערת טקסט שמתארת את הסיבה להחזר הכספי. |
לא רלוונטי | כן |
השלבים הבאים
מידע על תזמון משימות שקשורות למונטיזציה ועל המשימות המתוזמנות באופן אוטומטי בתזמון משימות במונטיזציה.