Saldo von Prepaid-Konten verwalten

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an.
info

So verwalten Sie das Guthaben in einem Prepaidkonto:

Wie berechne ich das verbleibende Guthaben auf meinem Prepaid-Konto?

Wenn Sie das Guthaben des Prepaid-Kontos für einen Entwickler oder ein Unternehmen aufrufen, wie in den folgenden Abschnitten beschrieben, müssen Sie die folgenden Werte aus der Antwort abrufen:

  • amount: Der für den aktuellen Abrechnungszeitraum verfügbare Gesamtbetrag. Dieser Wert wird aktualisiert, wenn Sie das Prepaid-Konto mit den in diesem Abschnitt beschriebenen Methoden aufladen.
  • usage: Der Gesamtbetrag, der im aktuellen Abrechnungszeitraum verbraucht wurde. Dieser Wert wird bei jeder qualifizierten monetarisierten Transaktion oder durch Ausstellen einer Gutschrift (positiv oder negativ) aktualisiert.

Sie können das verbleibende Guthaben des Prepaid-Kontos für den aktuellen Abrechnungszeitraum berechnen, indem Sie den Wert usage von amount abziehen. Wenn der Wert von amount beispielsweise 335, 50 und der Wert von usage 34 ist, wird der verbleibende Betrag so berechnet:

amount(335.50) - usage(34) = 229.50

Prepaid-Guthaben mit der API abrufen

In den folgenden Abschnitten wird beschrieben, wie Sie mithilfe der API den Kontostand eines Prepaid-Kontos für einen Entwickler oder ein Unternehmen aufrufen.

Prepaid-Guthaben für einen Entwickler ansehen

Wenn Sie das Guthaben eines Prepaid-Kontos für einen Entwickler aufrufen möchten, senden Sie eine GET-Anfrage an eine der folgenden APIs. Dabei steht {developer_id} für die E-Mail-Adresse des Entwicklers:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: Gibt das Guthaben des Prepaid-Kontos und Informationen zur wiederkehrenden Einrichtung für einen Entwickler zurück.
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: Gibt Informationen zum Prepaid-Kontosaldo zurück, einschließlich aktuellem und Gesamtsaldo, Nutzung, Aufstockungen und Nutzungssteuer.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Suchparameter Beschreibung
all Flag, das angibt, ob alle API-Pakete zurückgegeben werden sollen. Wenn dieser Parameter auf false gesetzt ist, wird die Anzahl der pro Seite zurückgegebenen API-Pakete durch den Abfrageparameter size definiert. Die Standardeinstellung ist false.
size Anzahl der API-Pakete, die pro Seite zurückgegeben werden. Der Standardwert ist 20. Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.
page Die Nummer der Seite, die zurückgegeben werden soll (falls die Inhalte paginated sind). Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.
currencyId ID der Währung, für die Sie Prepaid-Guthaben anzeigen möchten.

Beispiel:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
    "developerBalance": [
        {
            "amount": 2005,
            "chargePerUsage": false,
            "id": "your-provider-id",
            "isRecurring": false,
            "supportedCurrency": {
                "description": "United States Dollars",
                "displayName": "United States Dollars",
                "id": "usd",
                "name": "USD",
                "organization": {
                    "address": [
                        {
                            "address1": "10 Almaden Blvd.",
                            "city": "San Jose",
                            "country": "US",
                            "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61",
                            "isPrimary": true,
                            "state": "CA",
                            "zip": "95113"
                        }
                    ],
                    "approveTrusted": false,
                    "approveUntrusted": false,
                    "billingCycle": "CALENDAR_MONTH",
                    "country": "US",
                    "currency": "USD",
                    "description": "my-org",
                    "groupOrganization": false,
                    "hasBillingAdjustment": false,
                    "hasBroker": false,
                    "hasSelfBilling": false,
                    "hasSeparateInvoiceForProduct": false,
                    "id": "my-org",
                    "issueNettingStmt": false,
                    "name": "my-org",
                    "nettingStmtPerCurrency": false,
                    "selfBillingAsExchOrg": false,
                    "selfBillingForAllDev": false,
                    "separateInvoiceForFees": false,
                    "status": "ACTIVE",
                    "supportedBillingType": "BOTH",
                    "taxModel": "HYBRID",
                    "timezone": "UTC"
                },
                "status": "ACTIVE",
                "virtualCurrency": false
            },
            "usage": 2.1572
        }
    ],
    "totalRecords": 1
}

