退款原因

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

簡介

您可以利用營利設定，將「購買交易」的退款核發給開發人員。假設您是行動電信業者，並且提供付款 API，讓開發人員用來向行動訂閱者收取購買應用程式或內容的費用。只要訂閱者使用 API 進行交易，就屬於購買交易。

購買交易可能會導致退款。例如內容可能無法傳送，或是第三方對購買交易不滿意。在這種情況下，開發人員會退款給第三方。營利功能可讓你以類似方式退款。這與收益分潤方案尤其重要。

假設核發退款給行動訂閱者的開發人員，有為您的 API 產品購買收益分潤方案。假設方案要求開發人員收到交易交易淨/總價的 70%。發布退款後，您隨即撤銷購買交易，也就是說，在退款生效當日，您會從開發人員應付的款項中扣除 70% 的款項 (當月可能與實際購買交易發生的月份不同)。

使用傳統版 Edge UI 發布退款 (僅限 Private Cloud 的 Edge)

針對任何「成功」的購買交易，您可以核發退款，也就是 API 成功向第三方扣款，而您尚未核發全額退款。發布退款後，系統就會使用上層交易 ID 建立退款交易，其中交易 ID 是購買交易的 ID。

您可以張貼原始交易的全額退款或部分金額。您也可以申請多項部分退款，但退款總金額不得超過原始購買金額。

如何張貼退款：

  1. 在「營利」分頁中選取「退款」。

    系統隨即會開啟「退款」頁面。

  2. 在「Billing Month」(帳單月份) 下拉式選單中，選取您進行購買交易的月份。然後按一下「+ 退款」。

    這裡會顯示所選月份的所有成功購買交易清單。

    您可以按照開發人員名稱或搜尋實際交易，篩選退款清單。

    如要依開發人員篩選，請從「開發人員」下拉式選單中選取開發人員。系統只會列出與所選開發人員相關的交易。

    如要依交易 ID 篩選，請輸入你要退款的原始交易交易 ID。這樣就會傳回該 ID 的交易。

  3. 找出要退款的交易，勾選那一列的「選取」方塊。
  4. 在「類型」下拉式選單中選取「總計」或「部分」。

    如果選取「總計」，系統會退還購買總金額。如果選取「部分完成」，我們會退還部分交易金額。

    如果您選取「部分退款」，請在「金額」欄位中輸入部分退款金額。退款金額上限為購買交易總額。如果您已核發部分退款，只能輸入購買商品的剩餘金額。此外，如果原始購買交易同時具有總價和淨價，您也必須說明要退款的部分金額是總收益或淨額。

  5. 按一下 [儲存] 即可處理退款，或按一下 [取消] 取消。

    如果帳單月份仍為開啟狀態，款項會發布到原交易的月份，否則退款金額會於目前日期核發。

    我們會針對部分退款處理部分退款，並依據全額款項中部分金額的比例，扣除收益分潤。在上方部分退款範例中，部分金額為總價的 0.50/1.12 = 45%，因此將扣除開發人員的 45% 收益分潤。

在使用者介面中查看退款是否已處理

您可以在「退款」頁面頂端選取帳單月份，確認我們是否已處理退款。如果帳單月份仍為開啟狀態，則為購買月份。如果帳單月份已關閉，則會是當月。畫面上會列出當月發布的所有退款。

使用 API 發布退款

如要發布退款，請向 /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions 發出 POST 要求，其中 {package_id} 代表要退款的 API 套件。

發出要求時，您必須將查詢參數指定為查詢參數：

  • 要進行退款的購買交易識別資訊。
  • 購買交易的收益類型 (GROSS 或 NET)。
  • 退款金額。
  • 說明退款原因的附註。

您也可以選擇視為 API 套件的網址參數，用於申請退款。

如需可在退款要求中指定的網址參數完整清單，請參閱退款設定。

舉例來說，以下要求會核發購買交易退款。退款金額是購買交易交易總額的 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

說明退款原因的文字附註。

 不適用 是

後續步驟

如要瞭解如何排定營利相關工作和自動排定的工作，請參閱「排定營利工作」一文。