@dodopayments/bun पैकेज आपके Bun सर्वर को तीन request handlers देता है। Checkout checkout URLs लौटाता है, CustomerPortal ग्राहक को Customer Portal पर भेजता है, और Webhooks webhook events को verify करके आपके code तक पहुँचाता है। हर handler एक standard Request लेता है और एक Response लौटाता है, इसलिए आप इसे Bun.serve() के fetch handler से call करते हैं।
Checkout Handler
static, dynamic और checkout session flows के साथ checkout URLs बनाएँ।
Customer Portal
ग्राहकों को अपनी subscriptions और details manage करने दें।
Webhooks
Dodo Payments webhook events प्राप्त और process करें।
Installation
1
Install the Package
यह command अपने project root में चलाएँ:इस पैकेज को peer dependency के रूप में
zod 3.25 या बाद का संस्करण भी चाहिए।2
Set Up Environment Variables
अपने project root में एक Bun
.env file बनाएँ। API key Developer → API Keys के अंतर्गत बनाएँ। अपना webhook endpoint Developer → Webhooks के अंतर्गत जोड़ें और उसका Signing secret DODO_PAYMENTS_WEBHOOK_KEY में copy करें:.env files को automatically पढ़ता है, इसलिए examples इन values को process.env से पढ़ते हैं। Checkout के बाद ग्राहक DODO_PAYMENTS_RETURN_URL पर पहुँचते हैं। यदि आप environment pass नहीं करते, तो handlers live_mode का उपयोग करते हैं। Test mode API key केवल test_mode के साथ काम करती है।Route Handler Examples
सभी examples Bun के native server,
Bun.serve(), का उपयोग करते हैं और इसके fetch handler में path और method के आधार पर requests को route करते हैं।- Checkout Handler
- Customer Portal Handler
- Webhook Handler
अपने Bun server में Dodo Payments checkout जोड़ने के लिए इस handler का उपयोग करें। Static handler
GET requests को serve करता है। Session और dynamic handlers POST requests को serve करते हैं। Dynamic checkout example मानता है कि server POST requests के लिए dynamicCheckoutHandler(request) लौटाता है।Checkout Route Handler
Checkout handler Dodo Payments के साथ payments लेने के सभी तीन तरीकों को support करता है:- Static Payment Links: Shareable URLs जो बिना code के payments collect करते हैं।
- Dynamic Payment Links: Custom details के साथ आपके द्वारा generate किए गए payment links। इनमें deprecated endpoints का उपयोग होता है।
- Checkout Sessions: Product cart, customer details और customization options के साथ hosted checkout। यही recommended flow है।
Checkout ये options लेता है:
Handler
GET requests के लिए static checkout serve करता है। POST requests के लिए, जब type dynamic हो, तो यह dynamic payment link बनाता है; अन्यथा checkout session बनाता है।
Static Checkout (GET)
Static Checkout (GET)
Supported Query Parameters
Major currency units में charged amount को fix करता है, उदाहरण के लिए $12.50 के लिए
12.5। केवल Pay What You Want products के साथ काम करता है और product की minimum price से कम होने पर ignore किया जाता है।metadata_ से शुरू होने वाला कोई भी query parameter checkout को metadata के रूप में pass किया जाता है, उदाहरण के लिए metadata_orderId=123।disableEmail=true के साथ email। Handler अपने config से returnUrl को link में redirect_url के रूप में जोड़ता है।Response Format
Static checkout checkout URL के साथ JSON response लौटाता है। Test mode में URLtest.checkout.dodopayments.com का उपयोग करता है:Dynamic Checkout (POST)
Dynamic Checkout (POST)
- Parameters को POST request में JSON body के रूप में भेजें।
- One-time और recurring payments दोनों support करता है। Handler product retrieve करता है, फिर product recurring होने पर subscription और अन्यथा one-time payment बनाता है।
- Body में
customerऔरbilling(जिसमेंstreet,city,state,countryऔरzipcodeहों) तथाproduct_idयाproduct_cartचाहिए। Subscriptions के लिएproduct_idआवश्यक है। - हर supported body field के लिए देखें:
Response Format
Dynamic checkout payment link को checkout URL के रूप में JSON response में लौटाता है:Checkout Sessions (POST)
Checkout Sessions (POST)
Checkout sessions one-time purchases और subscriptions के लिए hosted checkout बनाते हैं, जिसमें customization पर पूरा control होता है।
product_cart ही एकमात्र required field है और इसमें कम से कम एक product होना चाहिए। यदि body में return_url नहीं है, तो handler अपने config से returnUrl का उपयोग करता है।हर checkout_url एक बार काम करता है और 24 घंटे बाद expire हो जाता है, या confirm: true pass करने पर 15 मिनट बाद। payment_method_id के साथ बनाया गया session कोई checkout_url नहीं लौटाता, इसलिए handler 400 response देता है।अधिक details और सभी supported fields के लिए Checkout Sessions Integration Guide देखें।Response Format
Checkout sessions checkout URL के साथ JSON response लौटाते हैं:Customer Portal Route Handler
Customer Portal route handler आपके द्वारा दिए गए customer के लिए Customer Portal session बनाता है और browser को उस पर redirect करता है।CustomerPortal, Checkout के समान bearerToken और environment options लेता है।
Query Parameters
यदिcustomer_id missing है, तो handler 400 लौटाता है; और यदि portal session नहीं बनाया जा सकता, तो 500 लौटाता है।
Webhook Route Handler
Webhook route handler आपके webhook secret से प्रत्येक request को verify करता है। यह secretwebhookKey के रूप में pass किया जाता है, और verification के बाद ही आपका code run होता है:
- Method: केवल POST requests supported हैं। अन्य methods 405 लौटाते हैं।
- Signature Verification: Standard Webhooks specification का पालन करते हुए
webhookKeyके साथwebhook-id,webhook-timestampऔरwebhook-signatureheaders को verify करता है। Verification fail होने पर 401 लौटाता है। - Payload Validation: Body को JSON के रूप में parse करता है और Zod से validate करता है। Invalid JSON या invalid payload के लिए 400 लौटाता है।
- Error Handling:
- 401: Invalid signature
- 400: Invalid payload
- 500: Verification के दौरान internal error
- Event Routing: हर event के लिए
onPayloadको call करता है, फिर event के type के handler को call करता है और 200 लौटाता है।
Bun.serve() तक propagate होती हैं और request fail हो जाती है।