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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X.
מידע

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

איך מחשבים את היתרה שנותרה בחשבון שמוגדר לתשלום מראש?

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

  • 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: מחזירה מידע על היתרה בחשבון ששולם מראש, כולל היתרה הנוכחית והכוללת, השימוש, הוספת כסף ליתרה ומס על השימוש.

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

פרמטר שאילתה תיאור
all דגל שמציין אם להחזיר את כל חבילות ה-API. אם הערך הוא false, מספר חבילות ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false.
size מספר חבילות ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה.
page מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה.
currencyId המזהה של המטבע שרוצים לראות את היתרות בחשבון בתשלום מראש.

לדוגמה:

$ 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} הוא מזהה החברה. אם החברה משלמת מראש, הבקשה מחזירה את היתרה הנוכחית בחשבון התשלום מראש. אם החברה היא לקוחה בתשלום בסוף החודש, הבקשה מאחזרת את מסגרת האשראי הנוכחית.

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

פרמטר שאילתה תיאור
all דגל שמציין אם להחזיר את כל חבילות ה-API. אם הערך הוא false, מספר חבילות ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false.
size מספר חבילות ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה.
page מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה.
currencyId המזהה של המטבע שרוצים לראות את היתרות בחשבון בתשלום מראש.

לדוגמה:

$ 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

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

ניהול יתרות בחשבון בתשלום מראש באמצעות ספק תשלומים

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

תהליך של ספק התשלום Worldpay

בטבלה הבאה מתואר כל שלב בתהליך ניהול היתרה בחשבון בתשלום מראש, שמוצג למעלה.

שלב תיאור
0 שלבים מקדימים
כספק ה-API, כדי להגדיר ספק תשלומים מצד שלישי, כמו Worldpay, אתם צריכים:
1 כדי להפעיל את התהליך, צרכן API מבצע אחת מהמשימות הבאות בפורטל המפתחים:
  • הוספת כסף לחשבון
  • התשלום נדחה כי אין מספיק כסף בחשבון
