Reembolsos posteriores

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Introducción

La monetización te permite publicar reembolsos para los desarrolladores por "transacciones de compra". Supongamos que eres un operador de telefonía celular y les ofreces a los desarrolladores una API de pago para cobrar a los suscriptores de dispositivos móviles por la compra de una aplicación o contenido dentro de la aplicación. Cada vez que un suscriptor usa la API para realizar una compra, es una transacción de compra.

Las transacciones de compra pueden generar reembolsos. Por ejemplo, es posible que el contenido no se entregue o que el tercero no esté conforme con la compra. En esos casos, el desarrollador emite un reembolso al tercero. La monetización te permite realizar un reembolso análogo. Esto es especialmente pertinente para los planes de porcentaje de ingresos.

Imagina que el desarrollador que emitió el reembolso al suscriptor de dispositivos móviles compró un plan de reparto de ingresos para tu producto de API. Supongamos que el plan requiere que el desarrollador reciba el 70% del precio neto/bruto de la transacción de compra. Cuando publicas un reembolso, en efecto, reviertes la transacción de compra, es decir, deduces el 70% del pago adeudado al desarrollador correspondiente al mes en el que se aplicó el reembolso (el mes puede ser diferente del mes en el que se realizó la transacción de compra real).

Publica un reembolso mediante la IU de Edge clásica (solo Edge para la nube privada)

Puedes publicar un reembolso por cualquier transacción de compra "realizada", es decir, en la que la API le cobró correctamente al tercero y por la que aún no emitiste un reembolso total. Cuando se publica un reembolso, se crea una transacción de reembolso con un ID de transacción principal, en el que el ID de transacción es el ID de la transacción de compra.

Puedes publicar un reembolso por el importe total de la transacción de compra original o por un importe parcial. También puedes publicar varios reembolsos parciales, pero el importe total de los reembolsos no puede ser mayor que el importe de la compra original.

Para publicar un reembolso:

  1. En la pestaña Monetización, selecciona Reembolsos.

    Se abrirá la página Reembolsos.

  2. En el menú desplegable Mes de facturación, selecciona el mes en el que se realizó la transacción de compra. Luego, haz clic en + Reembolsos.

    Allí, podrás ver una lista de todas las transacciones de compra que se realizaron correctamente en el mes seleccionado.

    Puedes filtrar la lista de reembolsos por nombre de desarrollador o buscar la transacción real.

    Para filtrar por desarrollador, selecciona el desarrollador en el menú desplegable Desarrollador. Aquí se muestra una lista solo de las transacciones relacionadas con el desarrollador seleccionado.

    Para filtrar por ID de transacción, ingresa el ID de transacción de la compra original que quieres reembolsar. Se mostrará la transacción para ese ID.

  3. Marca la casilla Seleccionar en las filas de las transacciones que deseas reembolsar.
  4. En el menú desplegable Tipo, seleccione Total o Parcial.

    Si seleccionas Total, se reembolsará el importe total de la compra. Si seleccionas Parcial, se reembolsará una parte del importe de la compra.

    Si seleccionas Parcial, ingresa el importe del reembolso parcial en el campo Importe. Solo se puede reembolsar el importe total de la compra. Si ya publicaste un reembolso parcial, solo puedes ingresar un importe que no supere el importe restante en la compra. Además, si la transacción de compra original tiene precios brutos y netos, también deberás indicar si el importe parcial que deseas reembolsar es bruto o neto.

  5. Haz clic en Guardar para procesar el reembolso (o en Cancelar para cancelar).

    El reembolso se publica en el mes de la compra original si el mes de facturación sigue abierto. De lo contrario, se publica en la fecha actual.

    En el caso de un reembolso parcial, el reembolso se procesa por el importe parcial y cualquier porcentaje de ingresos se deduce según la proporción del importe parcial sobre el importe total. En el ejemplo de reembolso parcial anterior, el importe parcial es 0.50/1.12 = 45% del precio bruto, por lo que se deducirá el 45% del reparto de ingresos del desarrollador.

Verificar en la IU si se procesó un reembolso

Para determinar si se procesó un reembolso, selecciona el mes de facturación en la parte superior de la página Reembolsos. Este es el mes de la compra si el mes de facturación sigue abierto, o el mes actual si el mes de facturación está cerrado. Aquí se muestra una lista de todos los reembolsos que se publicaron en el mes.

Cómo publicar un reembolso a través de la API

Para publicar un reembolso, emite una solicitud POST a /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, en la que {package_id} es la identificación del paquete de API al que se aplica el reembolso.

Cuando emites la solicitud, debes especificar como parámetros de consulta:

  • Es la identificación de la transacción de compra que se reembolsará.
  • Indica el tipo de ingresos (GROSS o NET) de la transacción de compra.
  • Indica el importe del reembolso.
  • Una nota que describa el motivo del reembolso

De manera opcional, puedes identificar como parámetro de URL un paquete de API al que se aplica el reembolso.

Consulta Configuración de reembolso para obtener una lista completa de los parámetros de URL que puedes especificar en una solicitud de reembolso.

Por ejemplo, la siguiente solicitud emite un reembolso por una transacción de compra. El importe del reembolso corresponde al 50% del importe bruto de la transacción de compra.

$ 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 respuesta debería ser similar a la siguiente (solo se muestra una parte):

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

Configuración de reembolsos para la API

Los siguientes parámetros de consulta se pueden especificar en una solicitud de reembolso:

Nombre Descripción Predeterminada ¿Obligatorio?
monetizationPackageId

Indica el paquete de API al que se aplica el reembolso.

No disponible No
parentTxId

Es la transacción de compra que se reembolsará.

No disponible
revenueType

Indica el tipo de ingresos (GROSS o NET) de la transacción de compra.

No disponible
refundAmount

Es el importe del reembolso.

No disponible
transactionNote

Una nota de texto que describe el motivo del reembolso.

No disponible

Próximos pasos

Obtén información sobre cómo programar trabajos relacionados con la monetización y sobre los trabajos que se programan automáticamente en Programa trabajos de monetización.