Administra los saldos de cuenta prepagas

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Para administrar el saldo en una cuenta prepagada, puedes hacer lo siguiente:

• Consulta el saldo de cuenta prepaga actual. Consulta Cómo ver los pagos prepagos de cuentas con la API.
• Volver a cargar (agregar dinero) al saldo de cuenta según sea necesario a través de un proveedor de pagos externo como Worldpay. Consulte Cómo administrar saldos prepagados a través de un tercero proveedor de pagos.

  Como alternativa, puedes administrar la recarga haciendo un seguimiento de los pagos de forma manual o a través de un sistema de facturación integrado y, luego, llama a la API de Monetización para que vuelva a cargar la cuenta. que se describe en el artículo Cómo administrar saldos prepagados de forma manual.

• Configura la recarga automática cuando el saldo prepagado de la cuenta sea inferior a un límite determinado mediante la API de Monetización y un proveedor de pagos externo, como Worldpay. Esta opción es útil para administrar pagos recurrentes de planes de tarifas. Para obtener más información, consulta Configuración recarga automática de saldos de cuentas prepagados con la API

¿Cómo calculo el saldo prepagado restante de la cuenta?

Cuando veas el saldo prepagado de la cuenta de un desarrollador o una empresa, como se describe en las siguientes secciones, debes hacer lo siguiente: obtén los siguientes valores de la respuesta:

• amount: Es el importe total de dinero disponible para el período de facturación actual. Este valor se actualiza cuando vuelves a cargar la página la cuenta prepagada con los métodos que se describen en esta sección.
• usage: Es el importe total de dinero que se usó durante el período de facturación actual. Este valor se actualiza cada vez que se cumple con los requisitos transacción o la emisión de un crédito (positivo o negativo).

Puedes calcular el saldo prepagado restante de la cuenta para el período de facturación actual restando el valor de usage del Valor amount. Por ejemplo, si el valor amount es 335.50 y el valor usage es 34, la el saldo restante se calcularía de la siguiente manera:

amount(335.50) - usage(34) = 229.50

Cómo consultar los saldos de cuentas prepagados con la API

En las siguientes secciones, se describe cómo ver los saldos de cuenta prepagados de un desarrollador o empresa que usa la API.

Cómo ver los saldos prepagados de las cuentas de un desarrollador

Para ver los saldos de cuentas prepagados de un desarrollador, envía una solicitud GET a una de las siguientes APIs, en la que {developer_id} es la dirección de correo electrónico del desarrollador:

• /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: Devuelve el saldo prepagado de la cuenta y la información de configuración recurrente de un desarrollador.
• /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: Devuelve información del saldo de la cuenta prepaga, lo que incluye el saldo actual y total, el uso, las recargas y el impuesto sobre el uso.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Por ejemplo:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
    "developerBalance": [
        {
            "amount": 2005,
            "chargePerUsage": false,
            "id": "your-provider-id",
            "isRecurring": false,
            "supportedCurrency": {
                "description": "United States Dollars",
                "displayName": "United States Dollars",
                "id": "usd",
                "name": "USD",
                "organization": {
                    "address": [
                        {
                            "address1": "10 Almaden Blvd.",
                            "city": "San Jose",
                            "country": "US",
                            "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61",
                            "isPrimary": true,
                            "state": "CA",
                            "zip": "95113"
                        }
                    ],
                    "approveTrusted": false,
                    "approveUntrusted": false,
                    "billingCycle": "CALENDAR_MONTH",
                    "country": "US",
                    "currency": "USD",
                    "description": "my-org",
                    "groupOrganization": false,
                    "hasBillingAdjustment": false,
                    "hasBroker": false,
                    "hasSelfBilling": false,
                    "hasSeparateInvoiceForProduct": false,
                    "id": "my-org",
                    "issueNettingStmt": false,
                    "name": "my-org",
                    "nettingStmtPerCurrency": false,
                    "selfBillingAsExchOrg": false,
                    "selfBillingForAllDev": false,
                    "separateInvoiceForFees": false,
                    "status": "ACTIVE",
                    "supportedBillingType": "BOTH",
                    "taxModel": "HYBRID",
                    "timezone": "UTC"
                },
                "status": "ACTIVE",
                "virtualCurrency": false
            },
            "usage": 2.1572
        }
    ],
    "totalRecords": 1
}

Cómo ver los saldos de cuenta prepagados de una empresa

Para ver los saldos de cuenta prepagados de una empresa, envía una solicitud GET a /mint/organizations/{org_name}/companies/{company_id}/developer-balances, donde {company_id} es el ID de la empresa. Si la empresa tiene un plan prepagado, la solicitud Recupera el saldo de cuenta prepaga actual. Si la empresa es de pospago, la solicitud recupera límite de crédito actual.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Por ejemplo:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

La respuesta es similar a la que se muestra arriba, cuando se consultan los saldos de cuenta prepagados de desarrollador.