Gérer le solde des comptes prépayés

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Pour gérer le solde d'un compte prépayé, vous pouvez:

Comment calculer le solde prépayé de mon compte ?

Lorsque vous consultez le solde prépayé du compte d'un développeur ou d'une entreprise, comme décrit dans les sections suivantes, vous devez obtenir les valeurs suivantes à partir de la réponse:

  • amount: montant total disponible pour la période de facturation en cours. Cette valeur est mise à jour lorsque vous rechargez le compte prépayé à l'aide des méthodes décrites dans cette section.
  • usage: montant total utilisé au cours de la période de facturation en cours. Cette valeur est mise à jour avec chaque transaction monétisée qualifiée ou par émission d'un crédit (positif ou négatif).

Vous pouvez calculer le solde prépayé restant du compte pour la période de facturation en cours en soustrayant la valeur usage de la valeur amount. Par exemple, si la valeur de amount est 335,50 et que la valeur du usage est de 34, le solde restant est calculé comme suit:

amount(335.50) - usage(34) = 229.50

Consulter les soldes prépayés de comptes à l'aide de l'API

Les sections suivantes décrivent comment afficher les soldes prépayés des comptes d'un développeur ou d'une entreprise qui utilisent l'API.

Consulter les soldes prépayés des comptes d'un développeur

Pour afficher le solde prépayé d'un développeur, envoyez une demande GET à l'une des API suivantes, où {developer_id} est l'adresse e-mail du développeur:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: renvoie le solde prépayé du compte et les informations de configuration récurrentes d'un développeur.
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: renvoie des informations sur le solde prépayé du compte, y compris le solde actuel et total, l'utilisation, les recharges de forfait et la taxe d'utilisation.

Vous pouvez transmettre les paramètres de requête suivants pour filtrer les résultats:

Paramètre de requête Description
all Indicateur spécifiant si tous les packages d'API doivent être renvoyés. Si la valeur est false, le nombre de packages d'API renvoyés par page est défini par le paramètre de requête size. La valeur par défaut est false.
size Nombre de packages d'API renvoyés par page. Valeur par défaut : 20. Si le paramètre de requête all est défini sur true, il est ignoré.
page Numéro de la page à afficher (si le contenu est paginé). Si le paramètre de requête all est défini sur true, il est ignoré.
currencyId Identifiant de la devise dans laquelle vous souhaitez consulter le solde prépayé du compte.

Exemple :

$ 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

Voici un exemple de réponse :

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

Consulter le solde prépayé d'une entreprise

Pour afficher le solde prépayé d'une entreprise, envoyez une demande GET à /mint/organizations/{org_name}/companies/{company_id}/developer-balances, où {company_id} correspond à l'ID de l'entreprise. Si l'entreprise a opté pour le prépaiement, la demande récupère le solde prépayé actuel du compte. Si l'entreprise a opté pour le post-paiement, la requête récupère la limite de crédit actuelle.

Vous pouvez transmettre les paramètres de requête suivants pour filtrer les résultats:

Paramètre de requête Description
all Indicateur spécifiant si tous les packages d'API doivent être renvoyés. Si la valeur est false, le nombre de packages d'API renvoyés par page est défini par le paramètre de requête size. La valeur par défaut est false.
size Nombre de packages d'API renvoyés par page. Valeur par défaut : 20. Si le paramètre de requête all est défini sur true, il est ignoré.
page Numéro de la page à afficher (si le contenu est paginé). Si le paramètre de requête all est défini sur true, il est ignoré.
currencyId Identifiant de la devise dans laquelle vous souhaitez consulter le solde prépayé du compte.

Exemple :

$ 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

La réponse est semblable à la réponse ci-dessus, qui affiche les soldes prépayés des comptes d'un développeur.

Gestion du solde prépayé de vos comptes via un fournisseur de services de paiement

Gérez les soldes prépayés de vos comptes en configurant un compte marchand auprès d'un fournisseur de services de paiement tiers tel que Worldpay. La figure suivante montre comment le solde prépayé d'un compte est géré avec le fournisseur de services de paiement Worldpay.

Flux du fournisseur de services de paiement Worldpay

Le tableau suivant décrit chaque étape du flux de gestion du solde prépayé, présenté ci-dessus.

Step Description
0 Étapes préalables
En tant que fournisseur d'API, vous devez :
1 Pour déclencher le flux, un utilisateur d'API effectue l'une des tâches suivantes dans le portail des développeurs :
  • Ajoute de l'argent sur un compte
  • Accepte un plan tarifaire avec des fonds insuffisants
