Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Wprowadzenie
Funkcja zarabiania umożliwia wysyłanie do deweloperów zwrotów środków za „transakcje zakupu”. Załóżmy, że jesteś operatorem sieci komórkowej i oferujesz deweloperom interfejs API do płatności, który będzie obciążał subskrybentów zakupu aplikacji lub treści w aplikacji. Za każdym razem, gdy subskrybent używa interfejsu API jest to transakcja zakupu.
Transakcje zakupu mogą skutkować zwrotem środków. Na przykład treści mogą nie zostać dostarczone, lub osoba trzecia jest z innego powodu niezadowolona z zakupu. W takich przypadkach programista zwróci środki osobie trzeciej. Zarabianie umożliwia dokonanie analogicznego zwrotu środków. To jest w szczególności z planów udziału w przychodach.
Załóżmy, że deweloper, który dokonał zwrotu środków subskrybentowi mobilnemu, kupił przychód. udostępnić plan usługi API. Załóżmy, że zgodnie z planem deweloper otrzymuje 70% cena netto/brutto z transakcji zakupu. Decydując się na zwrot środków, możesz wycofać transakcji zakupu, czyli odliczasz 70% od płatności należnej deweloperowi za dany miesiąc. kiedy przyznano zwrot (miesiąc może być inny niż miesiąc, w którym rzeczywiście transakcja zakupu).
Publikowanie zwrotu środków przy użyciu klasycznego interfejsu Edge (tylko Edge w przypadku Private Cloud)
Możesz wysłać prośbę o zwrot środków za dowolny transakcji zakupu. Oznacza to, że interfejs API skutecznie obciążył stronę trzecią, w przypadku której nie zostały jeszcze wystawione pełne zwrot kosztów. Zaksięgowanie zwrotu środków powoduje utworzenie transakcji zwrotu z osobą nadrzędną identyfikator transakcji, gdzie identyfikator transakcji to identyfikator transakcji zakupu.
Możesz wysłać informację o zwrocie pełnej kwoty pierwotnej transakcji zakupu lub częściową. Możesz też przesłać kilka częściowych zwrotów środków, ale łączną kwotę zwrotów nie może być większa niż pierwotna kwota do zapłaty.
Aby wysłać zwrot środków:
- Na karcie Zarabianie wybierz Zwroty środków.
Otworzy się strona Zwroty środków.
- W menu Miesiąc rozliczeniowy wybierz miesiąc, w którym transakcja miała miejsce
miało miejsce. Następnie kliknij + Zwroty środków.
Wyświetla listę wszystkich zrealizowanych transakcji zakupu dla wybranych miesiąc.
Możesz filtrować listę zwrotów środków według nazwy dewelopera lub wyszukać transakcji.
Aby filtrować według dewelopera, wybierz go z menu Programista. Ten wyświetla listę tylko transakcji związanych z wybranym deweloperem.
Aby filtrować według identyfikatora transakcji, wpisz identyfikator pierwotnego zakupu które chcesz zwrócić. Spowoduje to zwrócenie transakcji dla tego identyfikatora.
- Zaznacz pola wyboru w wierszach transakcji, za które chcesz zwrócić środki.
- Z menu rozwijanego Typ wybierz pozycję Łącznie lub Częściowo.
Jeśli wybierzesz opcję Łącznie, zostanie zwrócona łączna kwota zakupu. Jeśli wybierzesz Częściowo otrzymasz zwrot części zakupu.
Jeśli wybierzesz Częściowy zwrot środków, wpisz kwotę częściowego zwrotu w polu Kwota. Dostępne opcje zwrócimy jedynie środki do pełnej kwoty zakupu. Jeśli masz już opublikowany materiał zwrotu środków, możesz wpisać tylko kwotę nieprzekraczającą pozostałej kwoty zakupu. Ponadto, jeśli zawiera cenę brutto i netto, należy również podać czy kwota częściowa, którą chcesz zwrócić, jest brutto czy netto.
- Kliknij przycisk Zapisz, aby przetworzyć zwrot kosztów, lub przycisk Anuluj, aby anulować.
Jeśli miesiąc rozliczeniowy nadal trwa, zwrot zostanie doliczony do miesiąca, w którym dokonano zakupu. otwartego, w przeciwnym razie kwota zwrotu będzie liczona od bieżącego dnia.
W przypadku częściowego zwrotu kosztów przetwarzamy kwotę częściową i udział w przychodach jest odliczane na podstawie proporcji częściowej kwoty do pełnej kwoty. W przykładu częściowego zwrotu środków, kwota częściowa wynosi 0,50/1,12 = 45% ceny brutto, więc Odliczymy 45% udziału w przychodach dewelopera.
Sprawdzanie w interfejsie, czy środki zostały zwrócone przetworzono
Możesz sprawdzić, czy zwrot został już przetworzony, wybierając miesiąc rozliczeniowy na górze ze strony Zwroty kosztów. Jest to miesiąc zakupu, jeśli miesiąc rozliczeniowy jest nadal otwarty. bieżący miesiąc, jeśli miesiąc rozliczeniowy został zamknięty. Pojawi się lista wszystkich zrealizowanych zwrotów środków. opublikowano w danym miesiącu.
Publikowanie zwrotu środków przy użyciu interfejsu API
Aby opublikować zwrot środków, wyślij żądanie POST na
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions
,
gdzie {package_id}
oznacza pakiet interfejsu API, w ramach którego następuje zwrot środków
ma zastosowanie.
Przy wysyłaniu żądania musisz określić jako parametry zapytania:
- Dane identyfikacyjne transakcji zakupu, za które mają być zwrócone środki.
- Typ przychodów z transakcji zakupu (
GROSS
lubNET
). - Kwota zwrotu środków.
- Informacja o przyczynie zwrotu środków.
Opcjonalnie jako parametr adresu URL możesz wskazać pakiet interfejsu API, do którego następuje zwrot ma zastosowanie.
Pełną listę adresów URL znajdziesz w artykule Ustawienia konfiguracji zwrotu środków. parametry, które można podać w żądaniu zwrotu.
Na przykład to żądanie zwraca zwrot środków za transakcję zakupu. Zwrot środków to 50% kwoty brutto transakcji zakupu.
$ 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
Odpowiedź powinna wyglądać mniej więcej tak (widoczna jest tylko jej część):
{ "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" }
Ustawienia konfiguracji zwrotu środków dla interfejsu API
W prośbie o zwrot środków można określić te parametry zapytania:
Nazwa | Opis | Domyślny | Wymagana? |
---|---|---|---|
monetizationPackageId |
Pakiet interfejsu API, którego dotyczy zwrot. |
Nie dotyczy | Nie |
parentTxId |
Transakcja zakupu, za którą zostaną zwrócone środki. |
Nie dotyczy | Tak |
revenueType |
Typ przychodów z zakupu ( |
Nie dotyczy | Tak |
refundAmount |
kwotę zwrotu, |
Nie dotyczy | Tak |
transactionNote |
Notatka z opisem przyczyny zwrotu środków. |
Nie dotyczy | Tak |
Dalsze kroki
Dowiedz się, jak tworzyć harmonogramy zadań związanych z zarabianiem automatycznie w menu Harmonogram pracy związanej z zarabianiem.