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

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

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

• Просмотрите текущий баланс предоплаченного счета. См. раздел «Просмотр баланса предоплаченных счетов с помощью 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

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