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

כרגע מוצג התיעוד של 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.

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

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

שלב התיאור
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 סיסמת.
    3. מזינים מפתח סודי של MAC בן 20 עד 30 תווים בשדה הפניה אוטומטית של MAC Secret.
    4. לוחצים על שמירת הפרופיל.
  4. צריך להוסיף את שרת הניהול של Apigee Edge לרשימת כתובות ה-IP של המוכרים (רשימת ההיתרים):
    1. לוחצים על פרופיל > סביבת המוֹכר.
    2. לוחצים על כתובת IP חדשה לבדיקה.
    3. יש להזין את כתובת ה-IP של שרת הניהול של Apigee Edge.
    4. לוחצים על שמירה.
  5. מגדירים את כתובת ה-URL של המוכר לצירוף פרמטרים של Worldpay, כולל קוד אימות השיטה (MAC):
    1. לוחצים על התקנות > דפי תשלום מתארחים > מעצב דפי תשלומים.
    2. בקטע Edit Payment Pages (עריכת דפי תשלום), בוחרים את מזהה ההתקנה מהרשימה הנפתחת Select channel (בחירת ערוץ).
    3. בכרטיסייה 'מאפיינים', בוחרים באפשרות עריכת ההגדרות האישיות של המוכר.
    4. מגדירים את ערך הפרמטרים לשליחת כתובת URL כ-True.
    5. לוחצים על הכרטיסייה פרסום.
    6. כך מקדמים שינויים:
      • בסביבות בדיקה, לוחצים על קידום בקטע עיצוב כדי לקדם מ- Design ל-Sandbox.
      • בסביבות ייצור, לוחצים על קידום בקטע Sandbox כדי לקדם מ-Sandbox לייצור.

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

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

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

/organizations/{org-name}/providers

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

/config/providers

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

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

ללקוחות Cloud Private Cloud בלבד של Apigee Edge: לספקי תשלומים גלובליים, יש לוודא שהשם ייחודי בכל ארגוני 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} הוא מספר החברה. כששולחים את הבקשה, צריך לציין בגוף הבקשה את הסכום שיש להוסיף ליתרה ואת המטבע שבו נעשה שימוש.

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

השלבים הבאים

אפשר להגדיר תקרות אשראי למפתחים ספציפיים שמשלמים לאחר השימוש (postpay). מידע נוסף זמין במאמר ניהול יתרות של תשלום לאחר השימוש (postpay).