प्रीपेड खाते के बैलेंस मैनेज करें

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं.
जानकारी

प्रीपेड खाते में मौजूद बैलेंस को मैनेज करने के लिए, ये काम किए जा सकते हैं:

मैं प्रीपेड खाते में बाकी बैलेंस का हिसाब कैसे लगाऊं?

डेवलपर या कंपनी के लिए, प्रीपेड खाते में बाकी बैलेंस देखते समय, आपको जवाब से ये वैल्यू हासिल करनी होंगी. इसके बारे में यहां बताया गया है:

  • amount: मौजूदा बिलिंग अवधि के लिए उपलब्ध कुल रकम. इस वैल्यू को तब अपडेट किया जाता है, जब इस सेक्शन में बताए गए तरीकों का इस्तेमाल करके प्रीपेड खाते को फिर से लोड किया जाता है.
  • usage: मौजूदा बिलिंग अवधि के दौरान इस्तेमाल की गई कुल रकम. यह वैल्यू, कमाई करने की ज़रूरी शर्तें पूरी करने वाले हर लेन-देन के साथ अपडेट होती है. इसके अलावा, क्रेडिट जारी करके (पॉज़िटिव या नेगेटिव) भी इसे अपडेट किया जा सकता है.

मौजूदा बिलिंग अवधि के लिए, प्रीपेड खाते में बचा हुआ बैलेंस कैलकुलेट किया जा सकता है. इसके लिए, usage वैल्यू में से amount वैल्यू घटाएं. उदाहरण के लिए, अगर amount की वैल्यू 335.50 और usage की वैल्यू 34 है, तो बाकी बचे पैसे इस तरह से कैलकुलेट किए जाएंगे:

amount(335.50) - usage(34) = 229.50

एपीआई का इस्तेमाल करके, प्रीपेड खाते में मौजूद बैलेंस देखना

यहां बताया गया है कि एपीआई का इस्तेमाल करके, किसी डेवलपर या कंपनी के प्रीपेड खाते का बैलेंस कैसे देखा जा सकता है.

किसी डेवलपर के प्रीपेड खाते का बैलेंस देखना

किसी डेवलपर के प्रीपेड खाते का बैलेंस देखने के लिए, यहां दिए गए किसी एक एपीआई को GET अनुरोध भेजें. यहां {developer_id} डेवलपर का ईमेल पता है:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: यह डेवलपर के लिए, प्रीपेड खाते में बाकी बैलेंस और बार-बार होने वाले सेटअप की जानकारी दिखाता है.
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: यह प्रीपेड खाते के बैलेंस की जानकारी देता है. इसमें ये शामिल हैं: मौजूदा और कुल बैलेंस, इस्तेमाल, टॉप अप, और इस्तेमाल पर लगने वाला टैक्स.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

क्वेरी पैरामीटर ब्यौरा
all यह फ़्लैग बताता है कि सभी एपीआई पैकेज वापस भेजने हैं या नहीं. अगर इसे false पर सेट किया जाता है, तो हर पेज पर दिखाए जाने वाले एपीआई पैकेज की संख्या, size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट रूप से, यह false पर सेट होती है.
size हर पेज पर दिखाए गए एपीआई पैकेज की संख्या. डिफ़ॉल्ट वैल्यू 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
}

किसी कंपनी के प्रीपेड खाते का बैलेंस देखना

किसी कंपनी के प्रीपेड खाते का बैलेंस देखने के लिए, /mint/organizations/{org_name}/companies/{company_id}/developer-balances को GET अनुरोध भेजें. यहां {company_id}, कंपनी का आईडी है. अगर कंपनी प्रीपेड है, तो अनुरोध से प्रीपेड खाते का मौजूदा बैलेंस मिलता है. अगर कंपनी पोस्टपेड है, तो अनुरोध से मौजूदा क्रेडिट लिमिट का पता चलता है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

