החזרים כספיים לאחר פרסום

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

מבוא

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

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

נניח שהמפתח שהנפיק את ההחזר הכספי למנוי בנייד רכש תוכנית חלוקת הכנסות עבור מוצר ה-API שלך. נניח שלפי התוכנית, המפתח מבקש לקבל 70% מהמחיר נטו/ברוטו של עסקת הרכישה. בעצם פרסום של החזר כספי, אתה מבטל את עסקת הרכישה. כלומר, אתה מנכה 70% מהתשלום שמגיע למפתח על החודש שבו בוצע ההחזר הכספי (החודש עשוי להיות שונה מהחודש שבו בוצעה עסקת הרכישה בפועל).

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

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

אפשר לפרסם החזר כספי של הסכום המלא של עסקת הרכישה המקורית או של סכום חלקי. אפשר גם לפרסם כמה החזרים כספיים חלקיים, אבל הסכום הכולל של ההחזרים הכספיים לא יכול להיות גבוה מסכום הרכישה המקורי.

כדי לפרסם החזר כספי:

  1. בכרטיסייה 'מונטיזציה', בוחרים באפשרות 'החזרים כספיים'.

    הדף 'החזרים כספיים' ייפתח.

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

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

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

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

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

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

    אם בוחרים באפשרות 'סה"כ', יתבצע החזר כספי על הסכום הכולל של הרכישה. אם בוחרים באפשרות 'חלקי', יתבצע החזר כספי על סכום חלקי של הרכישה.

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

  5. לוחצים על 'שמירה' כדי לעבד את ההחזר הכספי (או על 'ביטול' כדי לבטל).

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

    אם מדובר בהחזר כספי חלקי, המערכת מעבדת את ההחזר הכספי בסכום החלקי, וכל חלוקת הכנסות מנוכה לפי החלק היחסי של הסכום החלקי מתוך הסכום המלא. בדוגמה של ההחזר הכספי החלקי שלמעלה, הסכום החלקי הוא 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

סוג ההכנסה (GROSS או NET) של עסקת הרכישה.

לא רלוונטי כן
refundAmount

סכום ההחזר הכספי.

לא רלוונטי כן
transactionNote

הערה בטקסט שמתארת את הסיבה להחזר הכספי.

לא רלוונטי כן

השלבים הבאים

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