Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
प्रीपेड खाते का बैलेंस मैनेज करने के लिए, ये काम किए जा सकते हैं:
- मौजूदा प्रीपेड खाते में बाकी बैलेंस देखें. एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस देखना लेख पढ़ें.
- पेमेंट की सेवा देने वाली तीसरे पक्ष की कंपनी, जैसे कि Worldpay की मदद से,
खाते में ज़रूरत के मुताबिक बैलेंस फिर से लोड (पैसे जोड़ें) करें. पेमेंट की सेवा देने वाली तीसरे पक्ष की कंपनी की मदद से प्रीपेड बैलेंस मैनेज करना देखें.
इसके अलावा, फिर से लोड होने की प्रोसेस को मैन्युअल तरीके से या किसी इंटिग्रेट किए गए बिलिंग सिस्टम की मदद से ट्रैक किया जा सकता है. इसके बाद, कमाई करने वाले एपीआई को कॉल करके, खाते को फिर से लोड किया जा सकता है. प्रीपेड बैलेंस को मैन्युअल तरीके से मैनेज करना सेक्शन में बताया गया है.
- कमाई करने के एपीआई और पेमेंट की सेवा देने वाली तीसरे पक्ष की कंपनी, जैसे कि Worldpay का इस्तेमाल करके, प्रीपेड खाते का बैलेंस तय थ्रेशोल्ड से कम होने पर, अपने-आप फिर से लोड होने की सुविधा सेट अप करें. इस विकल्प से, रेट प्लान के लिए बार-बार होने वाले पेमेंट मैनेज किए जा सकते हैं. ज़्यादा जानकारी के लिए, एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस को अपने-आप फिर से लोड करने की सुविधा सेट अप करना देखें.
मैं शेष प्रीपेड खाते की शेष राशि की गणना कैसे करूं?
नीचे दिए गए सेक्शन में बताए गए तरीके से, किसी डेवलपर या कंपनी के प्रीपेड खाते में बाकी बैलेंस देखते समय, आपको रिस्पॉन्स से ये वैल्यू मिलनी होंगी:
amount
: मौजूदा बिलिंग अवधि के लिए उपलब्ध कुल रकम. इस सेक्शन में बताए गए तरीकों का इस्तेमाल करके, प्रीपेड खाते को फिर से फिर से लोड करने पर, यह वैल्यू अपडेट हो जाती है.usage
: मौजूदा बिलिंग अवधि के दौरान इस्तेमाल की गई कुल रकम. यह वैल्यू, कमाई करने के लिए किए गए हर ऐसे लेन-देन के साथ अपडेट की जाती है जो शर्तें पूरी करता हो. इसके अलावा, क्रेडिट जारी करके भी, यह वैल्यू अपडेट की जाती है. जैसे, पॉज़िटिव या नेगेटिव.
मौजूदा बिलिंग अवधि के लिए, प्रीपेड खाते के बाकी बचे पैसे का हिसाब लगाया जा सकता है. इसके लिए, आपको
amount
की वैल्यू से usage
वैल्यू को घटाना होगा. उदाहरण के लिए, अगर 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 पेमेंट की सेवा देने वाली कंपनी की मदद से, प्रीपेड खाते के बैलेंस को कैसे मैनेज किया जाता है.
इस टेबल में, प्रीपेड खाते के बैलेंस को मैनेज करने के फ़्लो के हर चरण के बारे में ऊपर बताया गया है.
चरण | ब्यौरा |
---|---|
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 और डेवलपर पोर्टल पर कॉन्फ़िगर किए गए MAC सीक्रेट का इस्तेमाल करके, Message Authentication Code (MAC) जनरेट करता है. |
12 | Worldpay, एपीआई के उपभोक्ता के ब्राउज़र को आठवें चरण से, प्रोसेस किए गए कॉलबैक यूआरएल पर रीडायरेक्ट करता है. यूआरएल, MAC को क्वेरी पैरामीटर के तौर पर जोड़ता है और रकम की जानकारी देता है. |
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 खाते में लॉग इन करें.
- एक्सएमएल पासवर्ड और मैसेज ऑथेंटिकेशन कोड (MAC) सीक्रेट कुंजी सेट करें:
- प्रोफ़ाइल पर क्लिक करें.
- वह पासवर्ड सेट करें जिसका इस्तेमाल करके, एक्सएमएल पासवर्ड फ़ील्ड में Edge में Worldpay पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर किया जा रहा है.
- रीडायरेक्ट MAC सीक्रेट फ़ील्ड में 20 से 30 वर्णों वाली MAC सीक्रेट कुंजी डालें.
- प्रोफ़ाइल सेव करें पर क्लिक करें
- व्यापारी/कंपनी/कारोबारी के आईपी की सूची (जिन लोगों या संगठनों को अनुमति मिली है) की सूची में Apigee Edge मैनेजमेंट सर्वर जोड़ें:
- प्रोफ़ाइल > कारोबारी प्लैटफ़ॉर्म पर क्लिक करें.
- नया टेस्ट आईपी पर क्लिक करें.
- Apigee Edge मैनेजमेंट सर्वर का आईपी डालें.
- सेव करें पर क्लिक करें.
- मर्चेंट यूआरएल कॉन्फ़िगर करें, ताकि वह Worldpay पैरामीटर जोड़ सके. इसमें, पुष्टि करने का कोड (MAC) भी शामिल है:
- इंस्टॉलेशन > होस्ट किए गए पेमेंट पेज > पेमेंट पेज डिज़ाइनर पर क्लिक करें.
- पेमेंट पेजों में बदलाव करें सेक्शन में, चैनल चुनें ड्रॉप-डाउन सूची से अपना इंस्टॉलेशन आईडी चुनें.
- प्रॉपर्टी टैब में, व्यापारी/कंपनी के कॉन्फ़िगरेशन में बदलाव करें चुनें.
- 'यूआरएल भेजें' पैरामीटर की वैल्यू को सही पर सेट करें.
- पब्लिश करें टैब पर क्लिक करें.
- यहां बताए गए तरीके से बदलावों को प्रमोट करें:
- टेस्ट एनवायरमेंट के लिए, डिज़ाइन से सैंडबॉक्स में प्रमोट करने के लिए, डिज़ाइन में जाकर, प्रमोशन करें पर क्लिक करें.
- प्रोडक्शन एनवायरमेंट के लिए, सैंडबॉक्स से प्रोडक्शन में प्रमोट करने के लिए, सैंडबॉक्स में जाकर, प्रमोशन करें पर क्लिक करें.
Edge में, पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करना
अगला चरण, Edge में पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करना है.
नीचे दिए गए एपीआई का इस्तेमाल करके, किसी संगठन के लिए पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर किया जा सकता है:
/organizations/{org-name}/providers
सिस्टम एडमिन के खास अधिकारों वाले सिर्फ़ Apigee Edge के निजी क्लाउड के ग्राहक, नीचे दिए गए एपीआई का इस्तेमाल करके, ग्लोबल पेमेंट प्रोवाइडर को कॉन्फ़िगर कर सकते हैं:
/config/providers
हर एपीआई को कॉल करते समय, आपको अनुरोध के मुख्य हिस्से में यह जानकारी देनी होगी:
पैरामीटर | Description | ज़रूरी |
authType |
पेमेंट की सेवा देने वाली कंपनी से मिला इंस्टॉलेशन आईडी. | हां |
credential |
आपके Worldpay व्यापारी खाते के लिए Base64 कोड में बदले गए क्रेडेंशियल (username:XMLpassword ). username , व्यापारी कोड (कैपिटल लेटर में) के बराबर होता है
और XMLpassword अपना Worldpay मर्चेंट खाता सेट अप करते समय, पिछले चरण में सेट किए गए
एक्सएमएल पासवर्ड के बारे में बताता है. |
हां |
description |
पेमेंट की सेवा देने वाली कंपनी की जानकारी. | नहीं |
endpoint |
पेमेंट की सेवा देने वाली कंपनी को ऐक्सेस करने के लिए एंडपॉइंट
|
हां |
merchantCode |
पेमेंट की सेवा देने वाली कंपनी की ओर से एपीआई के उपभोक्ताओं को दिया गया मर्चेंट कोड | हां |
name |
कंपनी के लिए इस्तेमाल किया जाने वाला नाम.
सिर्फ़ Apigee Edge के निजी क्लाउड के ग्राहक: दुनिया भर में पैसे चुकाने की सेवा देने वाली कंपनियों को यह पक्का करना होगा कि यह नाम सभी 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" }
वर्ल्डपे के सिक्योर पेमेंट पेज का यूआरएल, referenceUrl
में दिखाया जाता है. इसमें,
यूनीक ऑर्डर कुंजी, क्वेरी पैरामीटर के तौर पर जोड़ी जाती है.
एपीआई का इस्तेमाल करके प्रीपेड खाते में बाकी बैलेंस फिर से लोड करना
जैसा कि प्रीपेड खाता मैनेजमेंट फ़्लो के 15वें चरण में दिखाया गया है, पेमेंट की सेवा देने वाली कंपनी इस बात की पुष्टि करती है कि पेमेंट की प्रोसेस पूरी हो गई है, इसके बाद डेवलपर पोर्टल, Edge को प्रीपेड खाता फिर से लोड करने का अनुरोध भेजता है.
डेवलपर या कंपनी के लिए बनाए गए एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस को फिर से लोड किया जा सकता है. इसके बारे में इन सेक्शन में बताया गया है.
डेवलपर के लिए प्रीपेड खाते का बैलेंस फिर से लोड करना
एपीआई का इस्तेमाल करने वाले डेवलपर के प्रीपेड खाते में बाकी बैलेंस फिर से लोड करने के लिए, /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 संगठन के लिए कॉन्फ़िगर किए गए, तीसरे पक्ष की पेमेंट की सेवा देने वाली कंपनी को मिटाया जा सकता है. इसके लिए, इन संसाधनों को 'मिटाने का अनुरोध' जारी किया जा सकता है:
किसी संगठन के लिए पेमेंट की सेवा देने वाली कंपनी की जानकारी मिटाने के लिए, नीचे दिए गए एपीआई का इस्तेमाल करें:
/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
क्वेरी पैरामीटर.
यहां दिए गए उदाहरण में, अगर कंपनी के प्रीपेड खाते का बैलेंस पांच डॉलर से कम हो जाता है, तो आपके खाते में 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 |
false | नहीं | |
isRecurring |
यह फ़्लैग बताता है कि अपने-आप फिर से लोड होने की सुविधा चालू है या नहीं ( |
लागू नहीं | हां |
replenishAmount |
अपने-आप फिर से लोड होने के लिए, प्रीपेड खाते का बैलेंस थ्रेशोल्ड से कम होना चाहिए. |
लागू नहीं | हां |
recurringAmount |
अपने-आप फिर से लोड होने का विकल्प ट्रिगर होने पर, प्रीपेड खाते के बैलेंस में जोड़ने के लिए रकम. |
लागू नहीं | हां |
WorldPay के होस्ट किए गए पेमेंट पेजों पर माइग्रेट करना
WorldPay ने पेमेंट प्रोसेस करने के अपने सुरक्षित फ़्लो को अपडेट किया है. अब इसमें पेजों का एक नया सेट इस्तेमाल किया जा सकता है. इस सेट को 'होस्ट किए गए पेमेंट पेज' कहा जाता है.
अगस्त 2017 से पहले, अगर आपने WorldPay की पेमेंट की सेवा देने वाली कंपनियों को, काम न करने वाले सुरक्षित पेमेंट प्रोसेसिंग फ़्लो (अगस्त 2017 से पहले) का इस्तेमाल करके कॉन्फ़िगर किया है, तो जनवरी 2018 से पहले आपको WorldPay के होस्ट किए गए नए पेमेंट पेजों पर माइग्रेट करना होगा.
WorldPay के होस्ट किए गए पेमेंट पेजों पर माइग्रेट करने के लिए:
- होस्ट किए गए नए पेमेंट पेजों का इस्तेमाल करने के लिए, अपने मौजूदा खाते को माइग्रेट करने के लिए WorldPay से संपर्क करें और अपने खाते के लिए, एक नया इंस्टॉलेशन आईडी पाएं.
- Edge में पेमेंट की सेवा देने वाली कंपनी को कॉन्फ़िगर करने के तरीके के हिसाब से, WorldPay की नई पेमेंट कंपनियों को कॉन्फ़िगर करें. इसके लिए,
authType
फ़ील्ड में इंस्टॉलेशन आईडी पास करना होगा. - अपने डेवलपर पोर्टल पर, पेमेंट की सेवा देने वाली नई कंपनी कॉन्फ़िगर करें. इसके लिए, डेवलपर पोर्टल में कमाई करने की सुविधा कॉन्फ़िगर करें लेख पढ़ें.
- अगर आपने पेमेंट की सेवा देने वाली कंपनी की मदद से प्रीपेड खाते के लिए, अपने-आप फिर से लोड होने की सुविधा सेट अप की है, तो आपको नए आईडी का इस्तेमाल करने के लिए, अपने-आप फिर से लोड होने की सुविधा को फिर से कॉन्फ़िगर करना होगा. इसके बारे में एपीआई का इस्तेमाल करके, प्रीपेड खाते के बैलेंस को अपने-आप फिर से लोड करने की सुविधा सेट अप करना में बताया गया है.
अगले चरण
अलग-अलग पोस्टपेड डेवलपर के लिए, क्रेडिट लिमिट सेट की जा सकती है. पोस्टपेड बैलेंस मैनेज करने का तरीका जानें.