2 פורטל המפתחים יוזם תשלום דרך Edge עבור המפתח, עם מזהה הספק, סכום הטעינה והמטבע. למידע על שימוש ב-API כדי ליזום תשלום, אפשר לעיין במאמר יזום תשלום לחשבון בתשלום מראש באמצעות ספק תשלומים.
3 ‫Edge מאתר את הספק לפי המזהה וקובע שמדובר בחשבון Worldpay.
4 מערכת Edge יוצרת קוד הזמנה.
5 מערכת Edge יוצרת את בקשת התשלום ב-Worldpay.
6 מערכת Worldpay מחזירה מזהה הפניה להזמנה וכתובת URL עם הגבלת זמן לביצוע ההזמנה.
7 התגובה של Worldpay מומרת לתגובה כללית של Edge /payment API, שמוחזרת לפורטל למפתחים כדי להשלים את הקריאה שהופעלה בשלב 2. לדוגמה:
{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}
8 פורטל המפתחים מצרף כתובות URL של קריאה חוזרת (למקרה של הצלחה, כישלון וכו') כפרמטרים של שאילתה לכתובת ה-URL.
9 פורטל המפתחים מגיב לבקשה בשלב 1 על ידי הפניה מחדש של הדפדפן של צרכן ה-API אל כתובת ה-URL ששונתה.
10 צרכן ה-API ממלא את טופס הבקשה ומתחיל את העיבוד ב-Worldpay.
11 ‫Worldpay אוספת את פרטי החיוב ומעבדת את התשלום. אם הפעולה מצליחה, Worldpay יוצרת קוד אימות הודעה (MAC) באמצעות סוד ה-MAC שהוגדר גם ב-Worldpay וגם בפורטל למפתחים.
12 מערכת Worldpay מפנה את הדפדפן של הלקוח שמשתמש ב-API לכתובת ה-URL של הקריאה החוזרת (callback) שבוצעה בהצלחה (משלב 8), ומצרפת את ה-MAC כפרמטר של שאילתה ואת הסכום.
13 הדפדפן קורא לכתובת ה-URL בפורטל למפתחים עם הסכום המבוקש וכתובת ה-MAC.
14 הפורטל מאמת את כתובת ה-MAC מול סוד ה-MAC. ה-MAC מונע מאדם לטעון באופן שרירותי שבוצעו תשלומים בהצלחה.
15 פורטל המפתחים שולח בקשה לטעינה מחדש של היתרה בחשבון התשלום מראש אל Edge. למידע על שימוש ב-API כדי לטעון מחדש את היתרה בחשבון, אפשר לעיין במאמר טעינה מחדש של יתרה בחשבון בתשלום מראש באמצעות ה-API.

בקטעים הבאים מוסבר איך לנהל יתרות בתשלום מראש באמצעות ספק תשלומים מצד שלישי:

הגדרת חשבון של מוכר/ת אצל ספק התשלומים Worldpay

לפני שמתחילים, צריך לפנות לספק תשלומים מצד שלישי (Worldpay) כדי להגדיר את חשבונות המוכר. מומלץ להגדיר שני חשבונות, אחד לבדיקה ואחד לסביבת ייצור. מידע נוסף על חשבונות מוֹכרים ב-Worldpay זמין בכתובות www.worldpay.com ו-wp-support.crm.worldpay.com (מרכז התמיכה של Worldpay).

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

  1. נכנסים לכתובת https://secure.worldpay.com/sso/public/auth/login.html.
  2. מתחברים לחשבון Worldpay באמצעות פרטי הכניסה שקיבלתם מ-Worldpay.
  3. מגדירים את הסיסמה של ה-XML ואת המפתח הסודי של קוד אימות ההודעות (MAC):
    1. לוחצים על פרופיל.
    2. מגדירים את הסיסמה לשימוש כשמגדירים את ספק התשלומים Worldpay ב-Edge בשדה XML Password.
    3. מזינים מפתח סודי של כתובת MAC באורך 20 עד 30 תווים בשדה Redirect MAC secret (הפניה אוטומטית של כתובת MAC סודית).
    4. לוחצים על שמירת הפרופיל.
  4. מוסיפים את שרת הניהול של Apigee Edge לרשימת כתובות ה-IP של המוכר (רשימת ההיתרים):
    1. לוחצים על פרופיל > סביבת מוכר.
    2. לוחצים על כתובת IP חדשה לבדיקה.
    3. מזינים את כתובת ה-IP של שרת הניהול של Apigee Edge.
    4. לוחצים על שמירה.
  5. מגדירים את כתובת ה-URL של המוֹכר כדי להוסיף את הפרמטרים של Worldpay, כולל קוד האימות של שיטת התשלום (MAC):
    1. לוחצים על Installations > Hosted Payment Pages > Payment Page Designer (התקנות > דפי תשלום מתארחים > כלי לעיצוב דפי תשלום).
    2. בקטע עריכת דפי תשלום, בוחרים את מזהה ההתקנה מהרשימה הנפתחת בחירת ערוץ.
    3. בכרטיסייה 'מאפיינים', לוחצים על עריכת הגדרות המוכר.
    4. מגדירים את הערך של הפרמטר Send URL parameters (שליחת פרמטרים של כתובת URL) ל-True.
    5. לוחצים על הכרטיסייה פרסום.
    6. מקדמים את השינויים באופן הבא:
      • בסביבות בדיקה, לוחצים על קידום בקטע עיצוב כדי לקדם מעיצוב לארגז חול.
      • בסביבות ייצור, לוחצים על קידום בקטע ארגז חול כדי לקדם מארגז חול לייצור.

הגדרת ספק התשלומים ב-Edge

השלב הבא הוא הגדרת ספק התשלומים ב-Edge.

אפשר להגדיר את ספק התשלומים עבור ארגון ספציפי באמצעות ה-API הבא:

/organizations/{org-name}/providers

רק לקוחות של Apigee Edge Private Cloud עם הרשאות אדמין מערכת יכולים להגדיר ספק תשלומים גלובלי באמצעות ה-API הבא:

/config/providers

כשמתקשרים לכל API, צריך לציין את הפרטים הבאים בגוף הבקשה:

פרמטר תיאור חובה
authType מזהה ההתקנה שסופק על ידי ספק התשלומים. כן
credential פרטי הכניסה (username:XMLpassword) של חשבון המוכר שלכם ב-Worldpay, מוצפנים ב-Base64. ‏username שווה לקוד המוכר (באותיות רישיות) ו-XMLpassword מציין את סיסמת ה-XML שהגדרתם בשלב הקודם, כשפתחתם את חשבון המוכר שלכם ב-Worldpay. כן
description תיאור של ספק התשלום. לא
endpoint נקודת קצה לגישה לספק התשלומים
  • לחשבונות בדיקה, משתמשים ב: https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp
  • בחשבונות בסביבת ייצור, משתמשים בכתובת: https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp
כן
merchantCode קוד מוֹכר שסופק על ידי ספק התשלומים לצרכן ה-API כן
name השם שבו ישתמש הספק.

לקוחות של Apigee Edge Private Cloud בלבד: כשמשתמשים בספקי תשלומים גלובליים, צריך לוודא שהשם ייחודי בכל הארגונים ב-Edge. מומלץ לכלול את השם WorldPay (לא תלוי אותיות רישיות) בשם הספק כדי שיהיה קל לזהות אותו. לדוגמה: WorldPay test או WorldPay prod. הרווחים בשמות הספקים יומרו לקווים תחתונים.

כן

לדוגמה, הפקודה הבאה מגדירה חשבון של מוכר/ת עם Worldpay בשם 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 

צפייה בספקי תשלומים של צד שלישי

כדי לראות ולאשר את ספקי התשלומים של צד שלישי שהוגדרו לארגון Edge, שולחים בקשת GET למשאב הבא:

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

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

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

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

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

הפעלה והגדרה של מודולים של מונטיזציה ו-Worldpay בפורטל המפתחים

מפעילים את המודולים הנדרשים של מונטיזציה ו-Worldpay בפורטל למפתחים. פרטים נוספים זמינים במאמר הגדרת מונטיזציה בפורטל למפתחים.

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

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

  • מאשרים תוכנית תמחור, אבל אין להם מספיק כסף בחשבון בתשלום מראש
  • לבקש להוסיף כסף לחשבון שלהם לתשלום מראש.

כדי ליזום תשלום מספק תשלומים מצד שלישי באמצעות ה-API, שולחים בקשת POST למשאב הבא, כאשר {developer_id} היא כתובת האימייל של המפתח.

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

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

  • הסכום להוספה ליתרה בחשבון שמוגדר לתשלום מראש (amount={amount})
  • מזהה ספק התשלומים (provider={providerId})
  • מטבע נתמך (supportedCurrencyId={currency})

בנוסף, צריך להעביר פרטים בסיסיים של החשבון, כמו כתובת החיוב של החברה.

לדוגמה, הפקודה הבאה טוענת מחדש את היתרה בחשבון שמוגדר לתשלום מראש באמצעות ספק התשלומים Worldpay. ההעברה הראשונית לחשבון התשלום מראש תהיה בסך 10 דולר אמריקאי (amount פרמטר השאילתה מוגדר כ-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

זוהי דוגמה לתגובה:

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

כתובת ה-URL של דף התשלום המאובטח של Worldpay מוחזרת ב-referenceUrl עם מפתח ההזמנה הייחודי שלכם שנוסף כפרמטר של שאילתה.

טעינה מחדש של יתרה בחשבון בתשלום מראש באמצעות ה-API

כפי שמוצג בשלב 15 בתהליך ניהול חשבון בתשלום מראש, אחרי שספק התשלום מאמת שהעיבוד בוצע בהצלחה, פורטל למפתחים שולח בקשה לטעינה מחדש של החשבון בתשלום מראש אל Edge.

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

טעינה מחדש של יתרה בחשבון בתשלום מראש של מפתח

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

לדוגמה, הבקשה הבאה מוסיפה 1,000 $ליתרה בחשבון של מפתח שמשלם מראש:

$ 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

תיאור של מאפייני הבקשה מופיע בקטע סיכום של מאפייני הבקשה לטעינת יתרה בחשבון עם תשלום מראש.

טעינה מחדש של יתרה בחשבון בתשלום מראש של חברה

כדי לטעון מחדש את היתרה בחשבון בתשלום מראש של חברה באמצעות ה-API, שולחים בקשת POST אל /mint/organizations/{org_name}/companies/{company_id}/developer-balances, כאשר {company_id} הוא המזהה של החברה. כששולחים את הבקשה, צריך לציין בגוף הבקשה את הסכום שרוצים להוסיף ליתרה ואת המטבע שבו משתמשים.

לדוגמה, הבקשה הבאה מוסיפה 1,000 $ליתרה בחשבון של חברה שמשלמת מראש:

$ 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

תיאור של מאפייני הבקשה מופיע בקטע סיכום של מאפייני הבקשה לטעינת יתרה בחשבון עם תשלום מראש.

סיכום של מאפייני הבקשה לטעינה מחדש של חשבון בתשלום מראש

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

שם תיאור ברירת מחדל חובה?
amount

הסכום ששולם מראש (במטבע הרלוונטי).

לא רלוונטי כן
supportedCurrency

המטבע שבו מוגדרת היתרה מההפקדה. זהו המטבע שהוגדר לתוכנית בחבילת ה-API שהמפתח רכש.

לא רלוונטי כן

מחיקת ספקי תשלומים של צד שלישי

אפשר למחוק ספק תשלומים של צד שלישי שהוגדר לארגון Edge על ידי שליחת בקשת DELETE למשאב הבא:

כדי למחוק ספק תשלומים בארגון ספציפי, משתמשים בממשק ה-API הבא:

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

רק לקוחות של Apigee Edge Private Cloud עם הרשאות אדמין מערכת יכולים למחוק ספק תשלומים גלובלי באמצעות ה-API הבא:

/config/providers/id

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

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

ניהול יתרות בחשבון עם תשלום מראש באופן ידני

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

הגדרת הוספת כסף אוטומטית ליתרות בחשבון בתשלום מראש באמצעות ה-API

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

הגדרת הוספת כסף אוטומטית ליתרות בחשבון בתשלום מראש של מפתח

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

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

  • המספר של ספק התשלומים שבו רוצים להשתמש כדי לטעון מחדש את החשבון (providerID)
  • דגל שמפעיל הוספת כסף אוטומטית (isRecurring)
  • הסף שמתחתיו היתרה בחשבון התשלומים מראש צריכה לרדת כדי להפעיל טעינה אוטומטית (replenishAmount)
  • הסכום שיוסף אוטומטית לחשבון (recurringAmount)
  • פרמטר השאילתה supportedCurrencyID לציון המטבע.

בדוגמה הבאה, כשהיתרה בחשבון התשלומים מראש של המפתח יורדת מתחת ל-5 דולר ארה"ב, נוספים לחשבון באופן אוטומטי עוד 10 דולר ארה"ב.

$ 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

תיאור של מאפייני הבקשה מופיע בקטע סיכום מאפייני הבקשה להגדרת טעינה אוטומטית של חשבונות בתשלום מראש.

הגדרת הוספת כסף אוטומטית ליתרות בחשבון בתשלום מראש בחברה

כדי להגדיר טעינה אוטומטית של יתרת חשבון תשלומים מראש של חברה כשהיתרה יורדת מתחת לסכום מסוים, שולחים בקשת POST אל /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup, כאשר {company_id} הוא מזהה החברה.

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

  • המספר של ספק התשלומים שבו רוצים להשתמש כדי לטעון מחדש את החשבון (providerID)
  • דגל שמאפשר הוספת כסף אוטומטית (isRecurring)
  • הסף שמתחתיו היתרה בחשבון התשלומים מראש צריכה לרדת כדי להפעיל טעינה אוטומטית (replenishAmount)
  • הסכום שיוסף אוטומטית לחשבון (recurringAmount)
  • פרמטר השאילתה supportedCurrencyID לציון המטבע.

בדוגמה הבאה, כשהיתרה בחשבון התשלומים מראש של החברה יורדת מתחת ל-5 דולר ארה"ב, 10 דולר ארה"ב נוספים יתווספו לחשבון באופן אוטומטי.

$ 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

תיאור של מאפייני הבקשה מופיע בקטע סיכום מאפייני הבקשה להגדרה של טעינה אוטומטית של חשבונות מהפקדה.

סיכום של מאפייני הבקשה להגדרת טעינה מחדש אוטומטית של חשבונות בתשלום מראש

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

שם תיאור ברירת מחדל חובה?
providerId

המזהה של ספק התשלום.

לא רלוונטי כן
chargePerUsage false לא
isRecurring

דגל שמציין אם הוספת כסף אוטומטית מופעלת (true). כדי להשבית את הוספת הכסף האוטומטית, מגדירים את הדגל הזה לערך false.

לא רלוונטי כן
replenishAmount

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

לא רלוונטי כן
recurringAmount

הסכום שיתווסף ליתרה בחשבון התשלומים מראש כשהטעינה האוטומטית תופעל.

לא רלוונטי כן

מעבר לדפי תשלום מתארחים של WorldPay

חברת WorldPay עדכנה את תהליך עיבוד התשלומים המאובטח שלה, ועכשיו היא משתמשת בסדרה חדשה של דפים שנקראים דפי תשלום מארחים.

אם הגדרתם את ספקי התשלומים של WorldPay באמצעות תהליך מאובטח לעיבוד תשלומים שיצא משימוש (לפני אוגוסט 2017), תצטרכו לעבור לדפי התשלום החדשים של WorldPay לפני ינואר 2018.

כדי לעבור אל דפי התשלום המתארחים של WorldPay:

  1. צריך לפנות אל WorldPay כדי להעביר את החשבון הנוכחי לשימוש בדפי תשלום חדשים שמתארחים ב-WorldPay, ולקבל מזהה התקנה חדש לחשבון.
  2. מגדירים ספקי תשלומים חדשים של WorldPay, כמו שמתואר במאמר הגדרת ספק התשלומים ב-Edge, ומעבירים את מזהה ההתקנה בשדה authType.
  3. מגדירים את ספקי התשלומים החדשים בפורטל המפתחים, כמו שמתואר במאמר הגדרת מונטיזציה בפורטל המפתחים.
  4. אם הגדרתם טעינה אוטומטית של חשבון בתשלום מראש באמצעות ספק התשלומים, תצטרכו להגדיר מחדש את הטעינה האוטומטית כדי להשתמש במזהה הספק החדש, כמו שמתואר במאמר הגדרת טעינה אוטומטית של יתרות בחשבון בתשלום מראש באמצעות ה-API.

השלבים הבאים

אפשר להגדיר מגבלות קרדיט למפתחים ספציפיים עם חשבון לתשלום חודשי. איך מנהלים את היתרה בחשבון בתשלום בסוף תקופה