Wysyłanie zwrotów środków

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

Zarabianie umożliwia wysyłanie deweloperom zwrotów środków za „transakcje zakupu”. Załóżmy, że jesteś operatorem komórkowym i oferujesz deweloperom interfejs API płatności, który umożliwia pobieranie opłat od subskrybentów za zakup aplikacji lub treści w aplikacji. Za każdym razem, gdy subskrybent używa interfejsu API do dokonania zakupu, jest to transakcja zakupu.

Transakcje zakupu mogą skutkować zwrotami środków. Na przykład treści mogą nie zostać dostarczone, lub osoba trzecia może być niezadowolona z zakupu. W takich przypadkach deweloper zwraca środki osobie trzeciej. Zarabianie umożliwia analogiczny zwrot środków. Jest to szczególnie istotne w przypadku planów podziału przychodów.

Wyobraź sobie, że deweloper, który zwrócił środki subskrybentowi, kupił plan podziału przychodów dla Twojej usługi API. Załóżmy, że plan przewiduje, że deweloper otrzyma 70% ceny netto lub brutto transakcji zakupu. Wysyłając zwrot środków, w rzeczywistości cofasz transakcję zakupu, czyli odejmujesz 70% od płatności należnej deweloperowi za miesiąc, w którym zastosowano zwrot środków (miesiąc może być inny niż miesiąc, w którym faktycznie doszło do transakcji zakupu).

Wysyłanie zwrotu środków za pomocą klasycznego interfejsu Edge (tylko Edge for Private Cloud)

Możesz wysłać zwrot środków za każdą "udaną" transakcję zakupu, czyli taką, w której interfejs API pomyślnie obciążył osobę trzecią i za którą nie został jeszcze wysłany pełny zwrot środków. Wysłanie zwrotu środków powoduje utworzenie transakcji zwrotu z identyfikatorem transakcji nadrzędnej, gdzie identyfikator transakcji jest identyfikatorem transakcji zakupu.

Możesz wysłać zwrot środków w pełnej kwocie pierwotnej transakcji zakupu lub w kwocie częściowej. Możesz też wysłać kilka częściowych zwrotów środków, ale łączna kwota zwrotów nie może przekraczać pierwotnej kwoty płatności.

Aby wysłać zwrot środków:

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

   

   Otworzy się strona Zwroty środków.

   

2. W menu Miesiąc rozliczeniowy wybierz miesiąc, w którym doszło do transakcji 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 dewelopera z menu Deweloper. Wyświetli się lista tylko tych transakcji, które dotyczą wybranego dewelopera.

   

   Aby filtrować według identyfikatora transakcji, wpisz identyfikator transakcji pierwotnego zakupu, za który chcesz zwrócić środki. Zostanie zwrócona transakcja o tym identyfikatorze.

   

3. Zaznacz pole Wybierz w wierszach transakcji, za które chcesz zwrócić środki.
4. W menu Typ wybierz Całkowity lub Częściowy.

   Jeśli wybierzesz Całkowity, zostanie zwrócona cała kwota zakupu. Jeśli wybierzesz Częściowy, zostanie zwrócona częściowa kwota zakupu.

   Jeśli wybierzesz Częściowy, w polu Kwota wpisz kwotę częściowego zwrotu środków. Możesz zwrócić tylko kwotę nie większą niż łączna kwota zakupu. Jeśli masz już częściowy zwrot środków, możesz wpisać tylko kwotę nie większą niż pozostała kwota zakupu. Jeśli pierwotna transakcja zakupu ma zarówno cenę brutto, jak i netto, musisz też określić, czy częściowa kwota, którą chcesz zwrócić, jest kwotą brutto czy netto.

   

5. Aby przetworzyć zwrot środków, kliknij Zapisz (lub Anuluj, aby anulować).

   Zwrot środków zostanie wysłany w miesiącu pierwotnego zakupu, jeśli miesiąc rozliczeniowy jest nadal otwarty. W przeciwnym razie zwrot środków zostanie wysłany w bieżącym dniu.

   W przypadku częściowego zwrotu środków zwrot jest przetwarzany w kwocie częściowej, a wszelkie udziały w przychodach są odejmowane na podstawie proporcji kwoty częściowej do kwoty pełnej. W powyższym przykładzie częściowego zwrotu środków kwota częściowa wynosi 0,50/1,12 = 45% ceny brutto, więc zostanie odjęte 45% udziału dewelopera w przychodach.

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

Aby sprawdzić, czy zwrot środków został przetworzony, wybierz miesiąc rozliczeniowy u góry strony Zwroty środków. Jeśli miesiąc rozliczeniowy jest nadal otwarty, jest to miesiąc zakupu, a jeśli jest zamknięty – bieżący miesiąc. Wyświetli się lista wszystkich zwrotów środków, które zostały wysłane w danym miesiącu.

Wysyłanie zwrotu środków za pomocą interfejsu API

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

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

• Identyfikator transakcji zakupu, za którą zwracasz środki.
• Typ przychodów (GROSS lub NET) transakcji zakupu.
• Kwota zwrotu środków.
• Notatka opisująca powód zwrotu środków.

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

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

Na przykład to żądanie wysyła zwrot środków za transakcję zakupu. Kwota zwrotu środków wynosi 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 (pokazana jest 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 zwrotu środków w interfejsie API

W żądaniu zwrotu środków można określić te parametry zapytania:

Dalsze kroki

Dowiedz się, jak planować zadania związane z zarabianiem, oraz o zadaniach, które są planowane automatycznie, w artykule Planowanie zadań związanych z zarabianiem.