Prepaid-Guthaben für ein Unternehmen ansehen

Wenn Sie sich das Guthaben eines Prepaid-Kontos für ein Unternehmen ansehen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/companies/{company_id}/developer-balances, wobei {company_id} die ID des Unternehmens ist. Wenn das Unternehmen ein Prepaid-Konto hat, wird mit der Anfrage das aktuelle Prepaid-Guthaben abgerufen. Wenn das Unternehmen ein Postpaid-Unternehmen ist, wird über die Anfrage das aktuelle Kreditlimit abgerufen.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Suchparameter Beschreibung
all Flag, das angibt, ob alle API-Pakete zurückgegeben werden sollen. Wenn dieser Parameter auf false gesetzt ist, wird die Anzahl der pro Seite zurückgegebenen API-Pakete durch den Abfrageparameter size definiert. Die Standardeinstellung ist false.
size Anzahl der API-Pakete, die pro Seite zurückgegeben werden. Der Standardwert ist 20. Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.
page Die Nummer der Seite, die zurückgegeben werden soll (falls die Inhalte paginated sind). Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.
currencyId ID der Währung, für die Sie Prepaid-Guthaben anzeigen möchten.

Beispiel:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

Die Antwort ähnelt der oben gezeigten Antwort, wenn Sie sich das Prepaid-Guthaben eines Entwicklers ansehen.

Prepaid-Guthaben mit einem Zahlungsanbieter verwalten

Sie können Prepaid-Guthaben verwalten, indem Sie ein Händlerkonto bei einem Zahlungsanbieter wie Worldpay einrichten. Die folgende Abbildung zeigt, wie das Prepaidguthaben über den WorldPay-Zahlungsanbieter verwaltet wird.

Ablauf mit Worldpay als Zahlungsdienstleister

In der folgenden Tabelle werden die einzelnen Schritte der oben gezeigten Verwaltung des Prepaidguthabens beschrieben.

Schritt Beschreibung
0 Voraussetzungen
Wenn Sie als API-Anbieter einen Zahlungsanbieter von Drittanbietern wie Worldpay einrichten möchten, müssen Sie Folgendes tun:
1 Zum Auslösen des Vorgangs führt ein API-Nutzer im Entwicklerportal eine der folgenden Aufgaben aus:
  • Geld auf ein Konto einzahlen
  • Akzeptiert einen Tarif mit nicht ausreichendem Guthaben
2 Das Entwicklerportal initiiert die Zahlung über Edge für den Entwickler mit der Anbieter-ID, dem Aufladebetrag und der Währung. Informationen zur Verwendung der API zum Starten einer Zahlung finden Sie unter Zahlung an ein Prepaid-Konto über einen Zahlungsanbieter initiieren.
3 Edge sucht den Anbieter anhand der ID und bestimmt, dass es sich um ein WorldPay-Konto handelt.
4 Edge generiert einen Bestellcode.
5 Edge erstellt die Zahlungsanweisung bei Worldpay.
6 Worldpay gibt eine Referenz-ID für die Bestellung und eine zeitlich begrenzte URL für die Auftragsausführung zurück.
7 Die Antwort von Worldpay wird in eine generische Edge-/Zahlungs-API-Antwort umgewandelt, die an das Entwicklerportal zurückgegeben wird, um den in Schritt 2 initiierten Aufruf abzuschließen. Beispiel:
{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}
8 Das Entwicklerportal hängt Callback-URLs (für Erfolg, Fehler usw.) als Abfrageparameter an die URL an.
9 Das Entwicklerportal antwortet auf die Anfrage in Schritt 1, indem der Browser des API-Nutzers zur geänderten URL weitergeleitet wird.
10 Der API-Nutzer füllt das Antragsformular aus und leitet die Verarbeitung über Worldpay ein.
11 Worldpay erfasst die Abrechnungsinformationen und verarbeitet die Zahlung. Im Erfolgsfall generiert Worldpay einen Message Authentication Code (MAC) mithilfe des MAC-Secrets, das sowohl in Worldpay als auch im Entwicklerportal konfiguriert ist.
12 Worldpay leitet den Browser des API-Nutzers an die erfolgreiche Callback-URL (aus Schritt 8) weiter und fügt den MAC als Abfrageparameter und den Betrag an.
13 Der Browser ruft die URL im Entwicklerportal mit der angeforderten Menge und MAC-Adresse auf.
14 Das Portal prüft den MAC anhand des MAC-Secrets. Der MAC verhindert, dass eine Person willkürlich behauptet, dass erfolgreiche Zahlungen erfolgt sind.
15 Das Entwicklerportal sendet eine Anfrage zum Aufladen des Prepaidguthabens an Edge. Informationen zur Verwendung der API zum Aufladen des Kontoguthabens finden Sie unter Guthaben eines Prepaid-Kontos mit der API aufladen.

