Intégrer des remboursements

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Introduction

La monétisation vous permet de publier des remboursements pour les "transactions d'achat" auprès des développeurs. Supposons que vous Vous êtes un opérateur mobile et vous proposez aux développeurs une API de paiement pour facturer les abonnés mobiles l'achat d'une application ou de son contenu. Chaque fois qu'un abonné utilise l'API il s'agit d'une transaction d'achat.

Les transactions d'achat peuvent donner lieu à des remboursements. Par exemple, il se peut que le contenu ne soit pas diffusé, ou si le tiers n'est pas satisfait de votre achat. Dans ce cas, le développeur émet un remboursement au tiers. La monétisation vous permet d'effectuer un remboursement similaire. C'est particulièrement pertinente pour les plans de partage des revenus.

Imaginez que le développeur qui a émis le remboursement à l'abonné mobile ait acheté un revenu pour votre produit API. Supposons que le forfait indique au développeur de recevoir 70 % prix net/brut de la transaction d'achat. En publiant un remboursement, vous annulez transaction d'achat, c'est-à-dire que vous déduisez 70% du paiement dû au développeur pour le mois la date à laquelle le remboursement a été appliqué (le mois peut être différent du mois au cours duquel le une transaction d'achat a eu lieu).

Publier un remboursement à l'aide de l'interface utilisateur Classic Edge (Edge pour Private Cloud uniquement)

Vous pouvez poster un remboursement pour tout problème d'achat, c'est-à-dire que l'API a bien été débité du tiers et pour lesquels vous n'avez pas encore émis de remboursement. La publication d'un remboursement entraîne la création d'une transaction de remboursement avec un parent ID de la transaction, où il correspond à l'ID de la transaction d'achat.

Vous pouvez envoyer un remboursement correspondant au montant total de la transaction initiale ou à une montant partiel. Vous pouvez également publier plusieurs remboursements partiels, mais le montant total des remboursements ne peut pas être supérieur au montant de l'achat initial.

Pour publier un remboursement:

1. Dans l'onglet "Monétisation", sélectionnez "Remboursements".

   

   La page "Remboursements" s'ouvre.

   

2. Dans le menu déroulant "Mois de facturation", sélectionnez le mois au cours duquel la transaction d'achat a été effectuée. s'est déroulée. Cliquez ensuite sur + Remboursements.

   La liste de toutes les transactions d'achat ayant abouti s'affiche. mois.

   

   Vous pouvez filtrer la liste de remboursement par nom de développeur ou en recherchant le nom transaction.

   Pour filtrer par développeur, sélectionnez le développeur dans le menu déroulant "Développeur". Ce affiche une liste des seules transactions liées au développeur sélectionné.

   

   Pour filtrer par ID de transaction, saisissez celui de l'achat d'origine que vous avez que vous souhaitez rembourser. Cette opération renvoie la transaction correspondant à cet ID.

   

3. Cochez la case "Sélectionner" sur les lignes correspondant aux transactions que vous souhaitez rembourser.
4. Sélectionnez Total ou Partielle dans le menu déroulant Type.

   Si vous sélectionnez "Total", le montant total de l'achat vous sera remboursé. Si vous sélectionnez Une partie de votre achat vous sera remboursée en partie.

   Si vous sélectionnez Partiel, saisissez le montant du remboursement partiel dans le champ Montant. Vous pouvez ne rembourser que le montant total de l'achat. Si vous avez déjà publié une partie vous ne pouvez pas saisir un montant inférieur au montant restant pour l'achat. De plus, si le la transaction d'achat d'origine a à la fois des prix bruts et nets, vous devez également indiquer si le montant partiel que vous souhaitez rembourser est brut ou net.

   

5. Cliquez sur Enregistrer pour traiter le remboursement (ou sur Annuler pour annuler).

   Le remboursement apparaît sur le mois de l'achat initial si le mois de facturation est toujours ouvert, sinon le remboursement est indiqué à la date du jour.

   Dans le cas d'un remboursement partiel, il est traité du montant partiel et de toute part des revenus, le cas échéant. est déduite en fonction de la proportion du montant partiel par rapport au montant total. Dans Dans l'exemple de remboursement partiel ci-dessus, le montant partiel est égal à 0,50/1,12 = 45% du prix brut. 45% de la part des revenus du développeur sera déduite.

Vérification dans l'interface utilisateur si un remboursement a été effectué traité

Pour vérifier si un remboursement a été traité, sélectionnez le mois de facturation en haut de la page "Remboursements". Il s'agit du mois de l'achat si le mois de facturation est encore ouvert, ou mois en cours si le mois de facturation est clôturé. La liste de tous les remboursements s'affiche. publiés au cours du mois.

Publier un remboursement à l'aide de l'API

Pour poster un remboursement, envoyez une demande POST à /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, où {package_id} est l'identification du package d'API pour lequel le remboursement s'applique.

Lorsque vous émettez la requête, vous devez les spécifier en tant que paramètres de requête:

• Identifiant de la transaction d'achat remboursée.
• Type de revenus (GROSS ou NET) de la transaction d'achat.
• Montant du remboursement.
• Une note décrivant le motif du remboursement.

Vous pouvez également identifier, en tant que paramètre d'URL, un package d'API auquel le remboursement s'applique.

Consultez Paramètres de configuration du remboursement pour obtenir la liste complète des URL. que vous pouvez spécifier dans une demande de remboursement.

Par exemple, la requête suivante émet un remboursement pour une transaction d'achat. Le remboursement correspond à 50% du montant brut de la transaction d'achat.

$ 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

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "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"
}

Paramètres de configuration des remboursements pour l'API

Les paramètres de requête suivants peuvent être spécifiés dans une demande de remboursement:

Étapes suivantes

Découvrez comment planifier des tâches liées à la monétisation et apprenez-en plus sur celles qui sont planifiées. automatiquement dans Programmer emplois dans le domaine de la monétisation.