Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
प्रीपेड खाते में बैलेंस मैनेज करने के लिए:
- प्रीपेड खाते में मौजूदा बैलेंस देखें. एपीआई का इस्तेमाल करके, प्रीपेड खाते का बैलेंस देखना लेख पढ़ें.
- तीसरे पक्ष के पेमेंट प्रोवाइडर, जैसे कि Worldpay का इस्तेमाल करके, खाते के बैलेंस को ज़रूरत के हिसाब से रीचार्ज करें (पैसे जोड़ें). तीसरे पक्ष के पेमेंट प्रोवाइडर का इस्तेमाल करके, प्रीपेड बैलेंस मैनेज करना लेख पढ़ें.
इसके अलावा, पेमेंट को मैन्युअल तरीके से या इंटिग्रेट किए गए बिलिंग सिस्टम की मदद से ट्रैक करके भी रीलोड को मैनेज किया जा सकता है. इसके बाद, खाते को रीलोड करने के लिए, कमाई करने वाले एपीआई को कॉल करें. इस बारे में पहले से खरीदे गए बैलेंस को मैन्युअल तरीके से मैनेज करना में बताया गया है.
- कमाई करने के एपीआई और Worldpay जैसे किसी तीसरे पक्ष की पेमेंट सेवा का इस्तेमाल करके, प्रीपेड खाते का बैलेंस तय थ्रेशोल्ड से कम होने पर, अपने-आप फिर से लोड होने की सुविधा सेट अप करें. यह विकल्प, किराये के प्लान के लिए बार-बार होने वाले पेमेंट को मैनेज करने के लिए मददगार है. ज़्यादा जानकारी के लिए, एपीआई का इस्तेमाल करके, रिचार्ज किए गए खाते के बैलेंस को अपने-आप फिर से लोड होने की सुविधा सेट अप करना लेख पढ़ें.
मैं प्रीपेड खाते में बचे बैलेंस का हिसाब कैसे लगाऊं?
किसी डेवलपर या कंपनी के लिए प्रीपेड खाते का बैलेंस देखते समय, आपको रिस्पॉन्स से ये वैल्यू पाने की ज़रूरत है, जैसा कि नीचे दिए गए सेक्शन में बताया गया है:
amount
: मौजूदा बिलिंग अवधि के लिए उपलब्ध कुल रकम. इस सेक्शन में बताए गए तरीकों का इस्तेमाल करके, रिचार्ज करने पर, यह वैल्यू अपडेट हो जाती है.usage
: मौजूदा बिलिंग अवधि के दौरान इस्तेमाल की गई कुल रकम. यह वैल्यू, कमाई करने की ज़रूरी शर्तें पूरी करने वाले हर लेन-देन या क्रेडिट जारी करने (पॉज़िटिव या नेगेटिव) पर अपडेट की जाती है.
मौजूदा बिलिंग अवधि के लिए प्रीपेड खाते के बाकी बचे पैसे का हिसाब, amount
की वैल्यू से usage
की वैल्यू को घटाकर लगाया जा सकता है. उदाहरण के लिए, अगर amount
की वैल्यू 335.50 और usage
की वैल्यू 34 है, तो बाकी बचे बैलेंस का हिसाब इस तरह लगाया जाएगा:
amount(335.50) - usage(34) = 229.50
एपीआई का इस्तेमाल करके प्रीपेड खाते में बाकी बैलेंस देखना
नीचे दिए गए सेक्शन में, एपीआई का इस्तेमाल करके किसी डेवलपर या कंपनी के लिए, रिचार्ज किए गए खाते का बैलेंस देखने का तरीका बताया गया है.
किसी डेवलपर के प्रीपेड खाते का बैलेंस देखना
किसी डेवलपर के प्रीपेड खाते में बाकी बैलेंस देखने के लिए, इनमें से किसी एक एपीआई को जीईटी अनुरोध जारी करें. यहां डेवलपर का ईमेल पता {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 का इस्तेमाल करके, रिचार्ज किए गए खाते के बैलेंस को कैसे मैनेज किया जाता है.
नीचे दी गई टेबल में प्रीपेड खाते के बैलेंस को मैनेज करने के फ़्लो के हर चरण के बारे में बताया गया है. जैसा कि ऊपर दिखाया गया है.
चरण | ब्यौरा |
---|---|
0 |
ज़रूरी शर्तें एपीआई की सेवा देने वाली कंपनी के तौर पर, पेमेंट की सेवा देने वाली तीसरे पक्ष की कंपनी (जैसे, Worldpay) सेट अप करने के लिए, आपको ये काम करने होंगे: |
1 |
फ़्लो को ट्रिगर करने के लिए, एपीआई का इस्तेमाल करने वाला व्यक्ति डेवलपर पोर्टल में इनमें से कोई एक काम करता है:
|
2 | डेवलपर पोर्टल, डेवलपर के लिए Edge के ज़रिए पेमेंट शुरू करता है. इसके लिए, सेवा देने वाली कंपनी का आईडी, रीचार्ज की रकम, और मुद्रा की जानकारी की ज़रूरत होती है. पेमेंट शुरू करने के लिए एपीआई का इस्तेमाल करने के बारे में जानकारी पाने के लिए, पेमेंट प्रोवाइडर का इस्तेमाल करके, प्रीपेड खाते में पेमेंट शुरू करना लेख पढ़ें. |
3 | Edge, आईडी के हिसाब से प्रोवाइडर ढूंढता है और यह पता लगाता है कि यह Worldpay खाता है. |
4 | Edge, ऑर्डर कोड जनरेट करता है. |
5 | Edge, Worldpay पर पेमेंट ऑर्डर बनाता है. |
6 | Worldpay, ऑर्डर के लिए रेफ़रंस आईडी और उसे पूरा करने के लिए, समयसीमा वाला यूआरएल दिखाता है. |
7 |
Worldpay से मिले जवाब को एज /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, एपीआई उपभोक्ता के ब्राउज़र को काम के कॉलबैक यूआरएल (आठवें चरण से) पर रीडायरेक्ट करती है. इसमें एमएसी को क्वेरी पैरामीटर के तौर पर जोड़कर और रकम शामिल होती है. |
13 | ब्राउज़र, अनुरोध की गई रकम और मैक कोड के साथ डेवलपर पोर्टल पर यूआरएल को कॉल करता है. |
14 | पोर्टल, MAC को MAC सीक्रेट के हिसाब से पुष्टि करता है. एमएसी की मदद से, किसी व्यक्ति को मनमुताबिक यह दावा करने से रोका जा सकता है कि पेमेंट हो गया है. |
15 | डेवलपर पोर्टल, प्रीपेड खाते के बैलेंस को फिर से लोड करने के लिए Edge को अनुरोध भेजता है. खाते के बैलेंस को फिर से लोड करने के लिए, एपीआई का इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके, प्रीपेड खाते का बैलेंस फिर से लोड करना लेख पढ़ें. |
यहां दिए गए सेक्शन में, तीसरे पक्ष के पेमेंट प्रोवाइडर का इस्तेमाल करके, रिचार्ज किए गए बैलेंस को मैनेज करने के लिए ज़रूरी चरणों के बारे में बताया गया है:
- Worldpay पेमेंट प्रोवाइडर की मदद से मर्चेंट खाता सेट अप करना
- Edge में पेमेंट प्रोवाइडर को कॉन्फ़िगर करना
- आपके संगठन के लिए कॉन्फ़िगर किए गए, पेमेंट की सेवा देने वाली कंपनियों की जानकारी देखना
- डेवलपर पोर्टल में ज़रूरी मॉड्यूल चालू और कॉन्फ़िगर करना
- पेमेंट की सेवा देने वाली कंपनी की मदद से, प्रीपेड खाते में पेमेंट करना
- एपीआई का इस्तेमाल करके, प्रीपेड खाते में बैलेंस फिर से लोड करना
- पेमेंट की सेवा देने वाली तीसरे पक्ष की कंपनी को मिटाना
पेमेंट प्रोवाइडर Worldpay के साथ मर्चेंट खाता सेट अप करना
शुरू करने से पहले, आपको अपने व्यापारी खाते सेट अप करने के लिए, तीसरे पक्ष की पेमेंट सेवा देने वाली कंपनी (Worldpay) से संपर्क करना होगा. हमारा सुझाव है कि आप दो खाते सेट अप करें. एक टेस्टिंग के लिए और दूसरा प्रोडक्शन के लिए. Worldpay के व्यापारी खातों के बारे में ज़्यादा जानकारी पाने के लिए, www.worldpay.com और wp-support.crm.worldpay.com (Worldpay सहायता केंद्र) पर जाएं.
अपना व्यापारी खाता सेट अप करने और खाते के क्रेडेंशियल पाने के बाद, अपने व्यापारी खाते को Worldpay के साथ कॉन्फ़िगर करने के लिए:
- https://secure.worldpay.com/sso/public/auth/login.html पर जाएं.
- Worldpay से मिले क्रेडेंशियल का इस्तेमाल करके, अपने Worldpay खाते में लॉग इन करें.
- एक्सएमएल पासवर्ड और मैसेज की पुष्टि करने वाले कोड (एमएसी) की गुप्त कुंजी सेट करें:
- प्रोफ़ाइल पर क्लिक करें.
- Edge में Worldpay पेमेंट प्रोवाइडर को कॉन्फ़िगर करते समय इस्तेमाल करने के लिए पासवर्ड सेट करें. इसके लिए, एक्सएमएल पासवर्ड फ़ील्ड में जाएं.
- रीडायरेक्ट करने के लिए MAC की सीक्रेट पासकोड फ़ील्ड में, 20 से 30 वर्ण वाली सीक्रेट पासकोड डालें.
- प्रोफ़ाइल सेव करें पर क्लिक करें
- Apigee Edge मैनेजमेंट सर्वर को व्यापारी/कंपनी/कारोबारी के आईपी (अनुमति वाली सूची) की सूची में जोड़ें:
- प्रोफ़ाइल > कारोबारी/कंपनी का एनवायरमेंट पर क्लिक करें.
- नया टेस्ट आईपी पर क्लिक करें.
- Apigee Edge मैनेजमेंट सर्वर का आईपी डालें.
- सेव करें पर क्लिक करें.
- Worldpay पैरामीटर जोड़ने के लिए, मर्चेंट यूआरएल को कॉन्फ़िगर करें. इसमें पुष्टि करने के तरीके का कोड (एमएसी) भी शामिल है:
- इंस्टॉलेशन > होस्ट किए गए पेमेंट पेज > पेमेंट पेज डिज़ाइनर पर क्लिक करें.
- पेमेंट पेजों में बदलाव करें में जाकर, चैनल चुनें ड्रॉप-डाउन सूची से अपना इंस्टॉलेशन आईडी चुनें.
- प्रॉपर्टी टैब में, व्यापारी/कंपनी/कारोबारी के कॉन्फ़िगरेशन में बदलाव करें को चुनें.
- 'यूआरएल भेजें' पैरामीटर की वैल्यू को True पर सेट करें.
- पब्लिश करें टैब पर क्लिक करें.
- बदलावों का प्रमोशन इस तरह करें:
- टेस्ट एनवायरमेंट के लिए, डिज़ाइन से सैंडबॉक्स में प्रमोट करने के लिए, डिज़ाइन में जाकर प्रमोट करें पर क्लिक करें.
- सैंडबॉक्स से प्रोडक्शन में प्रमोशन करने के लिए, प्रोडक्शन एनवायरमेंट में, सैंडबॉक्स में जाकर प्रमोट करें पर क्लिक करें.
Edge में पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करना
अगला चरण, Edge में पेमेंट प्रोवाइडर को कॉन्फ़िगर करना है.
नीचे दिए गए एपीआई का इस्तेमाल करके, किसी खास संगठन के लिए पेमेंट प्रोवाइडर को कॉन्फ़िगर किया जा सकता है:
/organizations/{org-name}/providers
Apigee Edge के निजी क्लाउड ग्राहक जिनके पास sys के एडमिन के अधिकार हैं, वे इस एपीआई का इस्तेमाल करके, ग्लोबल पेमेंट की सेवा देने वाली कंपनी को वैकल्पिक तौर पर कॉन्फ़िगर कर सकते हैं:
/config/providers
हर एपीआई को कॉल करते समय, आपको अनुरोध बॉडी में यह जानकारी देनी होगी:
पैरामीटर | जानकारी | ज़रूरी है |
authType |
पेमेंट की सेवा देने वाली कंपनी से मिला इंस्टॉलेशन आईडी. | हां |
credential |
आपके Worldpay व्यापारी/कंपनी खाते के लिए, Base64 में कोड किए गए क्रेडेंशियल (username:XMLpassword ); username , व्यापारी/कंपनी कोड (सभी कैप में) के बराबर है और XMLpassword , उस एक्सएमएल पासवर्ड की जानकारी देता है जिसे आपने Worldpay व्यापारी/कंपनी खाता सेट अप करते समय, पिछले चरण में सेट किया था. |
हां |
description |
पेमेंट की सेवा देने वाली कंपनी के बारे में जानकारी. | नहीं |
endpoint |
पेमेंट की सेवा देने वाली कंपनी को ऐक्सेस करने के लिए एंडपॉइंट
|
हां |
merchantCode |
पेमेंट की सेवा देने वाली कंपनी से, एपीआई का इस्तेमाल करने वाले व्यक्ति या कंपनी को मिला व्यापारी कोड | हां |
name |
सेवा देने वाली कंपनी का नाम.
Apigee Edge के Private Cloud के ग्राहक: दुनिया भर में पेमेंट की सेवा देने वाली कंपनियों को यह पक्का करना होगा कि वे सभी Edge संगठनों के लिए अलग-अलग हों. हमारा सुझाव है कि आप प्रोवाइडर के नाम में WorldPay (बड़े और छोटे अक्षरों में कोई फ़र्क़ नहीं पड़ता) शामिल करें, ताकि उसे आसानी से पहचाना जा सके. उदाहरण के लिए: |
हां |
उदाहरण के लिए, नीचे दी गई चीज़ें 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 के ज़रूरी मॉड्यूल चालू करें. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करना देखें.
पेमेंट की सेवा देने वाली कंपनी का इस्तेमाल करके, प्रीपेड खाते में पेमेंट करना
जैसा कि प्रीपेड खाते के मैनेजमेंट फ़्लो के दूसरे चरण में दिखाया गया है, पेमेंट प्रोवाइडर का इस्तेमाल करके प्रीपेड खाते में पेमेंट करने की प्रोसेस, डेवलपर पोर्टल से शुरू की जाती है. ऐसा तब होता है, जब एपीआई का इस्तेमाल करने वाले:
- किराये का प्लान स्वीकार कर लिया है, लेकिन प्रीपेड खाते में पैसे कम हैं
- अपने प्रीपेड खाते में पैसे जोड़ने का अनुरोध करें.
एपीआई का इस्तेमाल करके, पेमेंट की सेवा देने वाली किसी तीसरे पक्ष की कंपनी से पेमेंट करने के लिए, नीचे दिए गए संसाधन पर पोस्ट अनुरोध
जारी करें. इसमें, {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 के सुरक्षित पेमेंट पेज का यूआरएल, referenceUrl
में दिखाया जाता है. इसमें क्वेरी पैरामीटर के तौर पर, आपके ऑर्डर की यूनीक कुंजी जोड़ी जाती है.
एपीआई का इस्तेमाल करके, प्रीपेड खाते का बैलेंस फिर से लोड करना
जैसा कि प्रीपेड खाते के मैनेजमेंट फ़्लो के चरण 15 में दिखाया गया है, पेमेंट की सेवा देने वाली कंपनी के प्रोसेस हो जाने की पुष्टि होने के बाद, डेवलपर पोर्टल एज को अनुरोध भेजता है कि प्रीपेड खाते को फिर से लोड किया जाए.
किसी डेवलपर या कंपनी के लिए एपीआई का इस्तेमाल करके, प्रीपेड खाते में बाकी बैलेंस को फिर से लोड किया जा सकता है. इसके बारे में इन सेक्शन में बताया गया है.
डेवलपर के लिए, प्रीपेड खाते में बैलेंस फिर से लोड करना
एपीआई का इस्तेमाल करके, किसी डेवलपर के लिए प्रीपेड खाते का बैलेंस फिर से लोड करने के लिए, /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
अनुरोध प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खाते को फिर से रिचार्ज करने के लिए, अनुरोध प्रॉपर्टी की खास जानकारी देखें.
किसी कंपनी के प्रीपेड खाते में बैलेंस फिर से लोड करना
एपीआई का इस्तेमाल करके, किसी कंपनी के प्रीपेड खाते का बैलेंस फिर से लोड करने के लिए, /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
अनुरोध प्रॉपर्टी के बारे में जानकारी पाने के लिए, प्रीपेड खाते को फिर से रिचार्ज करने के लिए, अनुरोध प्रॉपर्टी की खास जानकारी देखें.
प्रीपेड खाते को फिर से लोड करने के लिए, अनुरोध की प्रॉपर्टी की खास जानकारी
एपीआई का इस्तेमाल करके प्रीपेड खाते के बैलेंस को फिर से लोड करते समय, इन प्रॉपर्टी के बारे में बताना ज़रूरी है:
नाम | ब्यौरा | डिफ़ॉल्ट | ज़रूरी है? |
---|---|---|---|
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
प्रीपेड खाते के बैलेंस को मैन्युअल तरीके से मैनेज करना
इसके अलावा, पेमेंट को मैन्युअल तरीके से या किसी इंटिग्रेट किए गए बिलिंग सिस्टम की मदद से ट्रैक करके, रिचार्ज किए गए बैलेंस को मैनेज किया जा सकता है. इसके बाद, खाते को फिर से रिचार्ज करने के लिए, कमाई करने वाले एपीआई को कॉल किया जा सकता है. इस बारे में एपीआई का इस्तेमाल करके, रिचार्ज किए गए खाते के बैलेंस को फिर से रिचार्ज करना में बताया गया है.
एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस अपने-आप फिर से लोड होने की सुविधा सेट अप करना
नीचे दिए गए सेक्शन में, तीसरे पक्ष के पेमेंट प्रोवाइडर का इस्तेमाल करने वाले डेवलपर या कंपनी के लिए, रिचार्ज की सुविधा अपने-आप चालू होने की सुविधा सेट अप करने का तरीका बताया गया है. यह विकल्प, किराये के प्लान के लिए बार-बार होने वाले पेमेंट को मैनेज करने के लिए मददगार है.
किसी डेवलपर के लिए, प्रीपेड खाते के बैलेंस को अपने-आप रीलोड होने की सुविधा सेट अप करना
जब बैलेंस किसी तय थ्रेशोल्ड से कम हो जाए, तो डेवलपर के लिए, रिचार्ज किए गए खाते के बैलेंस को अपने-आप रिचार्ज होने की सुविधा सेट अप करने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup
पर पोस्ट अनुरोध करें. यहां {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
पर पोस्ट अनुरोध करें. यहां {company_id}, कंपनी का आईडी है.
अनुरोध करते समय, आपको यह जानकारी देनी होगी:
- खाता फिर से लोड करने के लिए, पेमेंट की सेवा देने वाली कंपनी का आईडी (
providerID
) - अपने-आप रीलोड होने की सुविधा चालू करने वाला फ़्लैग (
isRecurring
) - वह थ्रेशोल्ड जो अपने-आप फिर से लोड होने के लिए (
replenishAmount
) को ट्रिगर करने के लिए, प्रीपेड खाते का बैलेंस इससे कम होना चाहिए - खाते में अपने-आप जुड़ने वाली रकम (
recurringAmount
) - मुद्रा की जानकारी देने के लिए
supportedCurrencyID
क्वेरी पैरामीटर.
नीचे दिए गए उदाहरण में, जब कंपनी के प्रीपेड खाते का बैलेंस 500 रुपये से कम हो जाएगा, तब खाते में 1,000 रुपये अपने-आप जुड़ जाएंगे.
$ 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 |
यह फ़्लैग बताता है कि अपने-आप फिर से लोड होने की सुविधा चालू है या नहीं ( |
लागू नहीं | हां |
replenishAmount |
वह थ्रेशोल्ड जो प्रीपेड खाते में बाकी बैलेंस अपने-आप फिर से लोड होने की प्रोसेस शुरू करने के लिए इससे कम होना चाहिए. |
लागू नहीं | हां |
recurringAmount |
अपने-आप रीचार्ज होने की सुविधा चालू होने पर, प्री-पेड खाते के बैलेंस में जोड़ी जाने वाली रकम. |
लागू नहीं | हां |
WorldPay के होस्ट किए गए पेमेंट पेजों पर माइग्रेट करना
WorldPay ने पेमेंट प्रोसेस करने के अपने सुरक्षित फ़्लो को अपडेट किया है, ताकि पेजों के नए सेट का इस्तेमाल किया जा सके. इन पेजों को होस्ट किए गए पेमेंट पेज कहा जाता है.
अगर आपने अगस्त 2017 से पहले, सुरक्षित पेमेंट प्रोसेसिंग फ़्लो का इस्तेमाल करके, WorldPay के पेमेंट प्रोवाइडर को कॉन्फ़िगर किया है, तो आपको जनवरी 2018 से पहले, WorldPay के नए होस्ट किए गए पेमेंट पेजों पर माइग्रेट करना होगा.
WorldPay के होस्ट किए गए पेजों पर माइग्रेट करने के लिए:
- नए होस्ट किए गए पेमेंट पेजों का इस्तेमाल करने के लिए, अपने मौजूदा खाते को माइग्रेट करने के लिए WorldPay से संपर्क करें और अपने खाते के लिए एक नया इंस्टॉलेशन आईडी पाएं.
- Edge में पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करना में बताए गए तरीके से, WorldPay से पेमेंट करने वाली नई कंपनियों को कॉन्फ़िगर करें और
authType
फ़ील्ड में इंस्टॉलेशन आईडी पास करें. - अपने डेवलपर पोर्टल पर, पेमेंट के नए तरीकों को कॉन्फ़िगर करें. इसके लिए, डेवलपर पोर्टल में कमाई करने की सुविधा को कॉन्फ़िगर करना लेख पढ़ें.
- अगर आपने पेमेंट प्रोवाइडर का इस्तेमाल करके, प्रीपेड खाते में अपने-आप पैसे रिचार्ज होने की सुविधा सेट अप की है, तो आपको प्रोवाइडर के नए आईडी का इस्तेमाल करने के लिए, अपने-आप रिचार्ज होने की सुविधा को फिर से कॉन्फ़िगर करना होगा. इसके बारे में एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस को अपने-आप रिचार्ज होने की सुविधा सेट अप करना लेख में बताया गया है.
अगले चरण
अलग-अलग पोस्टपेड डेवलपर के लिए, क्रेडिट लिमिट सेट की जा सकती हैं. पोस्टपेड बैलेंस मैनेज करना लेख में जानें.