In den folgenden Abschnitten werden die Schritte beschrieben, die erforderlich sind, um Prepaidguthaben über einen externen Zahlungsdienstleister zu verwalten:

Händlerkonto beim WorldPay-Zahlungsanbieter einrichten

Bevor Sie beginnen, müssen Sie sich an einen Drittanbieter-Zahlungsanbieter (Worldpay) wenden, um Ihre Händlerkonten einzurichten. Wir empfehlen, zwei Konten einzurichten, eines für die Tests und eines für die Produktion. Weitere Informationen zu Worldpay-Händlerkonten finden Sie unter www.worldpay.com und wp-support.crm.worldpay.com (WorldPay-Supportcenter).

Nachdem du dein Händlerkonto eingerichtet und deine Anmeldedaten erhalten hast, kannst du dein Händlerkonto für Worldpay konfigurieren:

  1. Rufen Sie https://secure.worldpay.com/sso/public/auth/login.html auf.
  2. Melden Sie sich mit den von Worldpay bereitgestellten Anmeldedaten in Ihrem Worldpay-Konto an.
  3. Legen Sie den geheimen Schlüssel für das XML-Passwort und den Nachrichtenauthentifizierungscode (MAC) fest:
    1. Klicken Sie auf Profil.
    2. Legen Sie im Feld XML-Passwort das Passwort fest, das bei der Konfiguration des WorldPay-Zahlungsanbieters in Edge verwendet werden soll.
    3. Geben Sie im Feld MAC-Secret für Weiterleitung einen MAC-Secret-Schlüssel mit 20 bis 30 Zeichen ein.
    4. Klicken Sie auf Profil speichern.
  4. Fügen Sie den Apigee Edge-Verwaltungsserver der Liste der Händler-IP-Adressen (Zulassungsliste) hinzu:
    1. Klicken Sie auf Profil > Händlerumgebung.
    2. Klicken Sie auf Neue Test-IP.
    3. Geben Sie die IP-Adresse für den Apigee Edge-Verwaltungsserver ein.
    4. Klicken Sie auf Speichern.
  5. Konfigurieren Sie die Händler-URL so, dass die Worldpay-Parameter angehängt werden, einschließlich des Authentifizierungscodes der Methode (MAC):
    1. Klicken Sie auf Installationen > Gehostete Zahlungsseiten > Zahlungsseiten-Designer.
    2. Wählen Sie unter Zahlungsseiten bearbeiten in der Drop-down-Liste Kanal auswählen Ihre Installations-ID aus.
    3. Wählen Sie auf dem Tab „Properties“ (Properties) die Option Edit merchant configuration (Händlerkonfiguration bearbeiten) aus.
    4. Legen Sie für den Parameter „Send URL parameters“ den Wert True fest.
    5. Klicken Sie auf den Tab Veröffentlichen.
    6. So veröffentlichen Sie Änderungen:
      • Klicken Sie bei Testumgebungen unter Design auf Befördern, um die Version von „Design“ zu „Sandbox“ zu befördern.
      • Klicken Sie bei Produktionsumgebungen unter Sandbox auf Promote (Befördern), um die Sandbox-Version in die Produktionsversion zu übernehmen.

