شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
مقدمه
کسب درآمد به شما امکان می دهد برای «تراکنش های خرید» به توسعه دهندگان بازپرداخت ارسال کنید. فرض کنید شما یک اپراتور تلفن همراه هستید و به توسعهدهندگان یک API پرداخت پیشنهاد میکنید تا از مشترکین تلفن همراه برای خرید یک برنامه یا محتوای درون برنامه هزینه دریافت کنند. هر بار که مشترکی از API برای خرید استفاده می کند، این یک معامله خرید است.
معاملات خرید می تواند منجر به بازپرداخت شود. برای مثال، ممکن است محتوا تحویل داده نشود، یا شخص ثالث از خرید ناراضی باشد. در این موارد، توسعهدهنده بازپرداخت را به شخص ثالث صادر میکند. کسب درآمد به شما این امکان را می دهد که بازپرداخت مشابهی داشته باشید. این امر به ویژه در مورد طرحهای سهم درآمد بسیار مهم است.
تصور کنید توسعهدهندهای که بازپرداخت را برای مشترک تلفن همراه صادر کرده است، یک طرح سهم درآمد برای محصول API شما خریداری کرده است. فرض کنید این طرح از توسعهدهنده درخواست میکند 70 درصد از قیمت خالص/ناخالص معامله خرید را دریافت کند. با ارسال بازپرداخت، شما در واقع تراکنش خرید را معکوس میکنید، یعنی 70% از پرداختی که به توسعهدهنده پرداخت میشود برای ماهی که بازپرداخت اعمال شده است کسر میکنید (ماهی که ممکن است با ماهی واقعی متفاوت باشد. معامله خرید رخ داده است).
ارسال بازپرداخت با استفاده از رابط کاربری Classic Edge (Edge فقط برای Private Cloud)
شما می توانید برای هر تراکنش خرید "موفق"، بازپرداخت ارسال کنید، یعنی جایی که API با موفقیت از شخص ثالث هزینه دریافت کرده است و قبلاً بازپرداخت کاملی برای آن صادر نکرده اید. ارسال بازپرداخت منجر به ایجاد یک تراکنش بازپرداخت با شناسه تراکنش والد می شود، جایی که شناسه تراکنش شناسه تراکنش خرید است.
می توانید برای کل مبلغ تراکنش خرید اصلی یا مبلغ جزئی بازپرداخت ارسال کنید. همچنین می توانید چندین بازپرداخت جزئی ارسال کنید، اما کل مبلغ بازپرداخت نمی تواند بیشتر از مبلغ خرید اصلی باشد.
برای ارسال بازپرداخت:
- در برگه کسب درآمد، بازپرداخت را انتخاب کنید.
با این کار صفحه بازپرداخت باز می شود.
- در منوی کشویی ماه صورتحساب، ماهی را انتخاب کنید که معامله خرید در آن انجام شده است. سپس روی + Refunds کلیک کنید.
این لیستی از تمام معاملات خرید موفق برای ماه انتخاب شده را نشان می دهد.
می توانید لیست بازپرداخت را با نام توسعه دهنده یا با جستجو در تراکنش واقعی فیلتر کنید.
برای فیلتر بر اساس برنامهنویس، برنامهنویس را از منوی کشویی Developer انتخاب کنید. این لیست فقط تراکنش های مربوط به توسعه دهنده انتخاب شده را نشان می دهد.
برای فیلتر کردن بر اساس شناسه تراکنش، شناسه تراکنش خرید اصلی را که میخواهید بازپرداخت کنید، وارد کنید. این تراکنش را برای آن شناسه برمی گرداند.
- کادر انتخاب را در ردیف(های) تراکنش(هایی) که می خواهید بازپرداخت کنید علامت بزنید.
- در منوی کشویی نوع، کل یا جزئی را انتخاب کنید.
اگر Total را انتخاب کنید، کل مبلغ خرید مسترد خواهد شد. در صورت انتخاب جزئی، مقدار جزئی از خرید مسترد خواهد شد.
در صورت انتخاب جزئی، مقدار بازپرداخت جزئی را در قسمت مقدار وارد کنید. شما فقط می توانید تا سقف کل مبلغ خرید را بازپرداخت کنید. اگر قبلاً بازپرداخت جزئی ارسال کرده اید، فقط می توانید مبلغی را تا سقف مبلغ باقی مانده در خرید وارد کنید. همچنین، اگر تراکنش خرید اصلی دارای هر دو قیمت ناخالص و خالص باشد، همچنین باید بیان کنید که مقدار جزئی که میخواهید بازپرداخت کنید، ناخالص است یا خالص.
- برای پردازش بازپرداخت روی ذخیره کلیک کنید (یا برای لغو لغو کنید).
اگر ماه صورتحساب هنوز باز باشد، بازپرداخت به ماه خرید اصلی ارسال می شود، در غیر این صورت بازپرداخت تا تاریخ فعلی ارسال می شود.
برای بازپرداخت جزئی، بازپرداخت برای مقدار جزئی پردازش میشود و هر سهم درآمدی بر اساس نسبت مبلغ جزئی بر مبلغ کامل کسر میشود. در مثال بازپرداخت جزئی در بالا، مقدار جزئی 0.50/1.12 = 45٪ از قیمت ناخالص است، بنابراین 45٪ از سهم درآمد توسعه دهنده کسر می شود.
بررسی در UI اگر بازپرداخت پردازش شده است
با انتخاب ماه صورتحساب در بالای صفحه بازپرداخت، میتوانید تعیین کنید که آیا بازپرداخت پردازش شده است یا خیر. اگر ماه صورتحساب هنوز باز است، این ماه خرید است، یا اگر ماه صورتحساب بسته است، ماه جاری است. این لیستی از تمام بازپرداخت هایی که در ماه ارسال شده است را نشان می دهد.
ارسال بازپرداخت با استفاده از API
برای ارسال بازپرداخت، یک درخواست POST به /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions
ارسال کنید، که در آن {package_id}
شناسه بسته API است که بازپرداخت برای آن اعمال میشود.
هنگامی که درخواست را صادر می کنید، باید به عنوان پارامترهای پرس و جو مشخص کنید:
- شناسه تراکنش خریدی که در حال بازپرداخت است.
- نوع درآمد (
GROSS
یاNET
) تراکنش خرید. - مبلغ بازپرداخت
- یادداشتی که دلیل بازپرداخت را توضیح می دهد.
به صورت اختیاری، میتوانید بسته API را که بازپرداخت برای آن اعمال میشود، به عنوان پارامتر URL شناسایی کنید.
تنظیمات پیکربندی بازپرداخت را برای لیست کاملی از پارامترهای 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 که بازپرداخت برای آن اعمال می شود. | N/A | خیر |
parentTxId | معامله خرید مسترد می شود. | N/A | بله |
revenueType | نوع درآمد ( | N/A | بله |
refundAmount | مبلغ بازپرداخت. | N/A | بله |
transactionNote | یادداشت متنی که دلیل بازپرداخت را توضیح می دهد. | N/A | بله |
مراحل بعدی
با نحوه زمانبندی مشاغل مرتبط با کسب درآمد و کارهایی که بهطور خودکار در زمانبندی مشاغل کسب درآمد برنامهریزی میشوند، آشنا شوید.