Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Aby zarządzać saldem na koncie przedpłaconym, możesz:
- Wyświetlić bieżące saldo przedpłaty. Przeczytaj sekcję Wyświetlanie sald kont przedpłaconych za pomocą interfejsu API.
- W razie potrzeby załaduj saldo konta ponownie, korzystając z zewnętrznego dostawcy usług płatniczych, np. Worldpay. Więcej informacji znajdziesz w artykule o zarządzaniu saldem przedpłaconym za pomocą zewnętrznego dostawcy usług płatniczych.
Możesz też zarządzać ponownym doładowaniem, śledząc płatności ręcznie lub za pomocą zintegrowanego systemu rozliczeniowego, a następnie wywołując interfejs API monetyzacji w celu ponownego załadowania konta, zgodnie z opisem w sekcji Ręczne zarządzanie saldem przedpłaconym.
- Skonfiguruj automatyczne doładowanie, gdy saldo konta przedpłaconego spadnie poniżej określonego progu, korzystając z interfejsu API zarabiania i zewnętrznego dostawcy usług płatniczych, np. Worldpay. Ta opcja jest przydatna do zarządzania płatnościami cyklicznymi w ramach abonamentów. Więcej informacji znajdziesz w artykule Konfigurowanie automatycznego doładowywania sald przedpłaconych kont za pomocą interfejsu API.
Jak obliczyć saldo pozostałego na koncie przedpłat?
Podczas wyświetlania salda przedpłaconego konta dewelopera lub firmy, jak opisano w poniższych sekcjach, musisz uzyskać z odpowiedzi te wartości:
amount
: łączna kwota dostępna w bieżącym okresie rozliczeniowym. Ta wartość jest aktualizowana po ponownym załadowaniu konta przedpłaconego za pomocą metod opisanych w tej sekcji.usage
: łączna kwota wykorzystana w bieżącym okresie rozliczeniowym. Ta wartość jest aktualizowana po każdej kwalifikującej się transakcji generującej przychód albo przez przyznanie środków (dodatnich lub ujemnych).
Możesz obliczyć pozostałe saldo z przedpłaty w bieżącym okresie rozliczeniowym, odejmując wartość usage
od wartości amount
. Jeśli np.wartość amount
to 335,50, a usage
– 34, pozostałe saldo zostanie obliczone w ten sposób:
amount(335.50) - usage(34) = 229.50
Wyświetlanie sald kont przedpłaconych przy użyciu interfejsu API
W kolejnych sekcjach opisano, jak wyświetlać salda kont przedpłaconych w przypadku dewelopera lub firmy korzystającej z interfejsu API.
Wyświetlanie sald przedpłaconych kont programisty
Aby wyświetlić salda przedpłaconych kont 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 z przedpłaconego konta i cykliczne informacje o konfiguracji dewelopera./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances
: zwraca informacje o saldzie przedpłaconego konta, w tym bieżące i całkowite saldo, wykorzystanie, doładowania i podatek od użytkowania.
Aby filtrować wyniki, możesz przekazywać te parametry zapytania:
Parametr zapytania | Opis |
---|---|
all |
Flaga określająca, czy należy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwróconych na stronę jest określana przez parametr zapytania size . Wartość domyślna to false. |
size |
Liczba pakietów interfejsu API zwróconych na stronę. Wartość domyślna to 20. Jeśli parametr zapytania 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 , jest on ignorowany. |
currencyId |
Identyfikator waluty, dla której chcesz wyświetlić saldo konta przedpłaconego. |
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
Poniżej znajdziesz przykładową odpowiedź:
{ "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 sald przedpłaconych kont firmowych
Aby wyświetlić salda przedpłaconych kont firmy, wyślij do /mint/organizations/{org_name}/companies/{company_id}/developer-balances
żądanie GET, gdzie {company_id}
to identyfikator firmy. Jeśli firma jest opłacana z góry, żądanie pobiera bieżące saldo konta przedpłaconego. Jeśli firma jest rozliczana w ramach abonamentu, żądanie pobiera bieżący limit kredytu.
Aby filtrować wyniki, możesz przekazywać te parametry zapytania:
Parametr zapytania | Opis |
---|---|
all |
Flaga określająca, czy należy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwróconych na stronę jest określana przez parametr zapytania size . Wartość domyślna to false. |
size |
Liczba pakietów interfejsu API zwróconych na stronę. Wartość domyślna to 20. Jeśli parametr zapytania 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 , jest on ignorowany. |
currencyId |
Identyfikator waluty, dla której chcesz wyświetlić saldo konta przedpłaconego. |
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 tej, która wyświetla się powyżej, podczas przeglądania salda konta przedpłaconego dewelopera.
Zarządzanie saldem przedpłaconych kont za pomocą dostawcy usług płatniczych
Zarządzaj saldem kont przedpłaconych, konfigurując konto sprzedawcy u zewnętrznego dostawcy usług płatniczych, takiego jak Worldpay. Poniższy rysunek pokazuje, jak można zarządzać saldem konta przedpłaconego za pomocą dostawcy usług płatniczych WorldPay.
W tabeli poniżej opisano każdy krok procesu zarządzania saldem konta przedpłaconego (przedstawiony powyżej).
Step | Opis |
---|---|
0 |
Wymagania wstępne Dostawca interfejsu API, aby skonfigurować zewnętrznego dostawcę usług płatniczych, np. Worldpay, musisz: |
1 |
Aby aktywować proces, użytkownik interfejsu API wykonuje w portalu dla programistów jedno z tych zadań:
|
2 | Portal dla programistów inicjuje płatność przez Edge dla dewelopera, podając identyfikator dostawcy, kwotę doładowania i walutę. Informacje o inicjowaniu płatności za pomocą interfejsu API znajdziesz w artykule Inicjowanie płatności na konto przedpłacone za pomocą dostawcy usług płatniczych. |
3 | Edge znajduje dostawcę na podstawie identyfikatora i określa, że jest to konto Worldpay. |
4 | Edge generuje kod zamówienia. |
5 | Edge tworzy zamówienie płatności w Worldpay. |
6 | Worldpay zwraca identyfikator referencyjny zamówienia i adres URL ograniczony w czasie, aby je zrealizować. |
7 |
Odpowiedź Worldpay jest konwertowana na ogólną odpowiedź Edge /payment API, która jest zwracana z powrotem do portalu dla programistów, aby ukończyć wywołanie zainicjowane w kroku 2. Na przykład: { "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" } |
8 | Portal dla programistów dołącza do adresu URL adresy URL wywołań zwrotnych (pomyślne, nieudane itd.) jako parametry zapytania. |
9 | Portal dla programistów odpowiada na żądanie w kroku 1, przekierowując przeglądarkę użytkownika interfejsu API na zmodyfikowany adres URL. |
10 | Klient interfejsu API wypełnia formularz zgłoszeniowy i rozpoczyna przetwarzanie za pomocą Worldpay. |
11 | Worldpay przechwytuje informacje rozliczeniowe i przetwarza płatność. Po pomyślnym zakończeniu Worldpay generuje kod MAC (Message Authentication Code) przy użyciu tajnego klucza MAC skonfigurowanego zarówno w Worldpay, jak i w portalu dla programistów. |
12 | Worldpay przekierowuje przeglądarkę użytkownika interfejsu API na adres URL prawidłowego wywołania zwrotnego (z kroku 8), dołączając MAC jako parametr zapytania oraz kwotę. |
13 | Przeglądarka wywołuje adres URL w portalu dla deweloperów, podając żądaną kwotę i adres MAC. |
14 | Portal weryfikuje adres MAC pod kątem tajnego klucza MAC. Adres MAC uniemożliwia użytkownikom arbitrażowe twierdzenie, że płatności zostały zrealizowane. |
15 | Portal dla programistów wysyła do Edge żądanie ponownego wczytania salda konta przedpłaconego. Informacje o używaniu interfejsu API do ponownego ładowania salda konta znajdziesz w artykule Ponowne ładowanie salda konta przedpłaconego za pomocą interfejsu API. |
W tych sekcjach opisano, jak zarządzać saldem przedpłaconym za pomocą zewnętrznego dostawcy usług płatniczych:
- Konfigurowanie konta sprzedawcy u dostawcy usług płatniczych Worldpay
- Konfigurowanie dostawcy usług płatniczych w Edge
- Wyświetlanie dostawców usług płatniczych skonfigurowanych dla Twojej organizacji
- Włączanie i konfigurowanie wymaganych modułów w portalu dla programistów
- Inicjowanie płatności na konto przedpłacone za pomocą dostawcy usług płatniczych
- Ponowne wczytanie salda przedpłaconego konta za pomocą interfejsu API
- Usuwanie zewnętrznego dostawcy usług płatniczych
Konfigurowanie konta sprzedawcy u dostawcy usług płatniczych Worldpay
Zanim zaczniesz, musisz skontaktować się z zewnętrznym dostawcą usług płatniczych (Worldpay), aby skonfigurować konta sprzedawcy. Zalecamy skonfigurowanie 2 kont – jednego do testowania, a drugiego do środowiska produkcyjnego. Więcej informacji o kontach sprzedawców Worldpay znajdziesz na stronach www.worldpay.com i wp-support.crm.worldpay.com (Centrum pomocy Worldpay).
Gdy skonfigurujesz konto sprzedawcy i otrzymasz dane logowania do konta, aby skonfigurować konto sprzedawcy w Worldpay:
- Wejdź na https://secure.worldpay.com/sso/public/auth/login.html.
- Zaloguj się na swoje konto Worldpay przy użyciu danych logowania podanych przez Worldpay.
- Ustaw tajny klucz MAC hasła i kodu XML:
- Kliknij Profil.
- W polu Hasło XML ustaw hasło, którego chcesz używać podczas konfigurowania dostawcy płatności Worldpay w Edge.
- Wpisz tajny klucz MAC o długości od 20 do 30 znaków w polu Tajny klucz MAC przekierowania.
- Kliknij Zapisz profil.
- Dodaj serwer zarządzania Apigee Edge do listy adresów IP sprzedawców (lista dozwolonych):
- Kliknij Profil > Środowisko sprzedawcy.
- Kliknij Nowy testowy adres IP.
- Wpisz adres IP serwera zarządzania Apigee Edge.
- Kliknij Zapisz.
- Skonfiguruj adres URL sprzedawcy tak, aby dołączał parametry Worldpay, w tym kod uwierzytelniania metody (MAC):
- Kliknij Instalacje > Hostowane strony płatności > Projektant stron płatności.
- W sekcji Edytuj strony płatności wybierz identyfikator instalacji z listy Wybierz kanał.
- Na karcie Właściwości kliknij Edytuj konfigurację sprzedawcy.
- Ustaw wartość True (Prawda) dla parametrów adresu URL.
- Kliknij kartę Publikowanie.
- Promuj zmiany w ten sposób:
- W przypadku środowisk testowych kliknij Przenieś w sekcji Projekt, aby przenieść z projektu do piaskownicy.
- W przypadku środowisk produkcyjnych kliknij Przenieś w sekcji Piaskownica, aby zmienić wersję z piaskownicy na produkcyjną.
Konfigurowanie dostawcy usług płatniczych w Edge
Następnym krokiem jest skonfigurowanie dostawcy usług płatniczych w Edge.
Możesz skonfigurować dostawcę usług płatniczych dla konkretnej organizacji za pomocą tego interfejsu API:
/organizations/{org-name}/providers
Tylko klienci korzystający z Apigee Edge Private Cloud z uprawnieniami administratora Sys mogą opcjonalnie skonfigurować globalnego dostawcę płatności za pomocą tego interfejsu API:
/config/providers
Przy wywoływaniu każdego interfejsu API musisz podać w treści żądania te informacje:
Parametr | Opis | Wymagany |
authType |
Identyfikator instalacji podany przez dostawcę usług płatniczych. | Tak |
credential |
Dane uwierzytelniające zakodowane w Base64 (username:XMLpassword ) do konta sprzedawcy Worldpay; username to odpowiednik kodu sprzedawcy (wielkimi literami), a XMLpassword określa hasło XML ustawione przez Ciebie w poprzednim kroku podczas konfigurowania konta sprzedawcy Worldpay. |
Tak |
description |
Opis dostawcy usług płatniczych. | Nie |
endpoint |
Punkt końcowy umożliwiający dostęp do dostawcy usług płatniczych.
|
Tak |
merchantCode |
Kod sprzedawcy podany przez dostawcę usług płatniczych konsumentowi interfejsu API | Tak |
name |
Nazwa, która ma być używana w przypadku dostawcy.
Tylko klienci korzystający z Apigee Edge Private Cloud: w przypadku globalnych dostawców płatności upewnij się, że nazwa jest niepowtarzalna we wszystkich organizacjach Edge. Zalecamy, aby w nazwie dostawcy podać nazwę WorldPay (wielkość liter nie jest rozróżniana) w celu ułatwienia identyfikacji. Na przykład: pokoje |
Tak |
Na przykład w podany niżej sposób możesz skonfigurować konto sprzedawcy w Worldpay o nazwie Worldpay-myorg:
$ 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
Wyświetlanie zewnętrznych dostawców usług płatniczych
Wyświetl i potwierdź zewnętrznych dostawców usług płatniczych skonfigurowanych dla Twojej organizacji Edge, wysyłając żądanie GET do tego zasobu:
/mint/organizations/{org-name}/providers
Poniżej znajdziesz na przykład zewnętrznych dostawców usług płatniczych skonfigurowanych obecnie dla konta myorg
:
$ curl -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \ -u email:password
Poniżej znajdziesz przykład odpowiedzi z 2 kontami sprzedawców – jedno do testów, a drugie do celów produkcyjnych.
{ "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" } ] }
Włączanie i konfigurowanie modułów Monetization i Worldpay w portalu dla programistów
Włącz wymagane moduły Monetization i Worldpay w portalu dla deweloperów. Więcej informacji znajdziesz w artykule o konfigurowaniu zarabiania w portalu dla programistów.
Inicjowanie płatności na przedpłacone konto za pośrednictwem dostawcy usług płatniczych
Jak widać w kroku 2 procesu zarządzania kontem przedpłaconym, płatność na konto przedpłacone przy użyciu dostawcy usług płatniczych jest inicjowana przez portal dla programistów, gdy użytkownicy interfejsu API:
- zaakceptować abonament, ale nie ma wystarczającej ilości środków na koncie przedpłaconym;
- Poprosić o dodanie środków do jego konta przedpłaconego.
Aby zainicjować płatność od zewnętrznego dostawcy usług płatniczych za pomocą interfejsu API, wyślij żądanie POST do poniższego zasobu, gdzie {developer_id}
to adres e-mail dewelopera.
/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}
Po wysłaniu żądania musisz określić te wartości jako parametry zapytania:
- Kwota, którą należy dodać do salda konta przedpłaconego (
amount={amount}
) - Identyfikator dostawcy usług płatniczych (
provider={providerId}
) - Obsługiwana waluta (
supportedCurrencyId={currency}
)
Dodatkowo musisz też przekazać podstawowe dane konta, takie jak adres rozliczeniowy firmy.
Poniżej znajdziesz na przykład ponowne wczytanie salda konta przedpłaconego u dostawcy usług płatniczych Worldpay. Początkowy przelew na konto przedpłacone wyniesie 10 USD (parametr zapytania amount
jest ustawiony na 10
).
$ 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
Poniżej znajdziesz przykładową odpowiedź:
{ "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" }
URL strony Worldpay Secure Payment jest zwracany w referenceUrl
z Twoim unikalnym kluczem zamówienia dołączonym jako parametr zapytania.
Ponowne doładowanie salda konta przedpłaconego za pomocą interfejsu API
Jak widać w kroku 15 procesu zarządzania kontem przedpłaconym, po sprawdzeniu pomyślnego przetworzenia przez dostawcę usług płatniczych portal dla programistów wysyła do Edge prośbę o ponowne załadowanie konta przedpłaconego.
Saldo konta przedpłaconego możesz ponownie załadować za pomocą interfejsu API dewelopera lub firmy, jak opisano w poniższych sekcjach.
Ponowne doładowanie salda przedpłaconego konta dewelopera
Aby doładować saldo przedpłacone konta dewelopera za pomocą interfejsu API, wyślij żądanie POST do /mint/organizations/{org_name}/developers/{developer_id}/developer-balances
, gdzie {developer_id}
to adres e-mail dewelopera. Wysyłając żądanie, musisz podać w treści żądania kwotę, którą chcesz dodać do salda, oraz używaną walutę.
Na przykład to żądanie dodaje 1000 USD do salda przedpłaconego konta dewelopera:
$ 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
Opis właściwości żądania znajdziesz w artykule Podsumowanie właściwości żądania dotyczących ponownego załadowania konta przedpłaconego.
Ponowne załadowanie salda przedpłaconego konta firmy
Aby doładować saldo konta przedpłaconego dla firmy korzystającej z interfejsu API, wyślij żądanie POST do /mint/organizations/{org_name}/companies/{company_id}/developer-balances
, gdzie {company_id}
to identyfikator firmy. Wysyłając żądanie, musisz podać w treści żądania kwotę, którą chcesz dodać do salda, oraz używaną walutę.
Na przykład następujące żądanie dodaje 1000 USD do salda konta przedpłaconego firmy:
$ 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
Opis właściwości żądania znajdziesz w artykule Podsumowanie właściwości żądania dotyczących ponownego załadowania konta przedpłaconego.
Podsumowanie właściwości żądań dotyczących ponownego załadowania konta przedpłaconego
Gdy ponownie wczytujesz salda kont przedpłaconych za pomocą interfejsu API, musisz określić te właściwości:
Nazwa | Opis | Domyślne | Wymagana? |
---|---|---|---|
amount |
Kwota dodana do salda z przedpłaty (w odpowiedniej walucie). |
Nie dotyczy | Tak |
supportedCurrency |
Waluta używana do spłacania salda z przedpłaty. To waluta ustawiona na potrzeby abonamentu w pakiecie interfejsu API kupionym przez dewelopera. |
Nie dotyczy | Tak |
Usuwanie zewnętrznych dostawców usług płatniczych
Możesz usunąć zewnętrznego dostawcę usług płatniczych skonfigurowanego dla swojej organizacji Edge, wysyłając żądanie DELETE do tego zasobu:
Aby usunąć dostawcę usług płatniczych dla określonej organizacji, użyj tego interfejsu API:
/mint/organizations/{org-name}/providers/id
Tylko klienci korzystający z Apigee Edge Private Cloud z uprawnieniami administratora Sys mogą opcjonalnie usunąć globalnego dostawcę płatności za pomocą tego interfejsu API:
/config/providers/id
Przykład poniżej powoduje usunięcie zewnętrznych dostawców usług płatniczych skonfigurowanych dla myorg:
$ curl -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \ -u email:password
Ręczne zarządzanie saldem kont przedpłaconych
Możesz też zarządzać doładowaniem sald z góry, śledząc płatności ręcznie lub za pomocą zintegrowanego systemu rozliczeniowego, a następnie wywołując interfejs API monetyzacji w celu ponownego załadowania konta zgodnie z opisem w sekcji Ponowne wczytywanie salda konta przedpłaconego za pomocą interfejsu API.
Konfigurowanie automatycznego doładowywania salda kont przedpłaconych za pomocą interfejsu API
Poniżej opisujemy, jak skonfigurować automatyczne doładowanie salda kont przedpłaconych w przypadku dewelopera lub firmy, która korzysta z zewnętrznego dostawcy usług płatniczych. Ta opcja przydaje się do zarządzania płatnościami cyklicznymi za abonamenty.
Konfigurowanie automatycznego doładowywania salda konta przedpłaconego dla dewelopera
Aby skonfigurować automatyczne doładowanie salda przedpłaconego konta dewelopera, gdy saldo spadnie poniżej określonego progu, wyślij żądanie POST na adres /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup
, gdzie {developer_id
} to adres e-mail dewelopera.
Po wysłaniu prośby musisz podać te informacje:
- Identyfikator dostawcy usług płatniczych, którego należy użyć do ponownego załadowania konta (
providerID
) - Flaga umożliwiająca automatyczne ponowne wczytywanie (
isRecurring
) - Próg, poniżej którego saldo konta przedpłaconego musi spaść, aby zostało aktywowane automatyczne doładowanie (
replenishAmount
) - Kwota, która ma zostać automatycznie dodana do konta (
recurringAmount
) supportedCurrencyID
, aby określić walutę.
W tym przykładzie, gdy saldo konta przedpłaconego dewelopera spadnie poniżej 5 USD, do konta zostanie automatycznie dodane kolejne 10 USD.
$ 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
Opis właściwości żądania znajdziesz w artykule Podsumowanie właściwości żądania dotyczącego konfiguracji automatycznego doładowywania kont przedpłaconych.
Konfigurowanie automatycznego doładowywania salda kont przedpłaconych dla firmy
Aby skonfigurować automatyczne doładowanie salda konta przedpłaconego dla firmy, gdy saldo spadnie poniżej określonej kwoty, wyślij żądanie POST na adres /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup
, gdzie {company_id} to identyfikator firmy.
Po wysłaniu prośby musisz podać te informacje:
- Identyfikator dostawcy usług płatniczych, którego należy użyć do ponownego załadowania konta (
providerID
) - Flaga, która włącza automatyczne ponowne wczytywanie (
isRecurring
) - Próg, poniżej którego saldo konta przedpłaconego musi spaść, aby zostało aktywowane automatyczne doładowanie (
replenishAmount
) - Kwota, która ma zostać automatycznie dodana do konta (
recurringAmount
) supportedCurrencyID
, aby określić walutę.
W poniższym przykładzie, gdy saldo konta przedpłaconego firmy spadnie poniżej 5 USD, do konta zostanie automatycznie dodane kolejne 10 USD.
$ 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
Opis właściwości żądania znajdziesz w artykule Podsumowanie właściwości żądania dotyczącego konfiguracji automatycznego doładowywania kont przedpłaconych.
Podsumowanie właściwości żądań dotyczących konfiguracji automatycznego doładowywania kont przedpłaconych
Poniższe atrybuty można określić podczas automatycznego ponownego wczytywania sald kont przedpłaconych za pomocą interfejsu API.
Nazwa | Opis | Domyślne | Wymagana? |
---|---|---|---|
providerId |
Identyfikator dostawcy usług płatniczych. |
Nie dotyczy | Tak |
chargePerUsage |
false | Nie | |
isRecurring |
Flaga określająca, czy automatyczne ponowne wczytywanie jest włączone ( |
Nie dotyczy | Tak |
replenishAmount |
Próg, przy którym saldo konta przedpłaconego musi spaść poniżej poziomu, aby zostało aktywowane automatyczne doładowanie. |
Nie dotyczy | Tak |
recurringAmount |
Kwota, która ma zostać dodana do salda konta przedpłaconego po uruchomieniu automatycznego doładowania. |
Nie dotyczy | Tak |
Migracja na strony płatności hostowanych przez WorldPay
W WorldPay zaktualizowaliśmy proces bezpiecznego przetwarzania płatności, aby korzystał z nowego zestawu stron nazywanych hostowanymi stronami płatności.
Jeśli Twoi dostawcy usług płatniczych WorldPay zostali skonfigurowani za pomocą wycofanego, bezpiecznego procesu przetwarzania płatności (przed sierpniem 2017 r.), musisz przejść na nowe hostowane strony płatności WorldPay przed styczniem 2018 r.
Aby przejść na hostowane strony płatności WorldPay:
- Skontaktuj się z WorldPay, aby przenieść swoje obecne konto i korzystać z nowych hostowanych stron płatności oraz uzyskać nowy identyfikator instalacji dla swojego konta.
- Skonfiguruj nowych dostawców płatności WorldPay zgodnie z opisem w sekcji Konfigurowanie dostawcy usług płatniczych w Edge, przekazując identyfikator instalacji w polu
authType
. - Skonfiguruj nowych dostawców usług płatniczych w portalu dla deweloperów zgodnie z opisem w artykule Konfigurowanie zarabiania w portalu dla deweloperów.
- Jeśli skonfigurujesz automatyczne ponowne doładowanie konta przedpłaconego u dostawcy usług płatniczych, musisz ponownie skonfigurować automatyczne ponowne ładowanie, aby używać nowego identyfikatora dostawcy zgodnie z opisem w sekcji Konfigurowanie automatycznego ponownego ładowania sald przedpłaconych za pomocą interfejsu API.
Dalsze kroki
Możesz ustawić limity kredytu dla poszczególnych deweloperów korzystających z abonamentów. Dowiedz się, jak to zrobić, w artykule Zarządzanie saldem po wykonaniu usługi.