Zahlungsanbieter in Edge konfigurieren

Im nächsten Schritt konfigurieren Sie den Zahlungsanbieter in Edge.

Sie können Ihren Zahlungsanbieter für eine bestimmte Organisation mit der folgenden API konfigurieren:

/organizations/{org-name}/providers

Nur Apigee Edge Private Cloud-Kunden mit Administratorrechten können optional einen globalen Zahlungsanbieter mit der folgenden API konfigurieren:

/config/providers

Beim Aufrufen der einzelnen APIs müssen Sie die folgenden Informationen im Anfragetext angeben:

Parameter Beschreibung Erforderlich
authType Vom Zahlungsdienstleister bereitgestellte Installations-ID. Ja
credential Base64-codierte Anmeldedaten (username:XMLpassword) für dein WorldPay-Händlerkonto. username entspricht dem Händlercode (in Großbuchstaben) und XMLpassword gibt das XML-Passwort an, das du im vorherigen Schritt bei der Einrichtung deines WorldPay-Händlerkontos festgelegt hast. Ja
description Beschreibung des Zahlungsanbieters. Nein
endpoint Endpunkt für den Zugriff auf den Zahlungsdienstleister
  • Für Testkonten verwenden Sie: https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp
  • Für Produktionskonten verwenden Sie: https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp
Ja
merchantCode Händlercode, der vom Zahlungsanbieter für den API-Nutzer bereitgestellt wird Ja
name Name, der für den Anbieter verwendet werden soll.

Nur Apigee Edge Private Cloud-Kunden: Bei globalen Zahlungsanbietern muss der Name in allen Edge-Organisationen eindeutig sein. Wir empfehlen, WorldPay (Groß- und Kleinschreibung wird nicht berücksichtigt) in den Anbieternamen aufzunehmen, damit er leicht zu identifizieren ist. Beispiel: WorldPay test oder WorldPay prod. Leerzeichen in Anbieternamen werden in Unterstriche umgewandelt.

Ja

Mit dem folgenden Code wird beispielsweise ein Händlerkonto mit Worldpay mit dem Namen Worldpay-myorg eingerichtet:

$ curl  -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Worldpay-myorg",
    "description": "Worldpay payment provider",
    "endpoint": "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "authType": "123456",
    "credential": "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "merchantCode": "myMerchantCode"
  }' \
"https://api.enterprise.apigee.com/v1/organizations/myOrg/providers" \
-u email:password 

Zahlungsdrittanbieter aufrufen

Sie können die für Ihre Edge-Organisation konfigurierten Zahlungsanbieter von Drittanbietern aufrufen und bestätigen, indem Sie eine GET-Anfrage an die folgende Ressource senden:

/mint/organizations/{org-name}/providers

Hier siehst du beispielsweise die Zahlungsdrittanbieter, die derzeit für myorg konfiguriert sind:

$ curl  -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \
-u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort mit zwei Händlerkonten, eines für die Tests und eines für die Produktion.

{
  "provider" : [ {
    "authType" : "123456",
    "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "description" : "Worldpay payment provider",
    "endpoint" : "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "id" : "worldpay-myorg",
    "merchantCode" : "MERCH_CODE",
    "name" : "Worldpay-myorg"
  }, {
    "authType" : "123456",
    "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "description" : "Worldpay payment provider",
    "endpoint" : "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "id" : "worldpay-test",
    "merchantCode" : "MERCH_CODE_FROM_PROVIDER",
    "name" : "Worldpay-test"
  } ]
}

Monetarisierungs- und Worldpay-Module im Entwicklerportal aktivieren und konfigurieren

Aktivieren Sie die erforderlichen Monetarisierungs- und Worldpay-Module im Entwicklerportal. Weitere Informationen finden Sie unter Monetarisierung im Developer Portal konfigurieren.

Zahlung an ein Prepaid-Konto über den Zahlungsdienstleister initiieren