क्वेरी पैरामीटर ब्यौरा
all यह फ़्लैग बताता है कि सभी एपीआई पैकेज वापस भेजने हैं या नहीं. अगर इसे false पर सेट किया जाता है, तो हर पेज पर दिखाए जाने वाले एपीआई पैकेज की संख्या, size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट रूप से, यह false पर सेट होती है.
size हर पेज पर दिखाए गए एपीआई पैकेज की संख्या. डिफ़ॉल्ट वैल्यू 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 ज़रूरी शर्तें
एपीआई उपलब्ध कराने वाली कंपनी के तौर पर, आपको तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी, जैसे कि Worldpay को सेट अप करना होगा. इसके लिए, आपको ये काम करने होंगे:
1 फ़्लो को ट्रिगर करने के लिए, एपीआई का इस्तेमाल करने वाला व्यक्ति डेवलपर पोर्टल में इनमें से कोई एक टास्क करता है:
  • इस कुकी का इस्तेमाल किसी खाते में पैसे जोड़ने के लिए किया जाता है
  • खाते में पैसे कम होने पर भी, किराया प्लान स्वीकार करता है
2 डेवलपर पोर्टल, डेवलपर के लिए Edge के ज़रिए पेमेंट शुरू करता है. इसमें सेवा देने वाली कंपनी का आईडी, रीलोड की रकम, और मुद्रा शामिल होती है. पेमेंट शुरू करने के लिए एपीआई का इस्तेमाल करने के बारे में जानकारी पाने के लिए, पेमेंट की सुविधा देने वाली कंपनी का इस्तेमाल करके, प्रीपेड खाते में पेमेंट शुरू करना लेख पढ़ें.
3 Edge, आईडी के हिसाब से प्रोवाइडर का पता लगाता है और यह तय करता है कि यह Worldpay खाता है.
4 Edge, ऑर्डर कोड जनरेट करता है.
5 Edge, Worldpay पर पेमेंट ऑर्डर बनाता है.
6 Worldpay, ऑर्डर के लिए एक रेफ़रंस आईडी और उसे पूरा करने के लिए, सीमित समय के लिए मान्य यूआरएल भेजता है.
7 Worldpay के जवाब को सामान्य Edge /payment API के जवाब में बदल दिया जाता है. इसके बाद, इसे डेवलपर पोर्टल को वापस भेज दिया जाता है, ताकि दूसरे चरण में शुरू किया गया कॉल पूरा किया जा सके. जैसे:
{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}
8 डेवलपर पोर्टल, कॉलबैक यूआरएल (जैसे, अनुरोध पूरा होने, अनुरोध पूरा न होने वगैरह के लिए) को यूआरएल में क्वेरी पैरामीटर के तौर पर जोड़ता है.
9 डेवलपर पोर्टल, पहले चरण में किए गए अनुरोध का जवाब देता है. इसके लिए, वह एपीआई का इस्तेमाल करने वाले व्यक्ति के ब्राउज़र को बदले गए यूआरएल पर रीडायरेक्ट करता है.
10 एपीआई का इस्तेमाल करने वाला व्यक्ति या कंपनी, आवेदन फ़ॉर्म भरती है और Worldpay के साथ प्रोसेसिंग शुरू करती है.
11 Worldpay, बिलिंग की जानकारी इकट्ठा करता है और पेमेंट को प्रोसेस करता है. लेन-देन पूरा होने पर, Worldpay, मैसेज की पुष्टि करने वाला कोड (एमएसी) जनरेट करता है. इसके लिए, Worldpay और डेवलपर पोर्टल, दोनों पर कॉन्फ़िगर किए गए एमएसी सीक्रेट का इस्तेमाल किया जाता है.
12 Worldpay, एपीआई का इस्तेमाल करने वाले व्यक्ति या कंपनी के ब्राउज़र को, चरण 8 में दिए गए कॉल बैक यूआरएल पर रीडायरेक्ट करता है. साथ ही, एमएसी को क्वेरी पैरामीटर और रकम के तौर पर जोड़ता है.
13 ब्राउज़र, डेवलपर पोर्टल पर मौजूद यूआरएल को अनुरोध की गई रकम और मैक पते के साथ कॉल करता है.
14 पोर्टल, MAC की पुष्टि MAC सीक्रेट से करता है. एमएसी की मदद से, कोई व्यक्ति यह दावा नहीं कर सकता कि पेमेंट हो गया है.
15 डेवलपर पोर्टल, प्रीपेड खाते में बाकी बैलेंस को फिर से लोड करने के लिए Edge को अनुरोध भेजता है. खाते में बाकी बैलेंस को फिर से लोड करने के लिए एपीआई का इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके प्रीपेड खाते में बाकी बैलेंस को फिर से लोड करना लेख पढ़ें.

