شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
مقدمه
کسب درآمد به شما این امکان را میدهد که برای «تراکنشهای خرید» به توسعهدهندگان بازپرداخت ارسال کنید. فرض کنید شما یک اپراتور تلفن همراه هستید و به توسعهدهندگان یک API پرداخت ارائه میدهید تا از مشترکین تلفن همراه برای خرید یک برنامه یا محتوای درون برنامه هزینه دریافت کنند. هر بار که مشترکی از API برای خرید استفاده میکند، این یک تراکنش خرید است.
تراکنشهای خرید میتوانند منجر به بازپرداخت وجه شوند. برای مثال، ممکن است محتوا تحویل داده نشود، یا شخص ثالث به هر دلیلی از خرید ناراضی باشد. در این موارد، توسعهدهنده وجه را به شخص ثالث بازپرداخت میکند. کسب درآمد به شما این امکان را میدهد که بازپرداخت مشابهی انجام دهید. این امر به ویژه در مورد طرحهای سهم درآمد صادق است.
تصور کنید توسعهدهندهای که وجه را به مشترک تلفن همراه بازپرداخت کرده، یک طرح سهم درآمد برای محصول API شما خریداری کرده است. فرض کنید این طرح مستلزم دریافت ۷۰٪ از قیمت خالص/ناخالص تراکنش خرید توسط توسعهدهنده است. با ارسال بازپرداخت، شما در واقع تراکنش خرید را معکوس میکنید، یعنی ۷۰٪ از مبلغ قابل پرداخت به توسعهدهنده را برای ماهی که بازپرداخت اعمال شده است، کسر میکنید (ممکن است ماه مورد نظر با ماهی که تراکنش خرید واقعی در آن رخ داده است متفاوت باشد).
ارسال بازپرداخت با استفاده از رابط کاربری کلاسیک اج (اج فقط برای فضای ابری خصوصی)
شما میتوانید برای هر تراکنش خرید «موفق» که در آن API با موفقیت از شخص ثالث هزینه دریافت کرده و شما هنوز بازپرداخت کامل برای آن انجام ندادهاید، درخواست بازپرداخت ارسال کنید. ارسال درخواست بازپرداخت منجر به ایجاد یک تراکنش بازپرداخت با شناسه تراکنش والد میشود که در آن شناسه تراکنش، شناسه تراکنش خرید است.
شما میتوانید مبلغ کل تراکنش خرید اولیه یا بخشی از مبلغ را بازپرداخت کنید. همچنین میتوانید چندین بازپرداخت جزئی را ارسال کنید، اما کل مبلغ بازپرداخت نمیتواند بیشتر از مبلغ خرید اولیه باشد.
برای ارسال بازپرداخت:
- در برگه کسب درآمد، گزینه بازپرداختها را انتخاب کنید.

این صفحه بازپرداختها را باز میکند.

- در منوی کشویی «ماه پرداخت»، ماهی را که تراکنش خرید در آن انجام شده است انتخاب کنید. سپس روی + بازپرداختها کلیک کنید.
این لیست تمام تراکنشهای خرید موفق برای ماه انتخاب شده را نمایش میدهد.

میتوانید لیست بازپرداخت را بر اساس نام توسعهدهنده یا با جستجو در تراکنش واقعی فیلتر کنید.
برای فیلتر کردن بر اساس توسعهدهنده، از منوی کشویی توسعهدهنده، توسعهدهنده را انتخاب کنید. این کار لیستی از تراکنشهای مربوط به توسعهدهنده انتخابشده را نمایش میدهد.

برای فیلتر کردن بر اساس شناسه تراکنش، شناسه تراکنش خرید اصلی که میخواهید وجه آن را بازپرداخت کنید را وارد کنید. این کار تراکنش مربوط به آن شناسه را برمیگرداند.

- در ردیف(های) مربوط به تراکنش(هایی) که میخواهید بازپرداخت کنید، کادر انتخاب را علامت بزنید.
- در منوی کشویی Type، یکی از گزینههای Total یا Partial را انتخاب کنید.
اگر گزینه «مجموع» را انتخاب کنید، کل مبلغ خرید و اگر گزینه «جزئی» را انتخاب کنید، بخشی از مبلغ خرید به شما بازگردانده میشود.
اگر گزینه «جزئی» را انتخاب کنید، مبلغ بازپرداخت جزئی را در فیلد «مبلغ» وارد کنید. شما فقط میتوانید تا سقف کل مبلغ خرید، مبلغ بازپرداخت را وارد کنید. اگر قبلاً بازپرداخت جزئی را ثبت کردهاید، فقط میتوانید مبلغی تا سقف مبلغ باقیمانده از خرید را وارد کنید. همچنین، اگر تراکنش خرید اصلی شامل قیمت ناخالص و خالص باشد، باید مشخص کنید که مبلغ جزئی که میخواهید بازپرداخت کنید، ناخالص است یا خالص.

- برای پردازش بازپرداخت، روی ذخیره (یا برای لغو، روی لغو) کلیک کنید.
اگر ماه صدور صورتحساب هنوز باز باشد، مبلغ بازپرداخت به ماه خرید اولیه و در غیر این صورت به تاریخ جاری واریز میشود.
برای بازپرداخت جزئی، بازپرداخت برای مبلغ جزئی پردازش میشود و هرگونه سهم درآمدی بر اساس نسبت مبلغ جزئی بر مبلغ کامل کسر میشود. در مثال بازپرداخت جزئی بالا، مبلغ جزئی 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 که میتوانید در درخواست بازپرداخت مشخص کنید، به تنظیمات پیکربندی بازپرداخت مراجعه کنید.
برای مثال، درخواست زیر، بازپرداخت وجه یک تراکنش خرید را صادر میکند. مبلغ بازپرداخت ۵۰٪ از مبلغ ناخالص تراکنش خرید است.
$ 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 | یک یادداشت متنی که دلیل بازپرداخت را شرح میدهد. | ناموجود | بله |
مراحل بعدی
بیاموزید که چگونه کارهای مرتبط با کسب درآمد را زمانبندی کنید و درباره کارهایی که به طور خودکار زمانبندی میشوند، در «زمانبندی کارهای کسب درآمد» بیاموزید.