Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Aby zarządzać saldem na koncie przedpłaconym:
- Wyświetl aktualne saldo konta rozliczanego w systemie przedpłaconym. Patrz sekcja Wyświetlanie reklam przedpłaconych salda kont za pomocą interfejsu API.
- W razie potrzeby ponownie załadować (dodać środki) saldo konta, korzystając z usług zewnętrznego dostawcy usług płatniczych.
takich jak Worldpay. Zobacz Zarządzanie saldami przedpłaconymi za pomocą usług firmy zewnętrznej
dostawcy usług płatniczych.
Możesz też zarządzać doładowaniem, śledząc płatności ręcznie lub za pomocą zintegrowanego systemu rozliczeniowego, a potem wywoływać interfejs API do zarabiania w celu ponownego załadowania konta. opisane w artykule Ręczne zarządzanie saldami przedpłaconymi.
- Ustaw automatyczne doładowanie, gdy saldo przedpłaty konta spadnie poniżej określonego progu za pomocą interfejsu API do zarabiania i zewnętrznego dostawcy usług płatniczych, takiego jak Worldpay. Ta opcja jest przydatne do zarządzania płatnościami cyklicznymi za plany stawek. Więcej informacji znajdziesz w sekcji Konfigurowanie automatycznego doładowywania salda kont przedpłaconych za pomocą interfejsu API.
Jak obliczyć pozostałe saldo konta rozliczanego w systemie przedpłaconym?
Podczas wyświetlania salda konta przedpłaconego dla dewelopera lub firmy w sposób opisany w sekcjach poniżej: uzyskać z odpowiedzi następujące wartości:
amount
: łączna kwota środków dostępnych w bieżącym okresie rozliczeniowym. Ta wartość jest aktualizowana po ponownym załadowaniu na koncie przedpłaconym za pomocą metod opisanych w tej sekcji.usage
: łączna kwota użyta w bieżącym okresie rozliczeniowym. Ta wartość jest aktualizowana o każdą kwalifikowaną kwotę generującą przychody transakcji lub przyznania kredytu (pozytywnego lub negatywnego).
Możesz obliczyć,
pozostałe saldo konta przedpłaconego w bieżącym okresie rozliczeniowym, odejmując wartość usage
od
Wartość: amount
. Na przykład jeśli wartość amount
to 335,50, a wartość usage
to 34,
pozostałe saldo zostanie obliczone w następujący sposób:
amount(335.50) - usage(34) = 229.50
Wyświetlanie salda kont przedpłaconych przy użyciu interfejsu API
W sekcjach poniżej opisano wyświetlanie salda kont przedpłaconych w przypadku dewelopera lub za pomocą interfejsu API.
Wyświetlanie salda kont przedpłaconych w przypadku dewelopera
Aby wyświetlić salda kont przedpłaconych w przypadku dewelopera, wyślij żądanie GET do jednego z tych interfejsów API, gdzie {developer_id}
to adres e-mail dewelopera:
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances
: zwraca saldo konta przedpłaconego i cykliczne informacje o konfiguracji dewelopera./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances
: zwraca informacje o saldzie konta z przedpłaty, w tym bieżące i całkowite saldo, wykorzystanie, doładowania oraz podatek za użytkowanie.
Aby filtrować wyniki, możesz przekazać te parametry zapytania:
Parametr zapytania | Opis |
---|---|
all |
Flaga, która określa, czy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwracanych na stronę wynosi
zdefiniowane przez parametr zapytania size . Wartość domyślna to false. |
size |
Liczba pakietów API zwróconych na stronę. Wartość domyślna to 20. Jeśli zapytanie all
ma wartość true , jest on ignorowany. |
page |
Numer strony, którą chcesz zwrócić (jeśli treść jest podzielona na strony). Jeśli
parametr zapytania all ma wartość true , to
jest ignorowany. |
currencyId |
Identyfikator waluty, dla której chcesz wyświetlić salda kont przedpłaconych. |
Na przykład:
$ 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
Oto przykład takiej odpowiedzi:
{ "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 }
Wyświetlanie salda kont przedpłaconych dla firmy
Aby wyświetlić salda kont przedpłaconych firmy, wyślij żądanie GET do
/mint/organizations/{org_name}/companies/{company_id}/developer-balances
, gdzie
{company_id}
to identyfikator firmy. Jeśli firma jest opłacana z góry, żądanie
pobiera bieżące saldo przedpłaty konta. Jeśli firma korzysta z abonamentu, żądanie pobiera
obecny limit kredytowy.
Aby filtrować wyniki, możesz przekazać te parametry zapytania:
Parametr zapytania | Opis |
---|---|
all |
Flaga, która określa, czy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwracanych na stronę wynosi
zdefiniowane przez parametr zapytania size . Wartość domyślna to false. |
size |
Liczba pakietów API zwróconych na stronę. Wartość domyślna to 20. Jeśli zapytanie all
ma wartość true , jest on ignorowany. |
page |
Numer strony, którą chcesz zwrócić (jeśli treść jest podzielona na strony). Jeśli
parametr zapytania all ma wartość true , to
jest ignorowany. |
currencyId |
Identyfikator waluty, dla której chcesz wyświetlić salda kont przedpłaconych. |
Na przykład:
$ 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
Odpowiedź jest podobna do powyższej odpowiedzi, gdy wyświetlasz salda kont przedpłaconych jako programistę.