यहां दिए गए सेक्शन में, तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी का इस्तेमाल करके, प्रीपेड बैलेंस मैनेज करने का तरीका बताया गया है:

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. एक्सएमएल पासवर्ड और मैसेज की पुष्टि करने वाले कोड (एमएसी) का सीक्रेट कुंजी सेट करें:
    1. प्रोफ़ाइल पर क्लिक करें.
    2. XML पासवर्ड फ़ील्ड में, Edge में Worldpay पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करते समय इस्तेमाल किया जाने वाला पासवर्ड सेट करें.
    3. रीडायरेक्ट किए गए MAC का सीक्रेट फ़ील्ड में, 20 से 30 वर्णों वाला MAC सीक्रेट पासकोड डालें.
    4. प्रोफ़ाइल सेव करें पर क्लिक करें
  4. कारोबारी या कंपनी के आईपी पतों (अनुमति वाली सूची) की सूची में Apigee Edge मैनेजमेंट सर्वर जोड़ें:
    1. प्रोफ़ाइल > कारोबारी या कंपनी का एनवायरमेंट पर क्लिक करें.
    2. नया टेस्ट आईपी पर क्लिक करें.
    3. Apigee Edge मैनेजमेंट सर्वर के लिए आईपी पता डालें.
    4. सेव करें पर क्लिक करें.
  5. Worldpay पैरामीटर जोड़ने के लिए, कारोबारी या कंपनी का यूआरएल कॉन्फ़िगर करें. इसमें तरीका पुष्टि करने का कोड (एमएसी) शामिल है:
    1. इंस्टॉलेशन > होस्ट किए गए पेमेंट पेज > पेमेंट पेज डिज़ाइनर पर क्लिक करें.
    2. पेमेंट पेज में बदलाव करें में जाकर, चैनल चुनें ड्रॉप-डाउन सूची से अपना इंस्टॉलेशन आईडी चुनें.
    3. प्रॉपर्टी टैब पर, कारोबारी या कंपनी के कॉन्फ़िगरेशन में बदलाव करें को चुनें.
    4. 'यूआरएल पैरामीटर भेजें' की वैल्यू को True पर सेट करें.
    5. पब्लिश करें टैब पर क्लिक करें.
    6. बदलावों को इस तरह प्रमोट करें:
      • टेस्ट एनवायरमेंट के लिए, डिज़ाइन में जाकर प्रमोट करें पर क्लिक करें, ताकि डिज़ाइन से सैंडबॉक्स में प्रमोट किया जा सके.
      • प्रोडक्शन एनवायरमेंट के लिए, सैंडबॉक्स से प्रोडक्शन पर प्रमोट करने के लिए, सैंडबॉक्स में जाकर प्रमोट करें पर क्लिक करें.

Edge में पेमेंट की सुविधा देने वाली कंपनी को कॉन्फ़िगर करना

अगला चरण, Edge में पेमेंट की सुविधा देने वाली कंपनी को कॉन्फ़िगर करना है.

नीचे दिए गए एपीआई का इस्तेमाल करके, किसी खास संगठन के लिए पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर किया जा सकता है:

/organizations/{org-name}/providers

सिस्टम एडमिन के अधिकारों वाले Apigee Edge Private Cloud के ग्राहक, यहां दिए गए एपीआई का इस्तेमाल करके ग्लोबल पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर कर सकते हैं. हालांकि, ऐसा करना ज़रूरी नहीं है:

/config/providers

हर एपीआई को कॉल करते समय, आपको अनुरोध के मुख्य हिस्से में यह जानकारी देनी होगी:

पैरामीटर ब्यौरा ज़रूरी है
authType पेमेंट की सेवा देने वाली कंपनी ने यह इंस्टॉलेशन आईडी दिया है. हां
credential आपके Worldpay कारोबारी खाते के लिए, Base64-encoded क्रेडेंशियल (username:XMLpassword); username, कारोबारी कोड (सभी कैपिटल लेटर में) के बराबर होता है. साथ ही, XMLpassword उस एक्सएमएल पासवर्ड के बारे में बताता है जिसे आपने Worldpay कारोबारी खाता सेट अप करते समय पिछले चरण में सेट किया था. हां
description पेमेंट की सेवा देने वाली कंपनी के बारे में जानकारी. नहीं
endpoint पेमेंट की सेवा देने वाली कंपनी को ऐक्सेस करने के लिए एंडपॉइंट
  • टेस्ट खातों के लिए, इनका इस्तेमाल करें: https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp
  • प्रोडक्शन खातों के लिए, इसका इस्तेमाल करें: https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp
