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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

מבוא

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

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

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

פרסום החזר כספי באמצעות ממשק המשתמש הקלאסי של Edge (Edge for Private Cloud בלבד)

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

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

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

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

   

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

   

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

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

   

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

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

   

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

   

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) של עסקת הרכישה.
• סכום ההחזר הכספי.
• הערה שמתארת את הסיבה להחזר הכספי.

אפשר גם לציין כפרמטר של כתובת URL חבילת 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

אפשר לציין בבקשה להחזר כספי את הפרמטרים הבאים של השאילתה:

השלבים הבאים

במאמר תזמון משימות שקשורות למונטיזציה מוסבר איך לתזמן משימות שקשורות למונטיזציה ומהן המשימות שמתוזמנות אוטומטית.