Gerenciar saldos pré-pagos da conta

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Para gerenciar o saldo de uma conta pré-paga, você pode:

• Veja o saldo atual da conta pré-paga. Consulte Visualização de anúncios saldos de contas pessoais usando a API.
• Atualizar (adicionar dinheiro) o saldo da conta conforme necessário usando um provedor de pagamento terceirizado. como a Worldpay. Consulte Gerenciar saldos pré-pagos usando terceiros provedor de pagamento.

  Como alternativa, você pode gerenciar a recarga rastreando os pagamentos manualmente ou por meio de um sistema de faturamento integrado e, em seguida, chamar a API de monetização para recarregar a conta, descrito em Gerenciamento manual de saldos pré-pagos.

• Configurar a recarga automática quando o saldo de uma conta pré-paga ficar abaixo de um determinado limite usando a API de monetização e um provedor de pagamento terceirizado, como o Worldpay. Essa opção é úteis para gerenciar pagamentos recorrentes para planos de tarifas. Para mais informações, consulte Como configurar atualização automática de saldos de contas pré-pagas usando a API.

Como calcular o saldo restante da conta pré-paga?

Ao consultar o saldo pré-pago da conta de um desenvolvedor ou empresa, conforme descrito nas seções a seguir, você precisa: extraia os seguintes valores da resposta:

• amount: valor total disponível para o período de faturamento atual. Esse valor é atualizado quando você recarrega a conta pré-paga usando os métodos descritos nesta seção.
• usage: valor total usado durante o período de faturamento atual. Esse valor é atualizado a cada campanha qualificada que gera receita transação ou emitindo um crédito (positivo ou negativo).

Você pode calcular o saldo restante da conta pré-paga do período de faturamento atual subtraindo o valor de usage do amount. Por exemplo, se o valor de amount for 335,50 e o valor de usage for 34, o o saldo restante será calculado da seguinte forma:

amount(335.50) - usage(34) = 229.50

Como visualizar saldos de contas pré-pagas usando a API

As seções a seguir descrevem como consultar os saldos pré-pagos das contas de um desenvolvedor ou empresa que usa a API.

Ver saldos de contas pré-pagas de um desenvolvedor

Para ver os saldos de contas pré-pagas de um desenvolvedor, envie uma solicitação GET para uma das seguintes APIs, em que {developer_id} é o endereço de e-mail do desenvolvedor:

• /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: retorna o saldo da conta pré-paga e as informações de configuração recorrentes de um desenvolvedor.
• /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: retorna informações sobre o saldo pré-pago da conta, incluindo saldo atual e total, uso, recargas e tributos sobre o uso.

É possível transmitir os seguintes parâmetros de consulta para filtrar os resultados:

Exemplo:

$ 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

Veja a seguir um exemplo de resposta:

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

Consultar os saldos pré-pagos das contas de uma empresa

Para visualizar os saldos de contas pré-pagas de uma empresa, emita uma solicitação GET para /mint/organizations/{org_name}/companies/{company_id}/developer-balances, em que {company_id} é o ID da empresa. Se a empresa for pré-paga, a solicitação recupera o saldo atual da conta pré-paga. Se a empresa é pós-paga, a solicitação recupera o limite de crédito atual.

É possível transmitir os seguintes parâmetros de consulta para filtrar os resultados:

Exemplo:

$ 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

A resposta é semelhante à resposta mostrada acima, ao visualizar saldos de contas pré-pagas para um desenvolvedor.