हां
merchantCode पेमेंट की सेवा देने वाली कंपनी की ओर से, एपीआई का इस्तेमाल करने वाले व्यक्ति या कंपनी को दिया गया कारोबारी या कंपनी का कोड हां
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 संगठन के लिए कॉन्फ़िगर किया गया है. इसके लिए, यहां दी गई संसाधन के लिए जीईटी अनुरोध जारी करें:

/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 के ज़रूरी मॉड्यूल चालू करें. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करना लेख पढ़ें.

पेमेंट की सुविधा देने वाली कंपनी का इस्तेमाल करके, प्रीपेड खाते में पेमेंट करना

प्रीपेड खाते को मैनेज करने के फ़्लो के दूसरे चरण में दिखाए गए तरीके के मुताबिक, पेमेंट की सुविधा देने वाली कंपनी का इस्तेमाल करके प्रीपेड खाते में पेमेंट डेवलपर पोर्टल से तब शुरू किया जाता है, जब एपीआई का इस्तेमाल करने वाले लोग:

  • दर प्लान स्वीकार कर लिया है, लेकिन प्रीपेड खाते में ज़रूरी रकम नहीं है
  • प्रीपेड खाते में पैसे जोड़ने का अनुरोध करें.

एपीआई का इस्तेमाल करके, तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी से पेमेंट शुरू करने के लिए, इस संसाधन को 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"
}

Worldpay Secure Payment पेज का यूआरएल, referenceUrl में दिखता है. इसमें आपकी यूनीक ऑर्डर कुंजी, क्वेरी पैरामीटर के तौर पर जोड़ी जाती है.

एपीआई का इस्तेमाल करके, प्रीपेड खाते में बाकी बैलेंस फिर से लोड करना

प्रीपेड खाते को मैनेज करने के फ़्लो के 15वें चरण में दिखाए गए तरीके के मुताबिक, पेमेंट की सुविधा देने वाली कंपनी से पेमेंट प्रोसेस होने की पुष्टि मिलने के बाद, डेवलपर पोर्टल, Edge को प्रीपेड खाते को फिर से लोड करने का अनुरोध भेजता है.

डेवलपर या कंपनी के लिए उपलब्ध एपीआई का इस्तेमाल करके, प्रीपेड खाते में बाकी बैलेंस को फिर से लोड किया जा सकता है. इसके बारे में यहां बताया गया है.

किसी डेवलपर के प्रीपेड खाते में बैलेंस फिर से लोड करना

