Erstattungen von Beiträgen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Rufen Sie die Dokumentation zu Apigee X auf. info

Einführung

Mit der Monetarisierung können Sie Entwicklern Erstattungen für „Kauftransaktionen“ senden. Angenommen, Sie sind ein Mobilfunkanbieter und bieten Entwicklern eine Zahlungs-API an, mit der sie Mobilfunkkunden den Kauf einer Anwendung oder von Inhalten in der Anwendung in Rechnung stellen können. Jedes Mal, wenn ein Kunde die API verwendet, um einen Kauf zu tätigen, handelt es sich um eine Kauftransaktion.

Kauftransaktionen können zu Erstattungen führen. Beispielsweise werden die Inhalte möglicherweise nicht geliefert, oder der Dritte ist aus anderen Gründen mit dem Kauf unzufrieden. In diesen Fällen erstattet der Entwickler dem Dritten den Kaufbetrag. Mit der Monetarisierung können Sie eine entsprechende Erstattung vornehmen. Das ist besonders bei Umsatzbeteiligungsplänen relevant.

Angenommen, der Entwickler, der dem Mobilfunkkunden die Erstattung gesendet hat, hat einen Umsatz beteiligungsplan für Ihr API-Produkt erworben. Gemäß dem Plan erhält der Entwickler 70% des Netto-/Bruttopreises der Kauftransaktion. Wenn Sie eine Erstattung senden, machen Sie die Kauftransaktion im Grunde rückgängig. Das heißt, Sie ziehen 70% von der Zahlung ab, die der Entwickler für den Monat erhält, in dem die Erstattung angewendet wurde. Dieser Monat kann sich von dem Monat unterscheiden, in dem die eigentliche Kauftransaktion stattgefunden hat.

Erstattung über die Classic Edge-Benutzeroberfläche senden (nur Edge for Private Cloud)

Sie können eine Erstattung für jede "erfolgreiche" Kauftransaktion senden, bei der die API dem Dritten erfolgreich einen Betrag in Rechnung gestellt hat und für die Sie noch keine vollständige Erstattung gesendet haben. Wenn Sie eine Erstattung senden, wird eine Erstattungstransaktion mit einer übergeordneten Transaktions-ID erstellt. Die Transaktions-ID ist die ID der Kauftransaktion.

Sie können eine Erstattung für den vollen Betrag der ursprünglichen Kauftransaktion oder für einen Teilbetrag senden. Sie können auch mehrere teilweise Erstattungen senden. Der Gesamtbetrag der Erstattungen darf jedoch nicht höher als der ursprüngliche Kaufbetrag sein.

So senden Sie eine Erstattung:

1. Wählen Sie auf dem Tab „Monetarisierung“ die Option „Erstattungen“ aus.

   

   Die Seite „Erstattungen“ wird geöffnet.

   

2. Wählen Sie im Drop-down-Menü „Abrechnungsmonat“ den Monat aus, in dem die Kauftransaktion stattgefunden hat. Klicken Sie dann auf „+ Erstattungen“.

   Daraufhin wird eine Liste aller erfolgreichen Kauftransaktionen für den ausgewählten Monat angezeigt.

   

   Sie können die Erstattungsliste nach Entwicklernamen filtern oder nach der eigentlichen Transaktion suchen.

   Wenn Sie nach Entwickler filtern möchten, wählen Sie den Entwickler im Drop-down-Menü „Entwickler“ aus. Daraufhin wird eine Liste mit den Transaktionen für den ausgewählten Entwickler angezeigt.

   

   Wenn Sie nach Transaktions-ID filtern möchten, geben Sie die Transaktions-ID des ursprünglichen Kaufs ein, den Sie erstatten möchten. Daraufhin wird die Transaktion für diese ID zurückgegeben.

   

3. Klicken Sie in den Zeilen für die Transaktionen, die Sie erstatten möchten, das Kästchen „Auswählen“ an.
4. Wählen Sie im Drop-down-Menü „Typ“ entweder „Gesamt“ oder „Teilweise“ aus.

   Wenn Sie „Gesamt“ auswählen, wird der Gesamtbetrag des Kaufs erstattet. Wenn Sie „Teilweise“ auswählen, wird ein Teilbetrag des Kaufs erstattet.

   Wenn Sie „Teilweise“ auswählen, geben Sie den Betrag der teilweisen Erstattung in das Feld „Betrag“ ein. Sie können nur bis zum Gesamtbetrag des Kaufs erstatten. Wenn Sie bereits eine teilweise Erstattung gesendet haben, können Sie nur einen Betrag eingeben, der dem Restbetrag des Kaufs entspricht. Wenn die ursprüngliche Kauftransaktion sowohl Brutto- als auch Nettopreise hat, müssen Sie auch angeben ob der Teilbetrag, den Sie erstatten möchten, brutto oder netto ist.

   

5. Klicken Sie auf „Speichern“, um die Erstattung zu verarbeiten, oder auf „Abbrechen“, um den Vorgang abzubrechen.

   Die Erstattung wird dem Monat des ursprünglichen Kaufs zugeordnet, wenn der Abrechnungsmonat noch offen ist. Andernfalls wird die Erstattung dem aktuellen Datum zugeordnet.

   Bei einer teilweisen Erstattung wird die Erstattung für den Teilbetrag verarbeitet und die Umsatzbeteiligung wird basierend auf dem Verhältnis des Teilbetrags zum Gesamtbetrag abgezogen. Im obigen Beispiel für eine teilweise Erstattung beträgt der Teilbetrag 0, 50/1, 12 = 45% des Bruttopreises. Daher werden 45% der Umsatzbeteiligung des Entwicklers abgezogen.

In der Benutzeroberfläche prüfen, ob eine Erstattung verarbeitet wurde

Sie können feststellen, ob eine Erstattung verarbeitet wurde, indem Sie oben auf der Seite „Erstattungen“ den Abrechnungsmonat auswählen. Das ist der Monat des Kaufs, wenn der Abrechnungsmonat noch offen ist, oder der aktuelle Monat, wenn der Abrechnungsmonat geschlossen ist. Daraufhin wird eine Liste aller Erstattungen angezeigt, die in diesem Monat gesendet wurden.

Erstattung über die API senden

Senden Sie zum Senden einer Erstattung eine POST-Anfrage an /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, wobei {package_id} die ID des API-Pakets ist, auf das sich die Erstattung bezieht.

Wenn Sie die Anfrage senden, müssen Sie folgende Abfrageparameter angeben:

• Die ID der Kauftransaktion, die erstattet wird.
• Den Umsatztyp (GROSS oder NET) der Kauftransaktion.
• Den Erstattungsbetrag.
• Eine Notiz mit dem Grund für die Erstattung.

Optional können Sie als URL-Parameter ein API-Paket angeben, auf das sich die Erstattung bezieht.

Eine vollständige Liste der URL -Parameter, die Sie in einer Erstattungsanfrage angeben können, finden Sie unter Konfigurationseinstellungen für Erstattungen.

Mit der folgenden Anfrage wird beispielsweise eine Erstattung für eine Kauftransaktion gesendet. Der Erstattungsbetrag beträgt 50% des Bruttobetrags der Kauftransaktion.

$ 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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "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"
}

Konfigurationseinstellungen für Erstattungen für die API

In einer Erstattungsanfrage können die folgenden Abfrageparameter angegeben werden:

Nächste Schritte

Informationen zum Planen von Monetarisierungsjobs und zu den Jobs, die automatisch geplant werden finden Sie unter Monetarisierungsjobs planen.