अवलोकन
Dodo Payments चेकआउट SDK आपके वेब एप्लिकेशन में हमारे भुगतान ओवरले को एकीकृत करने का एक सहज तरीका प्रदान करता है। TypeScript और आधुनिक वेब मानकों के साथ निर्मित, यह रीयल-टाइम इवेंट हैंडलिंग और अनुकूलन योग्य थीम के साथ भुगतान को संभालने के लिए एक मजबूत समाधान प्रदान करता है।
डेमो
Interactive Demo
हमारे लाइव डेमो के साथ ओवरले चेकआउट को क्रियाशील अवस्था में देखें।
त्वरित प्रारंभ
कुछ कोड की पंक्तियों में Dodo Payments चेकआउट SDK के साथ शुरू करें:चरण-दर-चरण एकीकरण गाइड
Initialize the SDK
अपने एप्लिकेशन में SDK को प्रारंभ करें, आमतौर पर आपके मुख्य घटक या ऐप के प्रवेश बिंदु में:
Test Your Integration
- अपने विकास सर्वर को प्रारंभ करें:
- चेकआउट प्रवाह का परीक्षण करें:
- चेकआउट बटन पर क्लिक करें
- सत्यापित करें कि ओवरले प्रकट होता है
- परीक्षण क्रेडेंशियल्स का उपयोग करके भुगतान प्रवाह का परीक्षण करें
- पुष्टि करें कि रीडायरेक्ट सही ढंग से काम करते हैं
आपको अपने ब्राउज़र कंसोल में चेकआउट ईवेंट लॉग होते हुए दिखाई देने चाहिए।
API संदर्भ
कॉन्फ़िगरेशन
प्रारंभ विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
mode | "test" | "live" | हाँ | Environment mode: 'test' विकास के लिए, 'live' उत्पादन के लिए |
displayType | "overlay" | "inline" | नहीं | Display type: 'overlay' मोडल चेकआउट (डिफ़ॉल्ट) के लिए, 'inline' एम्बेडेड चेकआउट के लिए |
onEvent | function | हाँ | किस्म के ईवेंट्स को संभालने के लिए कॉलबैक फ़ंक्शन |
चेकआउट विकल्प
| विकल्प | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
checkoutUrl | string | हाँ | चेकआउट सेशन URL create checkout session API से |
options.showTimer | boolean | नहीं | चेकआउट टाइमर दिखाएँ या छिपाएँ। डिफ़ॉल्ट true है। जब निष्क्रिय किया जाता है, तो आपको checkout.link_expired ईवेंट प्राप्त होगा जब सेशन समाप्त होता है। |
options.showSecurityBadge | boolean | नहीं | सुरक्षा बैज दिखाएँ या छिपाएँ। डिफ़ॉल्ट true है। |
options.manualRedirect | boolean | नहीं | जब सक्षम हो, तो चेकआउट पूरा होने के बाद स्वचालित रूप से रीडायरेक्ट नहीं करेगा। इसके बजाय, आपको checkout.status और checkout.redirect_requested ईवेंट प्राप्त होंगे ताकि आप स्वयं रीडायरेक्शन को संभाल सकें। |
विधियाँ
चेकआउट खोलें
निर्दिष्ट चेकआउट सत्र URL के साथ चेकआउट ओवरले खोलता है।manualRedirect का उपयोग कर रहे हों, तो अपने onEvent कॉलबैक में चेकआउट पूर्णता को संभालें:
चेकआउट बंद करें
प्रोग्रामेटिक रूप से चेकआउट ओवरले को बंद करता है।स्थिति जांचें
यह लौटाता है कि चेकआउट ओवरले वर्तमान में खुला है या नहीं।घटनाएँ
SDK वास्तविक समय ईवेंट प्रदान करता है जिन्हें आपonEvent कॉलबैक के माध्यम से सुन सकते हैं:
चेकआउट स्थिति घटना डेटा
जबmanualRedirect सक्षम होता है, तो आपको निम्न डेटा के साथ checkout.status ईवेंट प्राप्त होता है:
चेकआउट पुनर्निर्देशन अनुरोधित घटना डेटा
जबmanualRedirect सक्षम होता है, तो आपको निम्न डेटा के साथ checkout.redirect_requested ईवेंट प्राप्त होता है:
| ईवेंट प्रकार | विवरण |
|---|---|
checkout.opened | चेकआउट ओवरले खोला गया है |
checkout.form_ready | चेकआउट फॉर्म उपयोगकर्ता इनपुट प्राप्त करने के लिए तैयार है। लोडिंग स्थिति छिपाने के लिए उपयोगी है। |
checkout.payment_page_opened | भुगतान पेज प्रदर्शित किया गया है |
checkout.customer_details_submitted | ग्राहक और बिलिंग विवरण सबमिट किए गए हैं |
checkout.closed | चेकआउट ओवरले बंद किया गया है |
checkout.redirect | चेकआउट रीडायरेक्ट करेगा |
checkout.error | चेकआउट के दौरान त्रुटि हुई |
checkout.link_expired | जब चेकआउट सेशन समाप्त होता है तो किया जाता है। केवल उस समय प्राप्त होता है जब showTimer को false पर सेट किया गया हो। |
checkout.status | जब manualRedirect सक्षम होता है तब किया जाता है। इसमें चेकआउट स्थिति (succeeded, failed, या processing) शामिल होती है। |
checkout.redirect_requested | जब manualRedirect सक्षम होता है तब किया जाता है। इसमें ग्राहक को रीडायरेक्ट करने के लिए URL शामिल होता है। |
कार्यान्वयन विकल्प
पैकेज प्रबंधक स्थापना
npm, yarn, या pnpm के माध्यम से स्थापना करें जैसा कि चरण-दर-चरण एकीकरण गाइड में दिखाया गया है।CDN कार्यान्वयन
बिना किसी निर्माण चरण के त्वरित एकीकरण के लिए, आप हमारे CDN का उपयोग कर सकते हैं:थीम कस्टमाइजेशन
आप चेकआउट की उपस्थिति कोthemeConfig ऑब्जेक्ट को options पैरामीटर में पास करके कस्टमाइज़ कर सकते हैं जब चेकआउट खोलते हैं। थीम कॉन्फ़िगरेशन लाइट और डार्क मोड दोनों का समर्थन करता है, जिससे आप रंग, बॉर्डर, टेक्स्ट, बटन और बॉर्डर रेडियस को अनुकूलित कर सकते हैं।
यह अनुभाग Checkout SDK का उपयोग करके क्लाइंट-साइड थीम कॉन्फ़िगरेशन को कवर करता है। आप API के माध्यम से चेकआउट सत्र बनाते समय
theme_config पैरामीटर का उपयोग करके सर्वर-साइड पर भी थीम कॉन्फ़िगर कर सकते हैं। API-स्तर के कॉन्फ़िगरेशन के लिए Checkout Theme Customization देखें, या डैशबोर्ड में Design page का उपयोग करके लाइव पूर्वावलोकन के साथ दृश्य रूप से थीम कॉन्फ़िगर करें।मूल थीम कॉन्फ़िगरेशन
पूर्ण थीम कॉन्फ़िगरेशन
सभी उपलब्ध थीम गुण:केवल लाइट मोड
यदि आप केवल लाइट थीम को कस्टमाइज़ करना चाहते हैं:केवल डार्क मोड
यदि आप केवल डार्क थीम को कस्टमाइज़ करना चाहते हैं:आंशिक थीम ओवरराइड
आप केवल विशिष्ट गुणों को ओवरराइड कर सकते हैं। जिन गुणों को आप निर्दिष्ट नहीं करते हैं, उनके लिए चेकआउट डिफ़ॉल्ट मान का उपयोग करेगा:अन्य विकल्पों के साथ थीम कॉन्फ़िगरेशन
आप थीम कॉन्फ़िगरेशन को अन्य चेकआउट विकल्पों के साथ संयोजित कर सकते हैं:TypeScript प्रकार
TypeScript उपयोगकर्ताओं के लिए, सभी थीम कॉन्फ़िगरेशन प्रकार निर्यात किए गए हैं:त्रुटि हैंडलिंग
SDK ईवेंट सिस्टम के माध्यम से विस्तृत त्रुटि जानकारी प्रदान करता है। हमेशा अपनेonEvent कॉलबैक में उचित त्रुटि हैंडलिंग लागू करें:
सर्वोत्तम अभ्यास
- एक बार इनिशियलाइज़ करें: SDK को केवल एक बार इनिशियलाइज़ करें जब आपका एप्लिकेशन लोड हो, हर चेकआउट प्रयास पर नहीं
- त्रुटि हैंडलिंग: हमेशा अपने ईवेंट कॉलबैक में उचित त्रुटि हैंडलिंग लागू करें
- परीक्षण मोड: विकास के दौरान
testमोड का उपयोग करें और केवल तैयार होने परliveमें स्विच करें - ईवेंट हैंडलिंग: एक पूर्ण उपयोगकर्ता अनुभव के लिए सभी प्रासंगिक ईवेंट्स को संभालें
- वैध URLs: हमेशा create checkout session API से वैध चेकआउट URLs का उपयोग करें
- TypeScript: बेहतर टाइप सुरक्षा और डेवलपर अनुभव के लिए TypeScript का उपयोग करें
- लोडिंग अवस्थाएँ: चेकआउट खुलते समय लोडिंग अवस्थाएँ दिखाएँ ताकि UX बेहतर हो
- मैनुअल रीडायरेक्ट: जब आपको पोस्ट-चेकआउट नेविगेशन पर कस्टम नियंत्रण चाहिए हो, तो
manualRedirectका उपयोग करें - टाइमर प्रबंधन: यदि आप सेशन समाप्ति को मैन्युअली संभालना चाहते हैं तो टाइमर (
showTimer: false) को अक्षम करें
समस्या निवारण
Checkout not opening
Checkout not opening
संभावित कारण:
- चेकआउट खोलने से पहले
open()कॉल करने से SDK इनिशियलाइज़ नहीं हुआ - अमान्य चेकआउट URL
- कंसोल में JavaScript त्रुटियाँ
- नेटवर्क कनेक्टिविटी समस्याएँ
- सत्यापित करें कि चेकआउट खोलने से पहले SDK इनिशियलाइज़ेशन पूरा हो चुका है
- कंसोल त्रुटियों की जांच करें
- सुनिश्चित करें कि चेकआउट URL मान्य है और create checkout session API से है
- नेटवर्क कनेक्टिविटी सत्यापित करें
Events not firing
Events not firing
संभावित कारण:
- ईवेंट हैंडलर ठीक से सेट नहीं है
- JavaScript त्रुटियाँ जो ईवेंट प्रसार को रोक रही हैं
- SDK सही ढंग से इनिशियलाइज़ नहीं हुआ
- पुष्टि करें कि
Initialize()में ईवेंट हैंडलर ठीक से कॉन्फ़िगर किया गया है - JavaScript त्रुटियों के लिए ब्राउज़र कंसोल की जांच करें
- सत्यापित करें कि SDK इनिशियलाइज़ेशन सफलतापूर्वक पूरा हुआ
- पहले एक साधारण ईवेंट हैंडलर के साथ परीक्षण करें
Styling issues
Styling issues
संभावित कारण:
- CSS आपके एप्लिकेशन शैलियों के साथ टकराव कर रहा है
- थीम सेटिंग्स सही ढंग से लागू नहीं हो रही हैं
- उत्तरदायी डिज़ाइन समस्याएँ
- ब्राउज़र DevTools में CSS टकरावों की जाँच करें
- सुनिश्चित करें कि थीम सेटिंग्स सही हैं
- विभिन्न स्क्रीन आकारों पर परीक्षण करें
- ओवरले के साथ कोई z-index टकराव न हो
डिजिटल वॉलेट्स सक्षम करना
Google Pay और अन्य डिजिटल वॉलेट्स सेटअप करने के विस्तृत विवरण के लिए, Digital Wallets पेज देखें।ओवरले चेकआउट में Apple Pay अभी तक समर्थित नहीं है। Apple Pay के लिए समर्थन जल्द ही आ रहा है।
ब्राउज़र समर्थन
Dodo Payments Checkout SDK निम्न ब्राउज़रों का समर्थन करता है:- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
- IE11+
ओवरले बनाम इनलाइन चेकआउट
अपने उपयोग मामले के लिए सही चेकआउट प्रकार चुनें:| विशेषता | ओवरले चेकआउट | इनलाइन चेकआउट |
|---|---|---|
| एकीकरण गहराई | पेज के शीर्ष पर मोडल | पेज में पूर्ण रूप से एम्बेडेड |
| लेआउट नियंत्रण | सीमित | पूर्ण नियंत्रण |
| ब्रांडिंग | पेज से अलग | निर्बाध |
| क्रियान्वयन प्रयास | कम | अधिक |
| उपयुक्त | तेज़ एकीकरण, मौजूदा पेज | कस्टम चेकआउट पेज, उच्च कन्वर्ज़न फ्लो |
संबंधित संसाधन
Inline Checkout
अपने पेज में सीधे चेकआउट को एम्बेड करें ताकि पूरी तरह एकीकृत अनुभव मिलें।
Checkout Sessions API
अपनी चेकआउट अनुभवों को संचालित करने के लिए चेकआउट सेशन बनाएं।
Webhooks
वेबहुक्स के साथ सर्वर-साइड पर भुगतान ईवेंट्स को संभालें।
Integration Guide
Dodo Payments को एकीकृत करने के लिए पूर्ण मार्गदर्शिका।