Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Para gerenciar o saldo de uma conta pré-paga, você pode:
- Confira o saldo pré-pago atual da conta. Consulte Como visualizar saldos pré-pagos de contas usando a API.
- Atualize (adicione dinheiro) ao saldo da conta conforme necessário, usando um provedor de pagamento terceirizado,
como o Worldpay. Consulte Como gerenciar saldos pré-pagos usando um provedor
de pagamento terceirizado.
Como alternativa, é possível gerenciar a recarga rastreando os pagamentos manualmente ou por um sistema de faturamento integrado e, em seguida, chamando a API de monetização para recarregar a conta, conforme descrito em Como gerenciar saldos pré-pagos manualmente.
- Configure 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 é útil para gerenciar pagamentos recorrentes de planos de tarifas. Para mais informações, consulte Como configurar o recarregamento automático de saldos de contas pré-pagas usando a API.
Como calcular o saldo restante da conta pré-paga?
Ao consultar o saldo da conta pré-paga de um desenvolvedor ou empresa, conforme descrito nas seções a seguir, você precisa extrair 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 com cada transação monetizada qualificada ou com a emissão de um crédito (positivo ou negativo).
É possível calcular
o saldo restante da conta pré-paga para o período de faturamento atual subtraindo o valor usage
do
valor amount
. Por exemplo, se o valor de amount
for 335,50 e o valor de usage
for 34, 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 de contas pré-pagas de um desenvolvedor ou empresa que usam a API.
Como ver os saldos de contas pré-pagas de um desenvolvedor
Para consultar o saldo de contas pré-pagas de um desenvolvedor, emita 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 pré-pago da conta e as informações de configuração recorrentes de um desenvolvedor./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances
: retorna informações pré-pagas sobre o saldo da conta, incluindo saldo atual e total, uso, recargas e tributos sobre uso.
É possível passar os seguintes parâmetros de consulta para filtrar os resultados:
Parâmetro de consulta | Descrição |
---|---|
all |
Sinalização que especifica se todos os pacotes de API precisam ser retornados. Se definido como false, o número de pacotes de API retornados por página será definido pelo parâmetro de consulta size . O padrão é false. |
size |
Número de pacotes de API retornados por página. O padrão é 20. Se o parâmetro de consulta all for definido como true , ele será ignorado. |
page |
Número da página que você quer retornar (se o conteúdo for paginado). Se o parâmetro de consulta all estiver definido como true , ele será ignorado. |
currencyId |
ID da moeda dos saldos pré-pagos da conta que você quer conferir. |
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 }
Como visualizar os saldos de contas pré-pagas de uma empresa
Para consultar os saldos pré-pagos das contas de uma empresa, envie 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 pré-pago atual da conta. Se a empresa for pós-paga, a solicitação recuperará
o limite de crédito atual.
É possível passar os seguintes parâmetros de consulta para filtrar os resultados:
Parâmetro de consulta | Descrição |
---|---|
all |
Sinalização que especifica se todos os pacotes de API precisam ser retornados. Se definido como false, o número de pacotes de API retornados por página será definido pelo parâmetro de consulta size . O padrão é false. |
size |
Número de pacotes de API retornados por página. O padrão é 20. Se o parâmetro de consulta all for definido como true , ele será ignorado. |
page |
Número da página que você quer retornar (se o conteúdo for paginado). Se o parâmetro de consulta all estiver definido como true , ele será ignorado. |
currencyId |
ID da moeda dos saldos pré-pagos da conta que você quer conferir. |
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 à mostrada acima ao visualizar os saldos de contas pré-pagas de um desenvolvedor.
Como gerenciar saldos de contas pré-pagas usando um provedor de pagamento
Gerencie saldos de contas pré-pagas configurando uma conta do comerciante com um provedor de pagamento de terceiros, como o Worldpay. A figura a seguir mostra como o saldo da conta pré-paga é gerenciado usando o provedor de pagamento Worldpay.
A tabela a seguir descreve cada etapa do fluxo de gerenciamento do saldo pré-pago da conta, mostrado acima.
Step | Descrição |
---|---|
0 |
Etapas de pré-requisito Como provedor de API, para configurar um provedor de pagamento terceirizado, como o Worldpay, é preciso fazer o seguinte: |
1 |
Para acionar o fluxo, um consumidor de API executa uma das seguintes tarefas no portal
do desenvolvedor:
|
2 | O portal do desenvolvedor inicia o pagamento pelo Edge para o desenvolvedor, com o ID do provedor, o valor da recarga e a moeda. Para mais informações sobre como usar a API para iniciar um pagamento, consulte Como iniciar um pagamento para uma conta pré-paga usando um provedor de pagamento. |
3 | O Edge encontra o provedor por ID e determina que se trata de uma conta do WorldPay. |
4 | O Edge gera um código de pedido. |
5 | O Edge cria a ordem de pagamento no WorldPay. |
6 | O Worldpay retorna um ID de referência para o pedido e um URL por tempo limitado para atendimento. |
7 |
A resposta do Worldpay é convertida em uma resposta genérica da API Edge /payment, que
é retornada ao portal do desenvolvedor para concluir a chamada iniciada na etapa 2. Por
exemplo:
{ "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" } |
8 | O portal do desenvolvedor anexa URLs de callback (para sucesso, falha e assim por diante) como parâmetros de consulta ao URL. |
9 | O portal do desenvolvedor responde à solicitação na etapa 1 redirecionando o navegador do consumidor da API para o URL modificado. |
10 | O consumidor da API preenche o formulário de inscrição e inicia o processamento com o Worldpay. |
11 | O WorldPay captura informações de faturamento e processa o pagamento. Se for bem-sucedido, o Worldpay gera um código de autenticação de mensagem (MAC, na sigla em inglês) usando o secret MAC configurado no Worldpay e no portal do desenvolvedor. |
12 | O Worldpay redireciona o navegador do consumidor da API para o URL de callback bem-sucedido (da etapa 8), anexando o MAC como um parâmetro de consulta e o valor. |
13 | O navegador chama o URL no portal do desenvolvedor com a quantidade e o MAC solicitados. |
14 | O portal verifica o MAC em relação ao secret dele. O MAC impede que uma pessoa declare arbitrariamente que pagamentos bem-sucedidos foram feitos. |
15 | O portal do desenvolvedor envia uma solicitação ao Edge para recarregar o saldo pré-pago da conta. Para informações sobre como usar a API para recarregar o saldo da conta, consulte Como recarregar um saldo pré-pago usando a API. |
As seções a seguir descrevem as etapas necessárias para gerenciar saldos pré-pagos usando um provedor de pagamento terceirizado:
- Como configurar uma conta de comerciante com o provedor de pagamento do Worldpay
- Como configurar o provedor de pagamento no Edge
- Como ver os provedores de pagamento configurados para sua organização
- Como ativar e configurar os módulos necessários no portal do desenvolvedor
- Iniciar o pagamento para uma conta pré-paga usando um provedor de pagamento
- Como atualizar o saldo de uma conta pré-paga usando a API
- Como excluir um provedor de pagamento terceirizado
Como configurar uma conta de comerciante com o provedor de pagamento do Worldpay
Antes de começar, entre em contato com um provedor de pagamento de terceiros (Worldpay) para configurar suas contas de comerciante. Recomendamos que você configure duas contas, uma para teste e outra para produção. Para mais informações sobre as contas do comerciante do Worldpay, acesse www.worldpay.com e wp-support.crm.worldpay.com (central de suporte do Worldpay).
Depois de configurar sua conta de comerciante e receber as credenciais, para configurar sua conta de comerciante com o Worldpay:
- Acesse https://secure.worldpay.com/sso/public/auth/login.html.
- Faça login na sua conta do Worldpay com as credenciais fornecidas a você pela Worldpay.
- Defina a senha do XML e a chave secreta do código de autenticação de mensagem (MAC):
- Clique em Perfil.
- Defina a senha a ser usada ao configurar o provedor de pagamento do Worldpay no Edge no campo XML Password.
- Insira uma chave secreta MAC de 20 a 30 caracteres no campo Chave secreta MAC de redirecionamento.
- Clique em Salvar perfil.
- Adicione o servidor de gerenciamento do Apigee Edge à lista de IPs de comerciantes (lista de permissões):
- Clique em Perfil > Ambiente do comerciante.
- Clique em Novo IP de teste.
- Digite o IP do servidor de gerenciamento do Apigee Edge.
- Clique em Salvar.
- Configure o URL do comerciante para anexar os parâmetros do Worldpay, incluindo o código
de autenticação do método (MAC):
- Clique em Instalações > Páginas de pagamento hospedadas > Designer da página de pagamento.
- Em Editar páginas de pagamento, selecione seu ID de instalação na lista suspensa Selecionar canal.
- Na guia "Propriedades", selecione Editar configuração do comerciante.
- Defina o valor "Enviar parâmetros do URL" como Verdadeiro.
- Clique na guia Publicar.
- Promova mudanças da seguinte maneira:
- Para ambientes de teste, clique em Promover em Design para promover de Design para sandbox.
- Para ambientes de produção, clique em Promover em Sandbox para promover do sandbox para a produção.
Como configurar o provedor de pagamento no Edge
A próxima etapa é configurar o provedor de pagamento no Edge.
É possível configurar seu provedor de pagamento para uma organização específica usando a seguinte API:
/organizations/{org-name}/providers
Apenas clientes de nuvem privada do Apigee Edge com privilégios de administrador de sistema podem configurar um provedor de pagamento global usando a seguinte API:
/config/providers
Ao chamar cada API, especifique as seguintes informações no corpo da solicitação:
Parâmetro | Descrição | Obrigatório |
authType |
ID de instalação fornecido pelo provedor de pagamento. | Sim |
credential |
Credenciais codificadas em Base64 (username:XMLpassword ) para sua conta do comerciante do Worldpay.
username é equivalente ao código do comerciante (em letras maiúsculas)
e XMLpassword especifica a senha XML que você definiu na etapa anterior, ao
configurar sua conta de comerciante do Worldpay. |
Sim |
description |
Descrição do provedor de pagamento. | Não |
endpoint |
Endpoint para acessar o provedor de pagamento
|
Sim |
merchantCode |
Código do comerciante fornecido pelo provedor de pagamento ao consumidor da API | Sim |
name |
Nome a ser usado para o provedor.
Apenas clientes do Apigee Edge Private Cloud: para provedores de pagamento globais, verifique se o nome é exclusivo em todas as organizações de Edge. É
recomendável incluir WorldPay (sem diferenciação de maiúsculas e minúsculas) no nome do provedor para facilitar
a identificação. Por exemplo: |
Sim |
Por exemplo, a configuração a seguir configura uma conta de comerciante no Worldpay chamada Worldpay-myorg:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Worldpay-myorg", "description": "Worldpay payment provider", "endpoint": "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp", "authType": "123456", "credential": "dXNlcm5hbWU6cGFzc3dvcmQ=", "merchantCode": "myMerchantCode" }' \ "https://api.enterprise.apigee.com/v1/organizations/myOrg/providers" \ -u email:password
Como visualizar provedores de pagamento de terceiros
Confira e confirme os provedores de pagamento de terceiros configurados para sua organização de Edge enviando uma solicitação GET para o seguinte recurso:
/mint/organizations/{org-name}/providers
Por exemplo, a imagem abaixo mostra os provedores de pagamento terceirizados configurados atualmente para
myorg
:
$ curl -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \ -u email:password
Confira a seguir um exemplo da resposta que mostra duas contas de comerciantes, uma para teste e outra para produção.
{ "provider" : [ { "authType" : "123456", "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=", "description" : "Worldpay payment provider", "endpoint" : "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp", "id" : "worldpay-myorg", "merchantCode" : "MERCH_CODE", "name" : "Worldpay-myorg" }, { "authType" : "123456", "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=", "description" : "Worldpay payment provider", "endpoint" : "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp", "id" : "worldpay-test", "merchantCode" : "MERCH_CODE_FROM_PROVIDER", "name" : "Worldpay-test" } ] }
Ativar e configurar os módulos de monetização e do Worldpay no portal do desenvolvedor
Ative os módulos de monetização e Worldpay necessários no portal do desenvolvedor. Para saber mais detalhes, consulte Configurar monetização no portal do desenvolvedor.
Iniciar o pagamento para uma conta pré-paga usando o provedor de pagamento
Conforme mostrado na etapa 2 do fluxo de gerenciamento de contas pré-pagas, o pagamento para uma conta pré-paga usando um provedor de pagamento é iniciado pelo portal do desenvolvedor quando os consumidores da API:
- Aceitaram um plano de tarifas, mas não têm fundos suficientes na conta pré-paga.
- Pedir para adicionar dinheiro à conta pré-paga.
Para iniciar um pagamento de um provedor de pagamento de terceiros usando a API, emita uma solicitação POST
para o recurso a seguir, em que {developer_id}
é o endereço de e-mail do desenvolvedor.
/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}
Ao emitir a solicitação, é necessário especificar os seguintes valores como parâmetros de consulta:
- Valor a ser adicionado ao saldo pré-pago da conta (
amount={amount}
) - ID do provedor de pagamento (
provider={providerId}
) - Moeda aceita (
supportedCurrencyId={currency}
)
Além disso, é necessário passar detalhes básicos da conta, como o endereço de faturamento da empresa.
Por exemplo, o código a seguir recarrega o saldo de uma conta pré-paga usando o provedor de pagamento
Worldpay. A transferência inicial para sua conta pré-paga será de 10 dólares americanos (o parâmetro de consulta amount
está definido como 10
).
$ curl -H "Content-Type:application/xml" -X POST -d \ '{ "address1": "5115 Hopyard Ave.", "city": "Pleasanton", "country": "US", "state": "CA", "zip": "58158" }' ' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/payment?amount=10&provider=worldpay-myorg&supportedCurrencyId=usd" \ -u email:password
Veja a seguir um exemplo de resposta:
{ "isRecurring": "false", "orderCode": "1234", "referenceId": "3042815493", "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234", "success": "true" }
O URL para a página de pagamento seguro do Worldpay é retornado em referenceUrl
com sua
chave de pedido exclusiva anexada como parâmetro de consulta.
Como recarregar um saldo de conta pré-pago usando a API
Conforme mostrado na etapa 15 do fluxo de gerenciamento de contas pré-pagas, depois de verificar o processamento bem-sucedido pelo provedor de pagamento, o portal do desenvolvedor envia uma solicitação ao Edge para recarregar a conta pré-paga.
Você pode recarregar o saldo pré-pago da conta usando a API para um desenvolvedor ou empresa, conforme descrito nas seções a seguir.
Como recarregar o saldo de uma conta pré-paga de um desenvolvedor
Para recarregar o saldo de uma conta pré-paga de um desenvolvedor usando a API, emita uma solicitação POST para
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances
, em que
{developer_id}
é o endereço de e-mail do desenvolvedor. Ao emitir a solicitação, você precisa especificar no corpo da solicitação o valor a ser adicionado ao saldo e a moeda usada.
Por exemplo, a solicitação a seguir adiciona US $1.000 ao saldo pré-pago da conta de um desenvolvedor:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "amount": 1000, "supportedCurrency": { "id": "usd" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \ -u email:password
Para uma descrição das propriedades da solicitação, consulte Resumo das propriedades da solicitação para recarregar uma conta pré-paga.
Como recarregar o saldo de uma conta pré-paga de uma empresa
Para recarregar o saldo de uma conta pré-paga de uma empresa usando a API, emita uma solicitação POST para
/mint/organizations/{org_name}/companies/{company_id}/developer-balances
, em que
{company_id}
é o ID da empresa. Ao emitir a solicitação, você precisa especificar no corpo da solicitação o valor a ser adicionado ao saldo e a moeda usada.
Por exemplo, a solicitação a seguir adiciona US $1.000 ao saldo pré-pago da conta de uma empresa:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "amount": 1000, "supportedCurrency": { "id": "usd" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \ -u email:password
Para uma descrição das propriedades da solicitação, consulte Resumo das propriedades da solicitação para recarregar uma conta pré-paga.
Resumo das propriedades da solicitação para recarregar uma conta pré-paga
As seguintes propriedades precisam ser especificadas ao recarregar saldos de contas pré-pagas usando a API:
Nome | Descrição | Padrão | Obrigatório? |
---|---|---|---|
amount |
Valor aplicado ao saldo pré-pago (na moeda aplicável). |
N/A | Sim |
supportedCurrency |
Moeda usada para o saldo pré-pago. Esta é a moeda que foi configurada para o plano no pacote de API que o desenvolvedor comprou. |
N/A | Sim |
Como excluir provedores de pagamento terceirizados
É possível excluir um provedor de pagamento de terceiros configurado para sua organização de Edge emitindo uma solicitação DELETE para o seguinte recurso:
Para excluir um provedor de pagamento de uma organização específica, use a seguinte API:
/mint/organizations/{org-name}/providers/id
Apenas os clientes da nuvem privada do Apigee Edge com privilégios de administrador do sys podem excluir um provedor de pagamento global usando a seguinte API:
/config/providers/id
Por exemplo, a operação a seguir exclui os provedores de pagamento terceirizados configurados atualmente para myorg:
$ curl -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \ -u email:password
Como gerenciar manualmente saldos de contas pré-pagas
Como alternativa, é possível gerenciar o recarregamento de saldos pré-pagos rastreando os pagamentos manualmente ou por um sistema de faturamento integrado e chamando a API de monetização para recarregar a conta, conforme descrito em Como recarregar um saldo de conta pré-pago usando a API.
Configurar a atualização automática de saldos de contas pré-pagas usando a API
As seções a seguir descrevem como configurar a recarga automática de saldos de contas pré-pagas para um desenvolvedor ou empresa que usa um provedor de pagamento terceirizado. Essa opção é útil para gerenciar pagamentos recorrentes de planos de tarifas.
Configurar a atualização automática de saldos de contas pré-pagas de um desenvolvedor
Para configurar a atualização automática do saldo de uma conta pré-paga para um desenvolvedor quando o saldo ficar
abaixo de um determinado limite, emita uma solicitação POST para
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup
,
em que {developer_id
} é o endereço de e-mail do desenvolvedor.
Ao emitir a solicitação, é necessário especificar o seguinte:
- ID do provedor de pagamento a ser usado para recarregar a conta (
providerID
) - Sinalização que ativa a atualização automática (
isRecurring
) - Limite em que o saldo da conta pré-paga precisa ficar abaixo de para acionar a recarga
automática (
replenishAmount
) - Valor a ser adicionado automaticamente à conta (
recurringAmount
) - Parâmetro de consulta
supportedCurrencyID
para especificar a moeda.
No exemplo a seguir, quando o saldo da conta pré-paga do desenvolvedor ficar abaixo de US$ 5, mais US$ 10 vão ser adicionados automaticamente à conta.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "providerId": "worldpay-myorg", "isRecurring" : true, "replenishAmount" : 5, "recurringAmount" : 10 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \ -u email:password
Para uma descrição das propriedades da solicitação, consulte Resumo das propriedades da solicitação para configurar a recarga automática de contas pré-pagas.
Configurar a recarga automática de saldos de contas pré-pagas de uma empresa
Para configurar a atualização automática do saldo de uma conta pré-paga de uma empresa quando o saldo ficar
abaixo de um determinado valor, emita uma solicitação POST para
/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup
,
em que {company_id} é o ID
da empresa.
Ao emitir a solicitação, é necessário especificar o seguinte:
- ID do provedor de pagamento a ser usado para recarregar a conta (
providerID
) - Sinalização que ativa a atualização automática (
isRecurring
) - Limite em que o saldo da conta pré-paga precisa ficar abaixo de para acionar a recarga
automática (
replenishAmount
) - Valor a ser adicionado automaticamente à conta (
recurringAmount
) - Parâmetro de consulta
supportedCurrencyID
para especificar a moeda.
No exemplo a seguir, quando o saldo da conta pré-paga da empresa ficar abaixo de US$ 5, mais US$ 10 serão adicionados automaticamente à conta.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "providerId": "worldpay-myorg", "isRecurring" : true, "replenishAmount" : 5, "recurringAmount" : 10 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \ -u email:password
Para uma descrição das propriedades da solicitação, consulte Resumo das propriedades da solicitação para configurar a recarga automática de contas pré-pagas.
Resumo das propriedades da solicitação para configurar a recarga automática de contas pré-pagas
Os atributos a seguir podem ser especificados ao recarregar saldos de contas pré-pagas automaticamente usando a API.
Nome | Descrição | Padrão | Obrigatório? |
---|---|---|---|
providerId |
ID do provedor de pagamento. |
N/A | Sim |
chargePerUsage |
false | Não | |
isRecurring |
Sinalização que especifica se a atualização automática está ativada ( |
N/A | Sim |
replenishAmount |
Limite de que o saldo da conta pré-paga precisa ficar abaixo de para acionar a recarga automática. |
N/A | Sim |
recurringAmount |
Valor a ser adicionado ao saldo da conta pré-paga quando a recarga automática é acionada. |
N/A | Sim |
Como migrar para as páginas de pagamento hospedadas do WorldPay
A WorldPay atualizou o fluxo de processamento de pagamentos seguro para usar um novo conjunto de páginas, conhecido como páginas de pagamento hospedadas.
Se você configurou seus provedores de pagamento do WorldPay usando o fluxo de processamento de pagamentos seguros descontinuados (antes de agosto de 2017), será necessário migrar para as novas páginas de pagamento hospedadas do WorldPay antes de janeiro de 2018.
Para migrar para as páginas de pagamento hospedadas do WorldPay:
- Entre em contato com a WorldPay para migrar sua conta atual e usar as novas páginas de pagamento hospedadas e receber um novo ID de instalação para sua conta.
- Configure novos provedores de pagamento do WorldPay, conforme descrito em Como configurar o provedor de pagamento no Edge, transmitindo o ID de instalação no
campo
authType
. - Configure os novos provedores de pagamento no seu portal do desenvolvedor, conforme descrito em Configurar monetização no portal do desenvolvedor.
- Se você configurar a atualização automática de uma conta pré-paga usando o provedor de pagamento, precisará reconfigurar a atualização automática para usar o novo ID do provedor, conforme descrito em Como configurar a recarga automática de saldos de contas pré-pagas usando a API.
Próximas etapas
É possível definir limites de crédito para desenvolvedores pós-pagos individuais. Saiba como fazer isso em Gerenciar saldos pós-pagos.