2 Le portail des développeurs lance le paiement du développeur via Edge, avec l'ID du fournisseur, le montant de l'actualisation et la devise. Pour plus d'informations sur l'utilisation de l'API pour effectuer un paiement, consultez Effectuer un paiement vers un compte prépayé via un fournisseur de services de paiement.
3 Edge trouve le fournisseur par son ID et détermine qu'il s'agit d'un compte Worldpay.
4 Edge génère un code d'ordre.
5 Edge crée l'ordre de paiement sur Worldpay.
6 Worldpay renvoie un ID de référence pour la commande et une URL à durée limitée pour la traiter.
7 La réponse de Worldpay est convertie en réponse d'API Edge /Payment générique, qui est renvoyée au portail des développeurs pour effectuer l'appel initié à l'étape 2. Exemple :
{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}
8 Le portail des développeurs ajoute les URL de rappel (en cas de réussite, d'échec, etc.) à l'URL en tant que paramètres de requête.
9 Le portail des développeurs répond à la requête de l'étape 1 en redirigeant le navigateur de l'utilisateur de l'API vers l'URL modifiée.
10 L'utilisateur de l'API remplit le formulaire de demande et commence le traitement avec Worldpay.
11 Worldpay collecte les informations de facturation et traite le paiement. En cas de réussite, Worldpay génère un MAC (Message Authentication Code, code d'authentification de message) à l'aide du secret MAC configuré à la fois sur Worldpay et sur le portail des développeurs.
12 Worldpay redirige le navigateur de l'utilisateur de l'API vers l'URL de rappel ayant réussi (à l'étape 8), en ajoutant le MAC en tant que paramètre de requête et le montant.
13 Le navigateur appelle l'URL sur le portail des développeurs avec la quantité et l'adresse MAC demandés.
14 Le portail vérifie l'adresse MAC à l'aide du secret MAC. Le MAC empêche toute personne de revendiquer arbitrairement que les paiements ont bien été effectués.
15 Le portail des développeurs envoie une demande à Edge pour recharger le solde prépayé du compte. Si vous souhaitez en savoir plus sur l'utilisation de l'API pour recharger le solde d'un compte, consultez Recharger un solde prépayé d'un compte à l'aide de l'API.

Les sections suivantes décrivent la procédure à suivre pour gérer vos soldes prépayés via un fournisseur de services de paiement tiers:

Configurer un compte marchand avec le fournisseur de services de paiement Worldpay

Avant de commencer, vous devez contacter un fournisseur de services de paiement tiers (Worldpay) pour configurer votre ou vos comptes marchand. Nous vous recommandons de configurer deux comptes, un pour les tests et un pour la production. Pour en savoir plus sur les comptes marchands Worldpay, consultez les pages www.worldpay.com et wp-support.crm.worldpay.com (centre d'assistance Worldpay).

Une fois que vous avez configuré votre compte marchand et reçu vos identifiants, procédez comme suit pour le configurer avec Worldpay:

  1. Accédez à la page https://secure.worldpay.com/sso/public/auth/login.html.
  2. Connectez-vous à votre compte Worldpay à l'aide des identifiants qui vous ont été fournis par Worldpay.
  3. Définissez le mot de passe XML et la clé secrète du code d'authentification des messages (MAC) :
    1. Cliquez sur Profil.
    2. Définissez le mot de passe à utiliser lors de la configuration du fournisseur de services de paiement Worldpay dans Edge dans le champ Mot de passe XML.
    3. Saisissez une clé secrète MAC de 20 à 30 caractères dans le champ Redirect MAC secret (Code secret MAC de redirection).
    4. Cliquez sur Enregistrer le profil.
  4. Ajoutez le serveur de gestion Apigee Edge à la liste des adresses IP des marchands (liste d'autorisation) :
    1. Cliquez sur Profil > Environnement du marchand.
    2. Cliquez sur Nouvelle adresse IP de test.
    3. Saisissez l'adresse IP du serveur de gestion Apigee Edge.
    4. Cliquez sur Enregistrer.
  5. Configurez l'URL du marchand pour ajouter les paramètres Worldpay, y compris le code d'authentification de méthode (MAC) :
    1. Cliquez sur Installations > Pages de paiement hébergées > Concepteur de pages de paiement.
    2. Sous Edit Payment Pages (Modifier les pages de paiement), sélectionnez votre ID d'installation dans la liste déroulante Select channel (Sélectionner un canal).
    3. Dans l'onglet "Propriétés", sélectionnez Modifier la configuration du marchand.
    4. Définissez la valeur du paramètre d'URL d'envoi sur True.
    5. Cliquez sur l'onglet Publier.
    6. Promouvez les modifications comme suit :
      • Pour les environnements de test, cliquez sur Promouvoir sous Conception pour passer de la conception à l'environnement de bac à sable.
      • Pour les environnements de production, cliquez sur Promouvoir sous Bac à sable pour passer de l'environnement de bac à sable à l'environnement de production.

Configurer le fournisseur de services de paiement dans Edge

L'étape suivante consiste à configurer le fournisseur de services de paiement dans Edge.

Vous pouvez configurer votre fournisseur de services de paiement pour une organisation spécifique à l'aide de l'API suivante:

/organizations/{org-name}/providers

Les clients de cloud privé Apigee Edge uniquement disposant de droits d'administrateur système peuvent éventuellement configurer un fournisseur de paiement global à l'aide de l'API suivante:

/config/providers

Lorsque vous appelez chaque API, vous devez spécifier les informations suivantes dans le corps de la requête:

Paramètre Description Obligatoire
authType ID d'installation fourni par le fournisseur de services de paiement Oui
credential Identifiants encodés en base64 (username:XMLpassword) pour votre compte marchand Worldpay : username équivaut au code marchand (en majuscules), et XMLpassword spécifie le mot de passe XML que vous avez défini à l'étape précédente, lors de la configuration de votre compte marchand Worldpay. Oui
description Description du fournisseur de services de paiement. Non
endpoint Point de terminaison permettant d'accéder au fournisseur de services de paiement
  • Pour les comptes de test, utilisez : https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp
  • Pour les comptes de production, utilisez : https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp
Oui
merchantCode Code marchand fourni par le fournisseur de services de paiement à l'utilisateur de l'API Oui
name Nom à utiliser pour le fournisseur.

Clients de cloud privé Apigee Edge uniquement: pour les fournisseurs de services de paiement internationaux, assurez-vous que le nom est unique dans toutes les organisations Edge. Nous vous recommandons d'inclure WorldPay (non sensible à la casse) dans le nom du fournisseur pour faciliter son identification. Par exemple, WorldPay test ou WorldPay prod.. Les espaces dans les noms de fournisseur seront convertis en traits de soulignement.

Oui

Par exemple, la commande suivante permet de configurer un compte marchand avec Worldpay nommé 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 

Afficher les fournisseurs de services de paiement tiers

Affichez et confirmez les fournisseurs de services de paiement tiers configurés pour votre organisation Edge en envoyant une requête GET à la ressource suivante:

/mint/organizations/{org-name}/providers

Par exemple, le tableau ci-dessous affiche les fournisseurs de services de paiement tiers actuellement configurés pour myorg:

$ curl  -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \
-u email:password

Vous trouverez ci-dessous un exemple de réponse affichant deux comptes marchands, un pour les tests et l'autre pour la production.

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

Activer et configurer les modules de monétisation et Worldpay dans le portail des développeurs

Activez les modules de monétisation et de Worldpay requis sur le portail des développeurs. Pour en savoir plus, consultez Configurer la monétisation dans le portail des développeurs.

Paiement d'un compte prépayé via le fournisseur de services de paiement

Comme indiqué à l'étape 2 du flux de gestion des comptes prépayés, le paiement d'un compte prépayé via un fournisseur de services de paiement est initié par le portail des développeurs lorsque les utilisateurs de l'API:

  • Accepter un plan tarifaire, mais que le compte prépayé est insuffisant
  • Il lui demande de créditer son compte prépayé.

Pour effectuer un paiement à partir d'un fournisseur de services de paiement tiers à l'aide de l'API, envoyez une requête POST à la ressource suivante, où {developer_id} est l'adresse e-mail du développeur.

/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}

Lorsque vous émettez la requête, vous devez spécifier les valeurs suivantes en tant que paramètres de requête:

  • Montant à ajouter au solde prépayé du compte (amount={amount})
  • ID du fournisseur de services de paiement (provider={providerId})
  • Devise acceptée (supportedCurrencyId={currency})

En outre, vous devez transmettre les informations de base du compte, telles que l'adresse de facturation de l'entreprise.

Par exemple, la commande suivante recharge le solde d'un compte prépayé via le fournisseur de services de paiement Worldpay. Le virement initial vers votre compte prépayé sera de 10 USD (le paramètre de requête amount est défini sur 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

Voici un exemple de réponse :

{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}

L'URL de la page de paiement sécurisé Worldpay est renvoyée dans referenceUrl avec votre clé de commande unique ajoutée en tant que paramètre de requête.

Recharger un solde prépayé d'un compte à l'aide de l'API

Comme indiqué à l'étape 15 du flux de gestion de compte prépayé, après avoir vérifié le traitement réussi par le fournisseur de services de paiement, le portail des développeurs envoie une demande à Edge pour recharger le compte prépayé.

Vous pouvez recharger le solde prépayé du compte à l'aide de l'API pour un développeur ou une entreprise, comme décrit dans les sections suivantes.

Recharger le solde prépayé du compte d'un développeur

Pour recharger le solde prépayé d'un compte de développeur à l'aide de l'API, envoyez une requête POST à /mint/organizations/{org_name}/developers/{developer_id}/developer-balances, où {developer_id} est l'adresse e-mail du développeur. Lorsque vous émettez la requête, vous devez spécifier dans le corps de la requête le montant à ajouter au solde et la devise utilisée.

Par exemple, la demande suivante permet d'ajouter 1 000 $au solde prépayé du compte d'un développeur:

$ 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

Pour obtenir une description des propriétés de la requête, consultez Récapitulatif des propriétés de la requête pour actualiser un compte prépayé.

Recharger le solde prépayé du compte d'une entreprise

Pour recharger le solde prépayé du compte d'une entreprise qui utilise l'API, envoyez une requête POST à /mint/organizations/{org_name}/companies/{company_id}/developer-balances, où {company_id} correspond à l'ID de l'entreprise. Lorsque vous émettez la requête, vous devez spécifier dans le corps de la requête le montant à ajouter au solde et la devise utilisée.

Par exemple, la demande suivante permet d'ajouter 1 000 $au solde prépayé du compte d'une entreprise:

$ 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

Pour obtenir une description des propriétés de la requête, consultez Récapitulatif des propriétés de la requête pour actualiser un compte prépayé.

Récapitulatif des propriétés de la demande pour recharger un compte prépayé

Les propriétés suivantes doivent être spécifiées lorsque vous rechargez des soldes prépayés à l'aide de l'API:

Nom Description Par défaut Obligatoire ?
amount

Montant appliqué au solde prépayé (dans la devise applicable).

N/A Oui
supportedCurrency

Devise utilisée pour le solde prépayé. Il s'agit de la devise configurée pour le forfait dans le package d'API acheté par le développeur.

N/A Oui

Supprimer des fournisseurs de services de paiement tiers

Vous pouvez supprimer un fournisseur de services de paiement tiers configuré pour votre organisation Edge en envoyant une requête DELETE à la ressource suivante:

Pour supprimer un fournisseur de services de paiement pour une organisation spécifique, utilisez l'API suivante:

/mint/organizations/{org-name}/providers/id

Les clients de cloud privé Apigee Edge uniquement disposant de droits d'administrateur système peuvent éventuellement supprimer un fournisseur de paiement global à l'aide de l'API suivante:

/config/providers/id

Par exemple, la commande suivante supprime les fournisseurs de services de paiement tiers actuellement configurés pour myorg:

$ curl  -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \
-u email:password

Gérer manuellement les soldes prépayés de comptes

Vous pouvez également gérer l'actualisation des soldes prépayés en suivant les paiements manuellement ou via un système de facturation intégré, puis en appelant l'API de monétisation pour actualiser le compte, comme décrit dans la section Recharger un solde prépayé d'un compte à l'aide de l'API.

Configurer l'actualisation automatique des soldes prépayés de comptes à l'aide de l'API

Les sections suivantes décrivent comment configurer l'actualisation automatique du solde prépayé des comptes d'un développeur ou d'une entreprise ayant recours à un fournisseur de services de paiement tiers. Cette option est utile pour gérer les paiements récurrents pour les plans tarifaires.

Configurer l'actualisation automatique des soldes prépayés d'un développeur

Pour configurer l'actualisation automatique du solde prépayé du compte d'un développeur lorsque celui-ci passe en dessous d'un certain seuil, envoyez une demande POST à /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup, où {developer_id} correspond à l'adresse e-mail du développeur.

Lorsque vous émettez la requête, vous devez spécifier les éléments suivants:

  • ID du fournisseur de services de paiement à utiliser pour actualiser le compte (providerID)
  • Indicateur qui active l'actualisation automatique (isRecurring)
  • Seuil auquel le solde prépayé du compte doit descendre en dessous pour déclencher l'actualisation automatique (replenishAmount)
  • Montant à ajouter automatiquement au compte (recurringAmount)
  • Paramètre de requête supportedCurrencyID permettant de spécifier la devise.

Dans l'exemple suivant, lorsque le solde prépayé du compte du développeur passe en dessous de 5 dollars américains, 10 dollars américains supplémentaires sont automatiquement ajoutés au compte.

$ 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

Pour obtenir une description des propriétés de la requête, consultez Récapitulatif des propriétés de la requête pour la configuration de l'actualisation automatique des comptes prépayés.

Configurer le rechargement automatique des soldes prépayés d'une entreprise

Pour configurer l'actualisation automatique du solde prépayé d'une entreprise lorsque le solde passe en dessous d'un certain montant, envoyez une requête POST à /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup, où {company_id} correspond à l'ID de l'entreprise.

Lorsque vous émettez la requête, vous devez spécifier les éléments suivants:

  • ID du fournisseur de services de paiement à utiliser pour actualiser le compte (providerID)
  • Indicateur qui active l'actualisation automatique (isRecurring)
  • Seuil auquel le solde prépayé du compte doit descendre en dessous pour déclencher l'actualisation automatique (replenishAmount)
  • Montant à ajouter automatiquement au compte (recurringAmount)
  • Paramètre de requête supportedCurrencyID permettant de spécifier la devise.

Dans l'exemple suivant, lorsque le solde prépayé de l'entreprise passe en dessous de 5 dollars américains, 10 dollars américains supplémentaires sont automatiquement ajoutés au compte.

$ 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

Pour obtenir une description des propriétés de la requête, consultez Récapitulatif des propriétés de la requête pour la configuration de l'actualisation automatique des comptes prépayés.

Récapitulatif des propriétés de la demande pour la configuration de l'actualisation automatique des comptes prépayés

Les attributs suivants peuvent être spécifiés lors de l'actualisation automatique des soldes prépayés de comptes à l'aide de l'API.

Nom Description Par défaut Obligatoire ?
providerId

ID du fournisseur de services de paiement.

N/A Oui
chargePerUsage false Non
isRecurring

Indicateur spécifiant si l'actualisation automatique est activée (true). Pour la désactiver, définissez-la sur false.

N/A Oui
replenishAmount

Seuil auquel le solde prépayé du compte doit descendre en dessous pour déclencher l'actualisation automatique.

N/A Oui
recurringAmount

Montant à ajouter au solde prépayé du compte lors du déclenchement de l'actualisation automatique.

N/A Oui

Migrer vers les pages de paiement hébergées par WorldPay

WorldPay a mis à jour son flux de traitement sécurisé des paiements afin d'utiliser un nouvel ensemble de pages, appelées pages de paiement hébergées.

Si vous avez configuré votre ou vos fournisseurs de services de paiement WorldPay à l'aide du flux de traitement sécurisé des paiements obsolète (avant août 2017), vous devrez migrer vers les nouvelles pages de paiement hébergées de WorldPay avant janvier 2018.

Pour effectuer la migration vers les pages de paiement hébergées par WorldPay:

  1. Contactez WorldPay pour migrer votre compte actuel afin d'utiliser les nouvelles pages de paiement hébergées et obtenir un nouvel ID d'installation pour votre compte.
  2. Configurez de nouveaux fournisseurs de services de paiement WorldPay, comme décrit dans la section Configurer le fournisseur de services de paiement dans Edge, en transmettant l'ID d'installation dans le champ authType.
  3. Configurez les nouveaux fournisseurs de services de paiement sur votre portail des développeurs, comme décrit dans Configurer la monétisation dans le portail des développeurs.
  4. Si vous avez configuré l'actualisation automatique d'un compte prépayé via le fournisseur de services de paiement, vous devez reconfigurer l'actualisation automatique pour utiliser le nouvel ID de fournisseur, comme décrit dans Configurer l'actualisation automatique des soldes de comptes prépayés à l'aide de l'API.

Étapes suivantes

Vous pouvez définir des limites de crédit pour chaque développeur post-payé. Pour savoir comment procéder, consultez Gérer les soldes post-payés.