Wie in Schritt 2 des Ablaufs zur Verwaltung eines Prepaid-Kontos dargestellt, wird die Zahlung an ein Prepaid-Konto über einen Zahlungsanbieter vom Entwicklerportal in folgenden Fällen initiiert:

  • Preisplan akzeptieren, aber nicht genügend Guthaben auf dem Prepaid-Konto
  • Bitten Sie, Geld auf das Prepaid-Konto einzuzahlen.

Wenn Sie eine Zahlung über einen Drittanbieter mithilfe der API initiieren möchten, senden Sie eine POST-Anfrage an die folgende Ressource. Dabei ist {developer_id} die E-Mail-Adresse des Entwicklers.

/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}

Wenn Sie die Anfrage senden, müssen Sie die folgenden Werte als Suchparameter angeben:

  • Betrag, der dem Guthaben des Prepaid-Kontos hinzugefügt werden soll (amount={amount})
  • Zahlungsanbieter-ID (provider={providerId})
  • Unterstützte Währung (supportedCurrencyId={currency})

Außerdem müssen Sie grundlegende Kontodetails angeben, z. B. die Rechnungsadresse des Unternehmens.

Im folgenden Beispiel wird beispielsweise das Guthaben eines Prepaid-Kontos über den Zahlungsanbieter Worldpay aufgeladen. Die erste Überweisung auf Ihr Prepaid-Konto beträgt 10 $ (amount-Abfrageparameter ist auf 10 festgelegt).

$ curl  -H "Content-Type:application/xml" -X POST -d \
'{
    "address1": "5115 Hopyard Ave.",
    "city": "Pleasanton",
    "country": "US",
    "state": "CA",
    "zip": "58158"
}'
' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/payment?amount=10&provider=worldpay-myorg&supportedCurrencyId=usd" \
-u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}

Die URL zur sicheren Zahlungsseite von Worldpay wird in referenceUrl zurückgegeben. Ihr eindeutiger Bestellschlüssel wird als Abfrageparameter angehängt.

Prepaid-Guthaben mit der API aufladen

Wie in Schritt 15 des Ablaufs zur Verwaltung von Prepaid-Konten dargestellt, sendet das Entwicklerportal nach der Bestätigung der erfolgreichen Verarbeitung durch den Zahlungsanbieter eine Anfrage an Edge, um das Prepaid-Konto aufzuladen.

Sie können das Guthaben eines Prepaid-Kontos für einen Entwickler oder ein Unternehmen mithilfe der API aufladen, wie in den folgenden Abschnitten beschrieben.

Prepaid-Guthaben für einen Entwickler aufladen

Wenn Sie das Guthaben eines Prepaid-Kontos für einen Entwickler über die API aufladen möchten, senden Sie eine POST-Anfrage an /mint/organizations/{org_name}/developers/{developer_id}/developer-balances. Dabei ist {developer_id} die E-Mail-Adresse des Entwicklers. Wenn Sie die Anfrage senden, müssen Sie im Anfragetext den Betrag angeben, der dem Guthaben hinzugefügt werden soll, und die verwendete Währung.

Durch die folgende Anfrage werden dem Prepaidguthaben eines Entwicklers beispielsweise 1.000 € hinzugefügt:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "amount": 1000,
  "supportedCurrency": {
      "id": "usd" 
  } 
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

Eine Beschreibung der Anfrageeigenschaften findest du unter Zusammenfassung der Anfrageeigenschaften für das Aufladen eines Prepaid-Kontos.

Prepaid-Guthaben für ein Unternehmen aufladen

Wenn Sie das Guthaben eines Prepaid-Kontos für ein Unternehmen über die API aufladen möchten, senden Sie eine POST-Anfrage an /mint/organizations/{org_name}/companies/{company_id}/developer-balances. Dabei ist {company_id} die ID des Unternehmens. Wenn Sie die Anfrage senden, müssen Sie im Anfragetext den Betrag angeben, der dem Guthaben hinzugefügt werden soll, und die verwendete Währung.

