Wysyłanie zwrotów środków

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

Funkcja zarabiania umożliwia przekazywanie środków deweloperom za „transakcje zakupu”. Załóżmy, że jesteś operatorem komórkowym i oferujesz deweloperom interfejs API płatności, który obciąża użytkowników sieci komórkowych za zakup aplikacji lub treści w aplikacji. Za każdym razem, gdy subskrybent użyje interfejsu API do dokonania zakupu, jest to transakcja zakupu.

Transakcje zakupu mogą skutkować zwrotem środków. Na przykład treści mogą nie zostać dostarczone lub firma zewnętrzna jest niezadowolona z zakupu. W takich przypadkach deweloper zwraca środki firmie zewnętrznej. Funkcja zarabiania umożliwia dokonanie analogicznego zwrotu środków. Dotyczy to zwłaszcza planów z udziałem w przychodach.

Załóżmy, że deweloper, który dokonał zwrotu środków subskrybentowi aplikacji mobilnej, kupił pakiet udziału w przychodach dla Twojej usługi API. Załóżmy, że plan wymaga, aby deweloper otrzymał 70% ceny netto/brutto za transakcję zakupu. Publikując zwrot środków, cofasz transakcję zakupu, czyli odliczasz 70% od płatności należnej deweloperowi za miesiąc, w którym przyznano zwrot środków (miesiąc może się różnić od miesiąca, w którym nastąpiła rzeczywista transakcja zakupu).

Publikowanie zwrotu środków za pomocą klasycznego interfejsu użytkownika Edge (tylko Edge dla Private Cloud)

Możesz dokonać zwrotu środków za każdą „udaną” transakcję zakupu, czyli w przypadku, gdy interfejs API obciążył firmę zewnętrzną i nie zwrócono jeszcze całego zwrotu środków. Wysłanie zwrotu środków powoduje utworzenie transakcji zwrotu z nadrzędnym identyfikatorem transakcji, gdzie identyfikator transakcji jest identyfikatorem transakcji zakupu.

Możesz zwrócić pełną kwotę pierwotnej transakcji lub jej część. Możesz też dokonać wielu częściowych zwrotów środków, ale ich łączna kwota nie może być wyższa niż pierwotnie kwota zakupu.

Aby opublikować zwrot środków:

  1. Na karcie Zarabianie wybierz Zwroty środków.

    Otworzy się strona Zwroty środków.

  2. W menu „Miesiąc rozliczeniowy” wybierz miesiąc, w którym miała miejsce transakcja zakupu. Następnie kliknij + Zwroty środków.

    Wyświetli się lista wszystkich udanych transakcji zakupu w wybranym miesiącu.

    Listę zwrotów środków możesz filtrować według nazwy dewelopera lub wyszukując rzeczywistą transakcję.

    Aby filtrować według dewelopera, wybierz go z menu Programista. Pojawi się lista tylko transakcji dotyczących wybranego dewelopera.

    Aby filtrować według identyfikatora transakcji, wpisz identyfikator pierwotnej transakcji, za którą chcesz zwrócić środki. Zwraca transakcję o tym identyfikatorze.

  3. Zaznacz pola wyboru w wierszach transakcji, za które chcesz zwrócić środki.
  4. W menu Typ wybierz opcję Łącznie lub Częściowa.

    Jeśli wybierzesz Łącznie, otrzymasz zwrot całej kwoty zakupu. Jeśli wybierzesz opcję Częściowa, otrzymasz zwrot części środków za zakup.

    Jeśli wybierzesz opcję Częściowy, wprowadź kwotę częściowego zwrotu w polu Kwota. Możesz otrzymać zwrot nieprzekraczający łącznej kwoty zakupu. Jeśli częściowy zwrot środków został już zrealizowany, możesz wpisać tylko kwotę pozostałą za zakup. Poza tym, jeśli pierwotna transakcja zakupu zawiera ceny brutto i netto, musisz też określić, czy częściowa kwota, którą chcesz zwrócić, jest brutto czy netto.

  5. Kliknij przycisk Zapisz, aby przetworzyć zwrot kosztów (lub Anuluj, aby anulować).

    Zwrot środków jest dokonywany w miesiącu, w którym dokonano pierwszego zakupu, jeśli miesiąc rozliczeniowy nadal trwa. W przeciwnym razie zwrot środków jest dokonywany do bieżącego dnia.

    W przypadku częściowego zwrotu środków jest przetwarzany częściowa kwota, a wszelkie udziały w przychodach są odliczane na podstawie proporcji części kwoty do pełnej kwoty. W tym przykładzie częściowy zwrot środków to 0,50/1,12 = 45% ceny brutto, więc odejmujemy 45% udziału dewelopera w przychodach.

Sprawdzanie w interfejsie, czy zwrot środków został zrealizowany

Aby sprawdzić, czy zwrot środków został zrealizowany, wybierz miesiąc rozliczeniowy u góry strony Zwroty środków. Jest to miesiąc zakupu, jeśli miesiąc rozliczeniowy jeszcze trwa, lub bieżący miesiąc, jeśli miesiąc rozliczeniowy jest zamknięty. Pojawi się lista wszystkich zwrotów środków opublikowanych w danym miesiącu.

Publikowanie zwrotu środków przy użyciu interfejsu API

Aby opublikować zwrot środków, wyślij żądanie POST do /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, gdzie {package_id} to identyfikator pakietu API, którego dotyczy zwrot środków.

Wysyłając żądanie, musisz określić jako parametry zapytania:

  • Identyfikator transakcji zakupu, za którą podlegają zwrotowi środków.
  • Typ przychodów (GROSS lub NET) z transakcji zakupu.
  • Kwota zwrotu środków.
  • Notatka z opisem przyczyny zwrotu środków.

Opcjonalnie możesz określić jako parametr adresu URL pakiet API, którego dotyczy zwrot środków.

Pełną listę parametrów adresu URL, które możesz określić w prośbie o zwrot środków, znajdziesz w artykule Ustawienia konfiguracji zwrotu środków.

Na przykład poniższy wniosek zwróci środki za transakcję zakupu. Kwota zwrotu ś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 będzie tylko część odpowiedzi):

{
  "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 zwrotów środków dla interfejsu API

W prośbie o zwrot środków można podać te parametry zapytania:

Nazwa Opis Domyślne Wymagana?
monetizationPackageId

Pakiet interfejsu API, którego dotyczy zwrot środków.

 Nie dotyczy Nie
parentTxId

Transakcja zakupu, za którą mają zostać zwrócone środki.

 Nie dotyczy Tak
revenueType

Typ przychodów (GROSS lub NET) z transakcji zakupu.

 Nie dotyczy Tak
refundAmount

Kwota zwrotu środków.

 Nie dotyczy Tak
transactionNote

Notatka tekstowa z wyjaśnieniem przyczyny zwrotu środków.

 Nie dotyczy Tak

Dalsze kroki

Informacje o zadaniach związanych z zarabianiem oraz o zadaniach planowanych automatycznie znajdziesz w artykule Planowanie zadań zarabiania.