Estás viendo la documentación de Apigee Edge.
Ir a la
documentación de Apigee X. info
Introducción
La monetización te permite publicar reembolsos a los desarrolladores por "transacciones de compra". Supongamos que eres un operador de telefonía móvil y les ofreces a los desarrolladores una API de pagos para cobrarles a los suscriptores de dispositivos móviles 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, se trata de una transacción de compra.
Las transacciones de compra pueden generar reembolsos. Por ejemplo, es posible que no se entregue el contenido, o que el tercero no esté satisfecho 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 reparto 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 o bruto de la transacción de compra. Cuando publicas un reembolso, reviertes la transacción de compra, es decir, deduces el 70% del pago que se le debe al desarrollador por el mes en que se aplicó el reembolso (el mes puede ser diferente del mes en el que se produjo la transacción de compra real ).
Cómo publicar un reembolso con la IU clásica de Edge (solo Edge para nube privada)
Puedes publicar un reembolso por cualquier transacción de compra "exitosa", es decir, en la que la API le cobró correctamente al tercero y para la que aún no emitiste un reembolso total. La publicación de un reembolso genera la creación de una transacción de reembolso con un ID de transacción superior, en la 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 superior al importe de la compra original.
Para publicar un reembolso, haz lo siguiente:
- En la pestaña Monetización, selecciona Reembolsos.

Se abrirá la página Reembolsos.

- En el menú desplegable Mes de facturación, selecciona el mes en el que se realizó la transacción de compra
tuvo lugar. Luego, haz clic en + Reembolsos.
Se mostrará una lista de todas las transacciones de compra exitosas del mes seleccionado.

Puedes filtrar la lista de reembolsos por nombre del desarrollador o buscando la transacción real.
Para filtrar por desarrollador, selecciona el desarrollador en el menú desplegable Desarrollador. Se mostrará una lista de solo 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 deseas reembolsar. Se mostrará la transacción para ese ID.

- Marca la casilla Seleccionar en las filas de las transacciones que deseas reembolsar.
- Selecciona Total o Parcial en el menú desplegable Tipo.
Si seleccionas Total, se reembolsará el importe total de la compra. Si seleccionas Parcial, se reembolsará un importe parcial de la compra.
Si seleccionas Parcial, ingresa el importe del reembolso parcial en el campo Importe. Solo puedes reembolsar hasta el importe total de la compra. Si ya publicaste un reembolso parcial reembolso, solo puedes ingresar un importe hasta el importe restante de 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.

- 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 aún está 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 se deduce cualquier reparto de ingresos en función de 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.
Cómo 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 aún está abierto o el mes actual si el mes de facturación está cerrado. Se mostrará una lista de todos los reembolsos que se publicaron en el mes.
Cómo publicar un reembolso con la API
Para publicar un reembolso, envía una solicitud POST a
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions,
donde {package_id} es la identificación del paquete de API al que se aplica el reembolso.
Cuando envíes la solicitud, deberás especificar lo siguiente como parámetros de consulta:
- La identificación de la transacción de compra que se reembolsa
- El tipo de ingresos (
GROSSoNET) de la transacción de compra - 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 Opciones de configuración de reembolsos para la API 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 es el 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 verse de la siguiente manera (solo se muestra una parte de la respuesta):
{ "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" }
Opciones de configuración de reembolsos para la API
En una solicitud de reembolso, se pueden especificar los siguientes parámetros de consulta:
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
monetizationPackageId |
El paquete de API al que se aplica el reembolso |
N/A | No |
parentTxId |
La transacción de compra que se reembolsará |
N/A | Sí |
revenueType |
El tipo de ingresos ( |
N/A | Sí |
refundAmount |
El importe del reembolso |
N/A | Sí |
transactionNote |
Una nota de texto que describe el motivo del reembolso |
N/A | Sí |
Próximos pasos
Obtén información para programar trabajos relacionados con la monetización y sobre los trabajos que se programan automáticamente en Programa trabajos de monetización.