Mit der folgenden Anfrage wird beispielsweise dem Guthaben des Prepaid-Kontos eines Unternehmens 1.000 $hinzugefügt:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "amount": 1000,
  "supportedCurrency": {
      "id": "usd" 
  } 
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

Eine Beschreibung der Anfrageeigenschaften findest du unter Zusammenfassung der Anfrageeigenschaften für das Aufladen eines Prepaid-Kontos.

Zusammenfassung der Anfrageeigenschaften zum Aktualisieren eines Prepaid-Kontos

Beim erneuten Laden von Prepaidguthaben über die API müssen die folgenden Attribute angegeben werden:

Name Beschreibung Standard Erforderlich?
amount

Betrag, der auf das Prepaid-Guthaben angerechnet wird (in der entsprechenden Währung).

Ja
supportedCurrency

Währung, die für das Prepaid-Guthaben verwendet wird. Dies ist die Währung, die für das Abo im gekauften API-Paket des Entwicklers festgelegt wurde.

Ja

Drittanbieter für Zahlungen löschen

Sie können einen für Ihre Edge-Organisation konfigurierten Zahlungsdrittanbieter löschen, indem Sie eine DELETE-Anfrage an die folgende Ressource senden:

Verwenden Sie die folgende API, um einen Zahlungsanbieter für eine bestimmte Organisation zu löschen:

/mint/organizations/{org-name}/providers/id

Nur Apigee Edge Private Cloud-Kunden mit Administratorrechten können einen globalen Zahlungsanbieter optional über die folgende API löschen:

/config/providers/id

Mit dem folgenden Befehl werden beispielsweise die Zahlungsanbieter von Drittanbietern gelöscht, die derzeit für „myorg“ konfiguriert sind:

$ curl  -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \
-u email:password

Prepaid-Guthaben manuell verwalten

Alternativ können Sie das Aufladen von Prepaid-Guthaben verwalten, indem Sie Zahlungen manuell oder über ein integriertes Abrechnungssystem verfolgen und dann die Monetarisierungs-API aufrufen, um das Konto aufzuladen. Weitere Informationen finden Sie unter Prepaid-Guthaben mit der API aufladen.

Automatisches Aufladen von Prepaid-Kontobeträgen mit der API einrichten

In den folgenden Abschnitten wird beschrieben, wie Sie die automatische Aktualisierung von Prepaidguthaben für einen Entwickler oder ein Unternehmen über einen externen Zahlungsdienstleister einrichten. Diese Option ist nützlich, um wiederkehrende Zahlungen für Preispläne zu verwalten.

Automatisches Aufladen des Prepaid-Guthabens für einen Entwickler einrichten

Wenn Sie das automatische Aufladen des Guthabens eines Prepaid-Kontos für einen Entwickler einrichten möchten, wenn das Guthaben unter einen bestimmten Grenzbetrag sinkt, senden Sie eine POST-Anfrage an /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup. Dabei ist {developer_id} die E-Mail-Adresse des Entwicklers.

Geben Sie beim Senden der Anfrage Folgendes an:

  • ID des Zahlungsdienstleisters, der zum erneuten Laden des Kontos (providerID) verwendet werden soll
  • Flag, das das automatische Aktualisieren aktiviert (isRecurring)
  • Grenzbetrag, unter den das Guthaben des Prepaid-Kontos sinken muss, um eine automatische Aufladung auszulösen (replenishAmount)
  • Betrag, der dem Konto automatisch hinzugefügt werden soll (recurringAmount)
  • Der Abfrageparameter supportedCurrencyID zur Angabe der Währung.

Im folgenden Beispiel wird dem Konto des Entwicklers automatisch ein Betrag von 10 $ hinzugefügt, wenn das Guthaben des Prepaid-Kontos unter 5 $ fällt.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "providerId": "worldpay-myorg",
    "isRecurring" : true,
    "replenishAmount" : 5,
    "recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password

Eine Beschreibung der Anfrageattribute finden Sie unter Zusammenfassung der Anfrageattribute zum Einrichten des automatischen Aufladens eines Prepaid-Kontos.

Automatisches Aufladen von Prepaid-Guthaben für ein Unternehmen einrichten

