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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X.
info

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

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

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

  • 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 לקריאה חוזרת (מ-שלב 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.
    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. מגדירים את הערך של הפרמטרים של כתובת ה-URL לשליחה ל-True.
    5. לוחצים על הכרטיסייה פרסום.
    6. מקדמים את השינויים באופן הבא:
      • בסביבות בדיקה, לוחצים על Promotion (קידום) בקטע design (עיצוב) כדי לקדם מ- Design to Sandbox.
      • בסביבות ייצור, לוחצים על Promote בקטע Sandbox כדי להעביר את הסביבה מ-Sandbox לסביבת הייצור.

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

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

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

/organizations/{org-name}/providers

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

/config/providers

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

פרמטר תיאור חובה
authType מזהה ההתקנה שסופק על ידי ספק התשלום. כן
credential פרטי כניסה (username:XMLpassword) עם קידוד Base64 לחשבון המוכר ב-Worldpay. הערך username זהה לקוד המוכר (באותיות רישיות בלבד), והערך XMLpassword מציין את הסיסמה ל-XML שהגדרתם בשלב הקודם, כשהגדרתם את חשבון המוכר ב-Worldpay. כן
description תיאור של ספק התשלום. לא
endpoint נקודת קצה (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 בפורטל למפתחים. פרטים נוספים זמינים במאמר הגדרת מונטיזציה ב-Developer Portal.

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

כפי שמתואר בשלב 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

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

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

השלבים הבאים

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