Управление балансом предоплаченных счетов

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Для управления балансом на предоплаченном счете вы можете:

• Просмотр текущего баланса предоплаченного счета. См. Просмотр остатков на счетах предоплаты с помощью API .
• Перезагрузите (добавьте деньги) баланс счета по мере необходимости, используя стороннего платежного провайдера, например Worldpay. См. Управление предоплаченными остатками с помощью стороннего поставщика платежей .

  Альтернативно вы можете управлять пополнением счета, отслеживая платежи вручную или через интегрированную систему выставления счетов, а затем вызывая API монетизации для перезагрузки учетной записи, как описано в разделе «Управление предоплаченными остатками вручную» .

• Настройте автоматическое пополнение счета, когда баланс предоплаченного счета падает ниже определенного порога, используя API монетизации и стороннего поставщика платежей, например Worldpay. Эта опция полезна для управления регулярными платежами по тарифным планам. Подробнее см. в разделе Настройка автоматического пополнения предоплаченных остатков на счетах с помощью API .

Как рассчитать остаток предоплаченного счета?

При просмотре баланса предоплаченного счета разработчика или компании, как описано в следующих разделах, вам необходимо получить из ответа следующие значения:

• amount : общая сумма денег, доступная за текущий расчетный период. Это значение обновляется при перезагрузке предоплаченного счета с помощью методов, описанных в этом разделе.
• usage : общая сумма денег, использованная в течение текущего расчетного периода. Это значение обновляется при каждой квалифицированной монетизированной транзакции или при выдаче кредита (положительного или отрицательного).

Вы можете рассчитать оставшийся баланс предоплаченного счета за текущий расчетный период, вычитая стоимость usage из значения amount . Например, если значение amount равно 335,50, а значение usage равно 34, остаток будет рассчитываться следующим образом:

amount(335.50) - usage(34) = 229.50

Просмотр остатков предоплаченных счетов с помощью API

В следующих разделах описывается, как просмотреть баланс предоплаченных счетов разработчика или компании с помощью API.

Просмотр баланса предоплаченных счетов для разработчика

Чтобы просмотреть балансы предоплаченных счетов разработчика, отправьте запрос GET к одному из следующих API, где {developer_id} — это адрес электронной почты разработчика:

• /mint/organizations/{org_name}/developers/{developer_id}/developer-balances : возвращает предоплаченный баланс счета и информацию о повторяющихся настройках для разработчика.
• /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances : возвращает информацию о балансе предоплаченного счета, включая текущий и общий баланс, использование, пополнения и налог за использование.

Вы можете передать следующие параметры запроса для фильтрации результатов:

Например:

$ 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

Ниже приведен пример ответа:

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

Просмотр остатков на предоплаченных счетах компании

Чтобы просмотреть баланс предоплаченных счетов компании, отправьте запрос GET к /mint/organizations/{org_name}/companies/{company_id}/developer-balances , где {company_id} — это идентификатор компании. Если компания имеет предоплату, запрос получает текущий баланс предоплаченного счета. Если компания осуществляет постоплату, запрос получает текущий кредитный лимит.

Вы можете передать следующие параметры запроса для фильтрации результатов:

Например:

$ 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

Ответ аналогичен ответу, показанному выше, при просмотре остатков на предоплаченных счетах разработчика.