ניהול יתרות בחשבונות ששולמו מראש

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

כדי לנהל את היתרה בחשבון בתשלום מראש, אתם יכולים:

• להציג את היתרה הנוכחית ששולמה מראש בחשבון. למידע נוסף, ראו צפייה בתשלום מראש יתרות בחשבון באמצעות ה-API.
• לטעון מחדש (להוסיף כסף) את היתרה בחשבון לפי הצורך באמצעות ספק תשלום מצד שלישי כמו Worldpay. ראו ניהול יתרות משולמות מראש באמצעות צד שלישי ספק תשלום.

  לחלופין, ניתן לנהל את הטעינה מחדש על ידי מעקב אחר התשלומים באופן ידני או דרך במערכת החיוב המשולבת, ואז קריאה לממשק ה-API של המונטיזציה לטעון מחדש את החשבון, שמתואר במאמר ניהול יתרות מהפקדה באופן ידני.

• איך מגדירים טעינה מחדש אוטומטית כשיתרת החשבון בתשלום מראש יורדת מתחת לסף מסוים באמצעות ממשק ה-API למונטיזציה ובאמצעות ספק תשלום של צד שלישי, כמו Worldpay. האפשרות הזאת היא שימושי לניהול תשלומים קבועים עבור תוכניות תמחור ותשלומים. למידע נוסף, ראה הגדרת טעינה מחדש אוטומטית של יתרות חוב בחשבון ששולמו מראש באמצעות ה-API.

איך אפשר לחשב את היתרה ששולמה מראש בחשבון?

כשצופים ביתרת החשבון בתשלום מראש של מפתח או חברה, כפי שמתואר בסעיפים הבאים, צריך: מקבלים את הערכים הבאים מהתשובה:

• amount: סכום הכסף הכולל הזמין בתקופת החיוב הנוכחית. הערך הזה מתעדכן כשטוענים מחדש החשבון בתשלום מראש באמצעות השיטות שמתוארות בקטע הזה.
• usage: סכום הכסף הכולל שנעשה בו שימוש במהלך תקופת החיוב הנוכחית. הערך הזה מתעדכן בכל פעם שהמונטיזציה עומדת בדרישות עסקה או על ידי הנפקת זיכוי (חיובי או שלילי).

אפשר לחשב את הסכום שנותר לתשלום מראש בחשבון בתקופת החיוב הנוכחית על ידי ניכוי הערך של usage ערך amount. לדוגמה, אם הערך של amount הוא 335.50 והערך usage הוא 34, יתרת החוב תחושב באופן הבא:

amount(335.50) - usage(34) = 229.50

הצגת יתרות בחשבון ששולמו מראש באמצעות ה-API

בקטעים הבאים מתואר איך להציג יתרות חוב של מפתח או של מפתח ששולמו מראש לחברה שמשתמשת ב-API.

הצגת יתרות משולמות מראש בחשבון של מפתח

כדי להציג יתרות בחשבון של מפתח ששולמו מראש, צריך לשלוח בקשת GET לאחד מממשקי ה-API הבאים, שבהם {developer_id} הוא כתובת האימייל של המפתח:

• /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: הפונקציה מחזירה את היתרה בחשבון ששולמה מראש ואת פרטי ההגדרות הקבועים של המפתח.
• /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: החזרת פרטים לגבי יתרת החשבון ששולמה מראש, כולל היתרה הנוכחית והסה"כ, שימוש, הוספת כסף ומס שימוש.

כדי לסנן את התוצאות, אפשר להעביר את הפרמטרים הבאים של שאילתה:

לדוגמה:

$ 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

הדוגמה הבאה ממחישה את התשובה:

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

הצגת יתרות משולמות מראש בחשבון של חברה

כדי להציג יתרות משולמות מראש בחשבון של חברה מסוימת, יש לשלוח בקשת GET אל /mint/organizations/{org_name}/companies/{company_id}/developer-balances, כאשר {company_id} הוא מזהה החברה. אם החברה מקבלת תשלום מראש, הבקשה מאחזרת את היתרה הנוכחית ששולמה מראש בחשבון. אם החברה משלמת לאחר השימוש (postpay), הבקשה תאחזר מסגרת האשראי הנוכחית.

כדי לסנן את התוצאות, אפשר להעביר את הפרמטרים הבאים של שאילתה:

לדוגמה:

$ 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

התגובה דומה לתשובה שלמעלה, כשמציגים יתרות חוב בחשבון ששולמו מראש ממפתח.