Wenn Sie das automatische Aufladen des Guthabens eines Prepaid-Kontos für ein Unternehmen einrichten möchten, wenn das Guthaben unter einen bestimmten Betrag sinkt, senden Sie eine POST-Anfrage an /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup. Dabei ist {company_id} die ID des Unternehmens.

Beim Einreichen der Anfrage müssen Sie Folgendes angeben:

  • ID des Zahlungsanbieters, mit dem das Konto aufgeladen werden soll (providerID)
  • Flag, das die automatische Aktualisierung aktiviert (isRecurring)
  • Grenzbetrag, unter den das Guthaben des Prepaid-Kontos sinken muss, um eine automatische Aufladung auszulösen (replenishAmount)
  • Betrag, der dem Konto automatisch hinzugefügt werden soll (recurringAmount)
  • Der Abfrageparameter supportedCurrencyID zur Angabe der Währung.

Wenn das Prepaidguthaben des Unternehmens im folgenden Beispiel unter 5 $ sinkt, werden dem Konto automatisch weitere 10 $ hinzugefügt.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "providerId": "worldpay-myorg",
    "isRecurring" : true,
    "replenishAmount" : 5,
    "recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password

Eine Beschreibung der Anfrageattribute finden Sie unter Zusammenfassung der Anfrageattribute zum Einrichten des automatischen Aufladens eines Prepaid-Kontos.

Zusammenfassung der Anfrageeigenschaften zum Einrichten der automatischen Aktualisierung von Prepaid-Konten

Die folgenden Attribute können angegeben werden, wenn das Guthaben eines Prepaid-Kontos automatisch über die API aufgeladen wird.

Name Beschreibung Standard Erforderlich?
providerId

ID des Zahlungsanbieters.

Ja
chargePerUsage falsch Nein
isRecurring

Gibt an, ob die automatische Aktualisierung aktiviert ist (true). Wenn Sie die automatische Aktualisierung deaktivieren möchten, setzen Sie dieses Flag auf false.

Ja
replenishAmount

Grenzbetrag, unter den das Guthaben des Prepaid-Kontos sinken muss, um eine automatische Aufladung auszulösen.

Ja
recurringAmount

Der Betrag, der dem Guthaben des Prepaid-Kontos hinzugefügt wird, wenn die automatische Aufladung ausgelöst wird.

Ja

Migration zu den gehosteten Zahlungsseiten von WorldPay

WorldPay hat seinen sicheren Zahlungsvorgang aktualisiert und verwendet jetzt neue Seiten, die als gehostete Zahlungsseiten bezeichnet werden.

Wenn Sie Ihre WorldPay-Zahlungsanbieter vor August 2017 mit dem eingestellten Ablauf für die sichere Zahlungsabwicklung konfiguriert haben, müssen Sie vor Januar 2018 zu den neuen Hosted Payment Pages von WorldPay migrieren.

So migrieren Sie zu den gehosteten Zahlungsseiten von WorldPay:

  1. Wenden Sie sich an WorldPay, um Ihr aktuelles Konto auf die neuen gehosteten Zahlungsseiten umzustellen und eine neue Installations-ID für Ihr Konto zu erhalten.
  2. Konfigurieren Sie neue WorldPay-Zahlungsanbieter wie unter Zahlungsanbieter in Edge konfigurieren beschrieben und geben Sie die Installations-ID im Feld authType ein.
  3. Konfigurieren Sie die neuen Zahlungsanbieter in Ihrem Entwicklerportal, wie unter Monetarisierung im Entwicklerportal konfigurieren beschrieben.
  4. Wenn Sie die automatische Aktualisierung eines Prepaidkontos über den Zahlungsanbieter einrichten, müssen Sie die automatische Aktualisierung so konfigurieren, dass die neue Anbieter-ID verwendet wird, wie unter Automatisches Aufladen von Prepaidguthaben mithilfe der API einrichten beschrieben.

Nächste Schritte

Sie können Kreditlimits für einzelne Entwickler mit nachträglicher Zahlung festlegen. Weitere Informationen