<ph type="x-smartling-placeholder"></ph>
Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur
Apigee X-Dokumentation. Weitere Informationen
So verwalten Sie das Guthaben in einem Prepaidkonto:
- Sehen Sie sich das aktuelle Vorauszahlungsguthaben auf dem Konto an. Weitere Informationen finden Sie unter Anzeigen von Prepaid-Tarifen Kontostände mithilfe der API ermitteln.
- Laden Sie das Guthaben nach Bedarf über einen externen Zahlungsdienstleister neu.
wie WorldPay. Siehe Verwalten von Prepaidguthaben über Drittanbieter
Zahlungsdienstleister
Alternativ können Sie die Nachladevorgänge verwalten, indem Sie Zahlungen manuell oder über ein integriertes Abrechnungssystem und anschließendes Aufrufen der Monetarisierungs-API, um das Konto neu zu laden. wie unter Prepaidguthaben manuell verwalten beschrieben.
- Automatische Aufladung für den Fall einrichten, dass das Prepaidguthaben unter einen bestimmten Grenzwert fällt mit der Monetarisierungs-API und einem Drittanbieter wie Worldpay. Diese Option ist nützlich für die Verwaltung wiederkehrender Zahlungen für Tarifpläne. Weitere Informationen finden Sie unter Einrichten der die automatische Aktualisierung von Prepaidguthaben mithilfe der API.
Wie berechne ich das verbleibende Vorauszahlungsguthaben?
Wenn Sie sich das Prepaidguthaben eines Entwicklers oder Unternehmens ansehen möchten, wie in den folgenden Abschnitten beschrieben, müssen Sie erhalten Sie in der Antwort die folgenden Werte:
amount
: Der für den aktuellen Abrechnungszeitraum verfügbare Gesamtbetrag. Dieser Wert wird beim Aktualisieren aktualisiert Prepaid-Konto mit den in diesem Abschnitt beschriebenen Methoden.usage
: Gesamtbetrag, der im aktuellen Abrechnungszeitraum verwendet wurde. Dieser Wert wird mit jedem qualifizierten monetarisierten Transaktion oder durch Ausstellen einer Gutschrift (positiv oder negativ)
Sie können Folgendes berechnen:
das verbleibende Prepaidguthaben für den aktuellen Abrechnungszeitraum durch Subtrahieren des usage
-Werts vom
amount
-Wert. Beispiel: Wenn der Wert von amount
335, 50 und der Wert usage
34 ist, gibt der Wert
wird der verbleibende Saldo wie folgt berechnet:
amount(335.50) - usage(34) = 229.50
Prepaidguthaben mit der API ansehen
In den folgenden Abschnitten wird beschrieben, wie Sie das Prepaidguthaben für einen Entwickler oder Unternehmen mithilfe der API.
Prepaidguthaben für Entwickler ansehen
Wenn Sie das Prepaidguthaben eines Entwicklers aufrufen möchten, senden Sie eine GET-Anfrage an eine der folgenden APIs, wobei {developer_id}
die E-Mail-Adresse des Entwicklers ist:
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances
: Gibt das Prepaidguthaben und Informationen zur wiederkehrenden Einrichtung für einen Entwickler zurück./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances
: Gibt Informationen zum Prepaidguthaben zurück, einschließlich des aktuellen und des Gesamtguthabens, der Nutzung, des Aufladens und der 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 pro Seite die Anzahl der API-Pakete nicht mehr zurückgegeben:
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 die all -Abfrage
auf true gesetzt ist, wird dieser Parameter ignoriert. |
page |
Nummer der Seite, die Sie zurückgeben möchten (falls der Inhalt paginiert ist). Wenn
ist der Abfrageparameter all auf true gesetzt,
wird 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 }
Anzeigen von Prepaidguthaben für ein Unternehmen
Um das Prepaidguthaben eines Unternehmens anzuzeigen, senden Sie eine GET-Anfrage an
/mint/organizations/{org_name}/companies/{company_id}/developer-balances
, wobei
{company_id}
ist die ID des Unternehmens. Wenn das Unternehmen eine Vorauszahlung hat,
ruft das aktuelle Vorauszahlungsguthaben des Kontos ab. Bei einer nachträglichen Zahlung ruft die Anfrage
das aktuelle Kreditlimit zu überschreiten.
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 pro Seite die Anzahl der API-Pakete nicht mehr zurückgegeben:
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 die all -Abfrage
auf true gesetzt ist, wird dieser Parameter ignoriert. |
page |
Nummer der Seite, die Sie zurückgeben möchten (falls der Inhalt paginiert ist). Wenn
ist der Abfrageparameter all auf true gesetzt,
wird 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 das Prepaidguthaben für Entwickler.