एपीआई का इस्तेमाल करके, किसी डेवलपर के प्रीपेड खाते में बाकी बैलेंस फिर से लोड करने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-balances पर एक POST अनुरोध करें. यहां {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

अनुरोध की प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खाते को रीलोड करने के लिए अनुरोध की प्रॉपर्टी की खास जानकारी देखें.

किसी कंपनी के प्रीपेड खाते में बैलेंस फिर से लोड करना

एपीआई का इस्तेमाल करके, किसी कंपनी के प्रीपेड खाते में बाकी बैलेंस फिर से लोड करने के लिए, /mint/organizations/{org_name}/companies/{company_id}/developer-balances पर POST अनुरोध भेजें. यहां {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

अनुरोध की प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खाते को रीलोड करने के लिए अनुरोध की प्रॉपर्टी की खास जानकारी देखें.

प्रीपेड खाते को रीलोड करने के लिए, अनुरोध की प्रॉपर्टी के बारे में खास जानकारी

एपीआई का इस्तेमाल करके प्रीपेड खाते में बैलेंस फिर से लोड करते समय, इन प्रॉपर्टी की जानकारी देना ज़रूरी है:

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
amount

प्रीपेड बैलेंस में जोड़ी गई रकम (लागू होने वाली मुद्रा में).

लागू नहीं हां
supportedCurrency

प्रीपेड बैलेंस के लिए इस्तेमाल की गई मुद्रा. यह वह मुद्रा है जिसे डेवलपर ने खरीदे गए एपीआई पैकेज में प्लान के लिए सेट अप किया था.

लागू नहीं हां

पेमेंट की सुविधा देने वाली तीसरे पक्ष की कंपनियों के खाते मिटाना

अपने Edge संगठन के लिए कॉन्फ़िगर किए गए तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी को मिटाया जा सकता है. इसके लिए, आपको यहां दी गई संसाधन के लिए DELETE अनुरोध भेजना होगा:

किसी संगठन के लिए, पेमेंट की सेवा देने वाली कंपनी को मिटाने के लिए, इस एपीआई का इस्तेमाल करें:

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

सिस्टम एडमिन के अधिकारों वाले Apigee Edge Private Cloud के ग्राहक, चाहें, तो यहां दिए गए एपीआई का इस्तेमाल करके ग्लोबल पेमेंट की सेवा देने वाली कंपनी को मिटा सकते हैं:

/config/providers/id

उदाहरण के लिए, यहां दिया गया कमांड, myorg के लिए कॉन्फ़िगर किए गए तीसरे पक्ष के पेमेंट प्लैटफ़ॉर्म को मिटा देता है:

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

प्रीपेड खाते के बैलेंस को मैन्युअल तरीके से मैनेज करना

इसके अलावा, मैन्युअल तरीके से या इंटिग्रेट किए गए बिलिंग सिस्टम के ज़रिए पेमेंट ट्रैक करके, प्रीपेड बैलेंस को फिर से लोड किया जा सकता है. इसके बाद, खाते में बाकी बैलेंस को फिर से लोड करने के लिए Monetization API को कॉल किया जा सकता है. इसके बारे में एपीआई का इस्तेमाल करके प्रीपेड खाते का बैलेंस फिर से लोड करना लेख में बताया गया है.

एपीआई का इस्तेमाल करके, प्रीपेड खाते में अपने-आप रकम लोड होने की सुविधा सेट अप करना

यहां दिए गए सेक्शन में, तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी का इस्तेमाल करने वाले डेवलपर या कंपनी के लिए, प्रीपेड खाते के बैलेंस को अपने-आप रीलोड होने की सुविधा सेट अप करने का तरीका बताया गया है. इस विकल्प का इस्तेमाल, रेट प्लान के लिए बार-बार होने वाले पेमेंट को मैनेज करने के लिए किया जाता है.

किसी डेवलपर के लिए, प्रीपेड खाते के बैलेंस अपने-आप रिलोड होने की सुविधा सेट अप करना

जब किसी डेवलपर के प्रीपेड खाते का बैलेंस तय थ्रेशोल्ड से कम हो जाता है, तब उसके खाते में अपने-आप पैसे जुड़ने की सुविधा सेट अप करने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup पर POST अनुरोध भेजें. यहां {developer_id} डेवलपर का ईमेल पता है.

अनुरोध करते समय, आपको यह जानकारी देनी होगी:

  • खाते में फिर से पैसे डालने के लिए, पेमेंट की सेवा देने वाली कंपनी का आईडी (providerID)
  • यह फ़्लैग, ऑटो-रीलोड की सुविधा चालू करता है (isRecurring)
  • वह थ्रेशोल्ड जिससे कम होने पर, प्रीपेड खाते में बाकी बैलेंस में अपने-आप पैसे जुड़ने की सुविधा ट्रिगर हो जाती है (replenishAmount)
  • खाते में अपने-आप जुड़ने वाली रकम (recurringAmount)
  • मुद्रा की जानकारी देने के लिए, supportedCurrencyID क्वेरी पैरामीटर.

इस उदाहरण में, जब डेवलपर के प्रीपेड खाते में बाकी बैलेंस पांच डॉलर से कम हो जाता है, तो खाते में अपने-आप 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

अनुरोध की प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खातों में अपने-आप रीलोड होने की सुविधा सेट अप करने के लिए, अनुरोध की प्रॉपर्टी के बारे में खास जानकारी देखें.

किसी कंपनी के लिए, प्रीपेड खाते के बैलेंस अपने-आप रिलोड होने की सुविधा सेट अप करना

किसी कंपनी के प्रीपेड खाते में, बैलेंस तय सीमा से कम होने पर अपने-आप पैसे जुड़ने की सुविधा सेट अप करने के लिए, /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup पर POST अनुरोध भेजें. यहां {company_id} कंपनी का आईडी है.

अनुरोध करते समय, आपको यह जानकारी देनी होगी:

  • खाते में फिर से पैसे डालने के लिए, पेमेंट की सेवा देने वाली कंपनी का आईडी (providerID)
  • यह फ़्लैग, ऑटो-रीलोड की सुविधा चालू करता है (isRecurring)
  • वह थ्रेशोल्ड जिससे कम होने पर, प्रीपेड खाते में बाकी बैलेंस में अपने-आप पैसे जुड़ने की सुविधा ट्रिगर हो जाती है (replenishAmount)
  • खाते में अपने-आप जुड़ने वाली रकम (recurringAmount)
  • मुद्रा की जानकारी देने के लिए, supportedCurrencyID क्वेरी पैरामीटर.

इस उदाहरण में, जब कंपनी के प्रीपेड खाते में बाकी बैलेंस पांच डॉलर से कम हो जाता है, तो खाते में अपने-आप 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

अनुरोध की प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खातों में अपने-आप रीलोड होने की सुविधा सेट अप करने के लिए, अनुरोध की प्रॉपर्टी के बारे में खास जानकारी देखें.

प्रीपेड खातों के लिए, अपने-आप रिलोड होने की सुविधा सेट अप करने के अनुरोध की प्रॉपर्टी के बारे में खास जानकारी

एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस को अपने-आप रीलोड करने की सुविधा चालू करते समय, इन एट्रिब्यूट की वैल्यू दी जा सकती है.

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
providerId

पेमेंट की सुविधा देने वाली कंपनी का आईडी.

लागू नहीं हां
chargePerUsage गलत नहीं
isRecurring

इस फ़्लैग से पता चलता है कि अपने-आप बैलेंस लोड होने की सुविधा चालू है (true) या नहीं. अपने-आप बैलेंस लोड होने की सुविधा बंद करने के लिए, इस फ़्लैग को false पर सेट करें.

लागू नहीं हां
replenishAmount

वह थ्रेशोल्ड जिससे कम होने पर, प्रीपेड खाते में बाकी बैलेंस में अपने-आप पैसे जुड़ने की सुविधा ट्रिगर हो जाती है.

लागू नहीं हां
recurringAmount

ऑटोमैटिक रीलोड की सुविधा चालू होने पर, प्रीपेड खाते में बाकी बैलेंस में जोड़ी जाने वाली रकम.

लागू नहीं हां

WorldPay के होस्ट किए गए पेमेंट पेजों पर माइग्रेट करना

WorldPay ने पेमेंट प्रोसेस करने के सुरक्षित तरीके को अपडेट किया है. अब यह नए पेजों का इस्तेमाल करता है. इन्हें होस्ट किए गए पेमेंट पेज कहा जाता है.

अगर आपने WorldPay पेमेंट की सेवा देने वाली कंपनी को, सुरक्षित पेमेंट प्रोसेसिंग के बंद हो चुके तरीके (अगस्त 2017 से पहले) का इस्तेमाल करके कॉन्फ़िगर किया है, तो आपको जनवरी 2018 से पहले, WorldPay के नए Hosted Payment Pages पर डेटा दूसरी जगह भेजना होगा.

WorldPay के होस्ट किए गए पेमेंट पेजों पर माइग्रेट करने के लिए:

  1. अपने मौजूदा खाते को माइग्रेट करने के लिए, WorldPay से संपर्क करें. इससे आपको नए Hosted Payment Pages का इस्तेमाल करने और अपने खाते के लिए नया installation ID पाने में मदद मिलेगी.
  2. Edge में पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करना में बताए गए तरीके से, WorldPay की पेमेंट की सेवा देने वाली नई कंपनियों को कॉन्फ़िगर करें. साथ ही, authType फ़ील्ड में इंस्टॉलेशन आईडी पास करें.
  3. अपने डेवलपर पोर्टल पर, नए पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करें. इसके लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करना लेख पढ़ें.
  4. अगर आपने पेमेंट की सुविधा देने वाली कंपनी का इस्तेमाल करके, प्रीपेड खाते में अपने-आप रीलोड होने की सुविधा सेट अप की है, तो आपको नए प्रोवाइडर आईडी का इस्तेमाल करने के लिए, अपने-आप रीलोड होने की सुविधा को फिर से कॉन्फ़िगर करना होगा. इसके बारे में एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस अपने-आप रीलोड होने की सुविधा सेट अप करना लेख में बताया गया है.

अगले चरण

पोस्टपेड प्लान इस्तेमाल करने वाले हर डेवलपर के लिए, क्रेडिट लिमिट सेट की जा सकती है. इसके बारे में पोस्टपेड बैलेंस मैनेज करना लेख में जानें.