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

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

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

• Consultez le solde prépayé actuel de votre compte. Reportez-vous à la section Affichage des cartes prépayées soldes de vos comptes à l'aide de l'API.
• Recharger le solde du compte (si nécessaire) via un fournisseur de services de paiement tiers comme Worldpay. Pour en savoir plus, consultez l'article Gérer les réserves prépayées avec une solution de paiement fournisseur de services de paiement.

  Vous pouvez également gérer l'actualisation en suivant les paiements manuellement ou via un système de facturation intégré, puis d'appeler l'API de monétisation pour actualiser le compte, décrites dans l'article Gérer manuellement les réserves prépayées.

• Configurer l'actualisation automatique lorsqu'un solde prépayé d'un compte passe en dessous d'un certain seuil à l'aide de l'API de monétisation et d'un fournisseur de services de paiement tiers, comme Worldpay. Cette option est utiles pour gérer les paiements récurrents pour les plans tarifaires. Pour en savoir plus, consultez la section Configuration l'actualisation automatique du solde prépayé du compte à l'aide de l'API ;

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

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

• amount: somme totale disponible pour la période de facturation en cours. Cette valeur est mise à jour lorsque vous actualisez la page 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 à chaque fois transaction, 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 du Valeur amount. Par exemple, si la valeur amount est 335,50 et que la valeur usage est 34, le le solde restant est calculé comme suit:

amount(335.50) - usage(34) = 229.50

Afficher le solde prépayé de vos comptes à l'aide de l'API

Les sections suivantes expliquent comment afficher le solde prépayé des comptes d'un développeur ou à l'aide de l'API.

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

Pour afficher le solde prépayé des comptes 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 pour un développeur.
• /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: renvoie les informations sur le solde prépayé de votre compte, y compris le solde actuel et total, l'utilisation, les recharges et les taxes d'utilisation.

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

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
}

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

Pour afficher le solde prépayé du compte d'une entreprise, envoyez une demande GET à /mint/organizations/{org_name}/companies/{company_id}/developer-balances, où {company_id} est l'identifiant 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:

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 à celle présentée ci-dessus, lorsque vous consultez les soldes prépayés de vos comptes pour un développeur.