Como emitir créditos

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

A monetização oferece a flexibilidade de emitir crédito para o desenvolvedor.

Para um desenvolvedor com plano pré-pago, um crédito aparece como uma redução no uso. Isso aumenta ou diminui o saldo pré-pago do desenvolvedor. Assim como ao usar um cartão de débito, os fundos são retirados do saldo pré-pago de um desenvolvedor quando ele compra um pacote de produtos de API. O desenvolvedor precisa manter um saldo adequado para compras. Consulte Como calcular o saldo restante da conta pré-paga?

Para um desenvolvedor pós-pago, um crédito aparece como uma linha separada em uma fatura, reduzindo a cobrança em uma fatura.

Como explorar a página "Créditos"

Acesse e confira a página "Créditos", conforme descrito abaixo.

Como emitir um crédito

1. Acesse a página "Créditos".
2. Clique em + Crédito.
3. Digite as seguintes informações:

   Campo	Descrição
   Mês de faturamento	Mês de faturamento ao qual o crédito é aplicado. Selecione um mês na lista.
   Desenvolvedor	Nome do desenvolvedor ou da empresa a que o crédito se aplica. Digite o nome na caixa de texto. Conforme você digita, uma lista dos desenvolvedores/empresas que contêm a string aparece em um menu suspenso. Clique no nome do desenvolvedor ou da empresa na lista suspensa. Observação: depois que você selecionar um desenvolvedor ou uma empresa, os campos restantes serão exibidos. Se você selecionar uma empresa ou um desenvolvedor que não aceitou um plano de tarifas, não será possível emitir um crédito.
   Pacote de produtos	Pacote de produtos de API a que o crédito se aplica. Selecione um dos pacotes de produtos de API disponíveis.
   Produto	Produto de API no pacote de produtos de API selecionado a que o crédito se aplica. Selecione Todos os produtos ou um único produto da API na lista.
   Moeda	Moeda usada para o crédito. A moeda é configurada para o plano de tarifas no pacote de produtos de API que o desenvolvedor comprou e não pode ser alterada. Se houver várias moedas definidas em um plano de preços, você poderá selecionar uma delas.
   Valor	Valor do crédito (na moeda especificada). Especifique um valor positivo ou negativo. O valor não pode ser zero.
   Observação	Observação opcional para descrever o motivo do crédito.

4. Clique em Salvar crédito.

Como emitir créditos usando a API

Usando a API, emita crédito para um desenvolvedor em relação a um pacote de produtos de API como um todo ou em relação ao uso de um produto de API específico em um pacote de produtos de API.

Para emitir um crédito usando a API, envie uma solicitação POST para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, em que {package_id} e {rate-plan_id} definem a identificação do pacote de produtos da API e do plano de preços a que o crédito se aplica, respectivamente.

Ao emitir a solicitação, você precisa especificar como parâmetros de consulta:

• ID do desenvolvedor (endereço de e-mail) a quem o crédito se aplica.
• Valor do crédito.
• Moeda usada para o crédito.
• Observação descrevendo o motivo do crédito.

Também é possível especificar os seguintes parâmetros de consulta adicionais:

• Mês de faturamento a que o crédito se aplica. O padrão é o mês atual.
• Ano de faturamento ao qual o crédito se aplica. Por padrão, esse valor é o ano atual.
• Produto de API a que o crédito se aplica. Se você não especificar um ID de produto de API, o crédito será aplicado a todos os produtos de API no pacote de produtos de API.

Por exemplo, a solicitação a seguir emite um crédito de US $100 para o mês de faturamento de abril de 2018 a um desenvolvedor identificado como dev1@myorg.com. O crédito se aplica ao pacote de produtos da API payment e ao plano de tarifas payment_standard_plan:

Consulte Parâmetros de consulta da API de créditos para conferir uma lista completa dos parâmetros de consulta que podem ser especificados em uma solicitação de crédito.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

Confira a seguir um exemplo de trecho da resposta:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

Parâmetros de consulta para a API créditos

Os parâmetros de consulta a seguir estão disponíveis para uso com a API Credits:

Nome	Descrição	Padrão	Obrigatório?
billingMonth	Mês de faturamento em que o crédito é aplicado, como ABRIL.	N/A	Não
billingYear	Ano de faturamento a que o crédito se aplica, como 2018.	N/A	Não
currencyId	Moeda usada para o crédito. A moeda é configurada para o plano de tarifas no pacote de produtos de API que o desenvolvedor comprou e não pode ser alterada.	N/A	Sim
developerId	Nome do desenvolvedor ou da empresa a que o crédito se aplica.	N/A	Sim
productId	Produto de API a que o crédito se aplica. Se você não especificar um ID do produto, o crédito será aplicado a todos os produtos de API no pacote de produtos de API.	N/A	Não
transactionAmount	Valor do crédito (na moeda especificada). Especifique um valor positivo ou negativo. O valor não pode ser zero.	N/A	Sim
transactionNote	Observação que descreve o motivo do crédito.	N/A	Sim