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

با این کار، صفحه «استرداد مبلغ» باز میشود.

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

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

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

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

- برای پردازش استرداد مبلغ، روی «ذخیره» کلیک کنید (یا برای لغو کردن، روی «لغو» کلیک کنید).
اگر ماه صورتحساب هنوز باز باشد، استرداد مبلغ به ماه خرید اصلی ارسال میشود، درغیراینصورت استرداد مبلغ به تاریخ فعلی ارسال میشود.
برای استرداد ناتمام، استرداد برای مبلغ ناتمام پردازش میشود و هرگونه سهم درآمد براساس نسبت مبلغ ناتمام به مبلغ کامل کسر میشود. در مثال استرداد ناتمام در بالا، مبلغ ناتمام ۰٫۵۰/۱٫۱۲ = ۴۵٪ از قیمت ناخالص است، بنابراین ۴۵٪ از سهم درآمد توسعهدهنده کسر خواهد شد.
بررسی در رابط کاربری که آیا استرداد وجه پردازش شده است یا نه
با انتخاب ماه صورتحساب در بالای صفحه «استرداد مبلغ»، میتوانید متوجه شوید که استرداد مبلغ پردازش شده است یا نه. این ماه خرید است اگر ماه صورتحساب هنوز باز باشد، یا ماه جاری اگر ماه صورتحساب بسته باشد. این فهرست همه استردادهای مبلغی را که در ماه پست شدهاند نمایش میدهد.
ارسال استرداد مبلغ بااستفاده از API
برای پست کردن استرداد مبلغ، درخواست POST را به
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions ارسال کنید،
که در آن {package_id} شناسه بسته API است که استرداد مبلغ
به آن اعمال میشود.
وقتی درخواست را صادر میکنید، باید بهعنوان پارامترهای پُرسمان مشخص کنید:
- شناسایی تراکنش خرید که درحال استرداد وجه است.
- نوع درآمد (
GROSSیاNET) تراکنش خرید. - مبلغ استرداد وجه.
- یادداشتی که دلیل استرداد مبلغ را توضیح میدهد.
درصورت تمایل، میتوانید بسته API را که استرداد مبلغ به آن اعمال میشود بهعنوان پارامتر نشانی وب مشخص کنید.
برای فهرست کامل پارامترهای نشانی وب که میتوانید در درخواست استرداد مبلغ مشخص کنید، تنظیمات پیکربندی استرداد مبلغ را ببینید.
برای مثال، درخواست زیر مبلغ تراکنش خرید را مسترد میکند. مبلغ استرداد وجه ۵۰٪ از مبلغ ناخالص تراکنش خرید است.
$ 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" }
تنظیمات پیکربندی استرداد مبلغ برای میانای برنامهسازی کاربردی
پارامترهای پُرسمان زیر را میتوان در درخواست استرداد مبلغ مشخص کرد:
| نام | شرح | پیشفرض | الزامی است؟ |
|---|---|---|---|
monetizationPackageId |
بسته API که استرداد مبلغ برای آن اعمال میشود. |
موجود نیست | نه |
parentTxId |
تراکنش خرید که باید مبلغ آن مسترد شود. |
موجود نیست | بله |
revenueType |
نوع درآمد ( |
موجود نیست | بله |
refundAmount |
مبلغ استرداد. |
موجود نیست | بله |
transactionNote |
یادداشت نوشتاری که دلیل استرداد مبلغ را توضیح میدهد. |
موجود نیست | بله |
مراحل بعدی
با نحوه زمانبندی کردن کارهای مربوط به درآمدزایی و کارهایی که بهطور خودکار در زمانبندی کارهای درآمدزایی زمانبندی میشوند آشنا شوید.