Mobile Integration Guide

​

आवश्यकताएँ

• Dodo Payments Account: API access वाला active merchant account
• API Credentials: आपके dashboard से API key और webhook secret key
• Mobile App Project: Android, iOS, React Native या Flutter application
• Backend Server: checkout session creation को securely handle करने के लिए

​

Integration Workflow

func getCheckoutURL(productId: String, customerEmail: String, customerName: String) async throws -> String {
    let url = URL(string: "https://your-backend.com/api/create-checkout-session")!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.setValue("Bearer \(userSessionToken)", forHTTPHeaderField: "Authorization")
    
    let requestData: [String: Any] = [
        "productId": productId,
        "customerEmail": customerEmail,
        "customerName": customerName
    ]
    request.httpBody = try JSONSerialization.data(withJSONObject: requestData)
    
    let (data, _) = try await URLSession.shared.data(for: request)
    let response = try JSONDecoder().decode(CheckoutResponse.self, from: data)
    return response.checkout_url
}

suspend fun getCheckoutURL(productId: String, customerEmail: String, customerName: String): String {
    val client = OkHttpClient()
    val requestBody = JSONObject().apply {
        put("productId", productId)
        put("customerEmail", customerEmail)
        put("customerName", customerName)
    }.toString().toRequestBody("application/json".toMediaType())
    
    val request = Request.Builder()
        .url("https://your-backend.com/api/create-checkout-session")
        .header("Authorization", "Bearer $userSessionToken")
        .post(requestBody)
        .build()
    
    val response = client.newCall(request).execute()
    val responseBody = response.body?.string()
    val jsonResponse = JSONObject(responseBody ?: "")
    return jsonResponse.getString("checkout_url")
}

const getCheckoutURL = async (productId, customerEmail, customerName) => {
  try {
    const response = await fetch('https://your-backend.com/api/create-checkout-session', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${userSessionToken}`,
      },
      body: JSON.stringify({
        productId,
        customerEmail,
        customerName
      })
    });
    
    const data = await response.json();
    return data.checkout_url;
  } catch (error) {
    console.error('Failed to get checkout URL:', error);
    throw error;
  }
};

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<String> getCheckoutUrl({
  required String productId,
  required String customerEmail,
  required String customerName,
}) async {
  final response = await http.post(
    Uri.parse('https://your-backend.com/api/create-checkout-session'),
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer $userSessionToken',
    },
    body: jsonEncode({
      'productId': productId,
      'customerEmail': customerEmail,
      'customerName': customerName,
    }),
  );

  if (response.statusCode != 200) {
    throw Exception('Failed to get checkout URL: ${response.statusCode}');
  }
  return jsonDecode(response.body)['checkout_url'] as String;
}

​

अपना SDK चुनें

​

Callback URL Scheme register करना

android {
    defaultConfig {
        manifestPlaceholders["dodoCallbackScheme"] = "myapp"
    }
}

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>myapp</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>myapp</string>
    </array>
  </dict>
</array>

{
  "expo": {
    "scheme": "myapp",
    "plugins": [
      [
        "@dodopayments/react-native-checkout",
        { "scheme": "myappcheckout" }
      ]
    ]
  }
}

​

Appearance Customization

const result = await DodoCheckout.start({
  checkoutUrl,
  returnUrl: 'myapp://checkout/return',
  customization: {
    android: { toolbarColor: '#6366F1', closeButtonStyle: 'back' },
    ios: { presentationStyle: 'fullScreen', colorScheme: 'dark' },
  },
});

final result = await DodoCheckout.instance.start(
  CheckoutParams(
    checkoutUrl: Uri.parse(checkoutUrl),
    returnUrl: Uri.parse('myapp://checkout/return'),
    customization: BrowserCustomization(
      android: AndroidBrowserOptions(
        toolbarColor: Color(0xFF6366F1),
        closeButtonStyle: CloseButtonStyle.back,
      ),
      ios: IosBrowserOptions(
        presentationStyle: PresentationStyle.fullScreen,
        colorScheme: BrowserColorScheme.dark,
      ),
    ),
  ),
);

val result = DodoCheckout.start(
    activity,
    CheckoutParams(
        checkoutUrl = checkoutUrl,
        returnUrl = "myapp://checkout/return",
        customization = BrowserCustomization(
            toolbarColor = Color.parseColor("#6366F1"),
            closeButtonStyle = BrowserCustomization.CloseButtonStyle.BACK,
        )
    )
) { event -> }

let result = try await DodoCheckout.start(
    checkoutUrl: checkoutUrl,
    returnUrl: URL(string: "myapp://checkout/return")!,
    customization: BrowserCustomization(
        presentationStyle: .fullScreen,
        colorScheme: .dark
    )
)

​

Checkout Page Customization

​

Mobile-Optimized Recipes

Minimal Mobile Checkout - fastest path to payment

जब आपको सबसे छोटा संभव form चाहिए, तब इसका उपयोग करें: ऊपर payment methods, address के लिए केवल postcode आवश्यक, discount field नहीं और theme device से match करती है।

• Node.js SDK
• Python SDK

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode',
});

const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'pdt_your_product_id', quantity: 1 }],
  customer: { email: 'user@example.com', name: 'Jane Smith' },
  billing_address: { country: 'US' },
  return_url: 'myapp://checkout/success',
  cancel_url: 'myapp://checkout/cancelled',
  billing_currency: 'USD',
  minimal_address: true,
  customization: {
    show_order_details: false,
    theme: 'system',
  },
  feature_flags: {
    allow_discount_code: false,
    allow_currency_selection: false,
  },
});

console.log(session.checkout_url);

See all 26 lines

import os
import dodopayments

client = dodopayments.DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",
)

session = client.checkout_sessions.create(
    product_cart=[{"product_id": "pdt_your_product_id", "quantity": 1}],
    customer={"email": "user@example.com", "name": "Jane Smith"},
    billing_address={"country": "US"},
    return_url="myapp://checkout/success",
    cancel_url="myapp://checkout/cancelled",
    billing_currency="USD",
    minimal_address=True,
    customization={
        "show_order_details": False,
        "theme": "system",
    },
    feature_flags={
        "allow_discount_code": False,
        "allow_currency_selection": False,
    },
)

print(session.checkout_url)

See all 27 lines

सभी available parameters और उनके defaults के लिए Checkout Sessions देखें।

Branded Mobile Checkout - custom colors, fonts, and button label

जब checkout page को आपके app का हिस्सा जैसा महसूस होना चाहिए, तब इसका उपयोग करें। अपने brand colors, custom font और localized pay-button label set करें।

• Node.js SDK
• Python SDK

const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'pdt_your_product_id', quantity: 1 }],
  customer: { email: 'user@example.com', name: 'Jane Smith' },
  billing_address: { country: 'US' },
  billing_currency: 'USD',
  return_url: 'myapp://checkout/success',
  minimal_address: true,
  customization: {
    show_order_details: false,
    theme: 'dark',
    theme_config: {
      dark: {
        button_primary: '#7C3AED',
        button_primary_hover: '#6D28D9',
        button_text_primary: '#FFFFFF',
        bg_primary: '#1A1A2E',
        bg_secondary: '#16213E',
        text_primary: '#E2E8F0',
      },
      pay_button_text: 'Complete Purchase',
      radius: '8px',
    },
  },
});

See all 24 lines

session = client.checkout_sessions.create(
    product_cart=[{"product_id": "pdt_your_product_id", "quantity": 1}],
    customer={"email": "user@example.com", "name": "Jane Smith"},
    billing_address={"country": "US"},
    billing_currency="USD",
    return_url="myapp://checkout/success",
    minimal_address=True,
    customization={
        "show_order_details": False,
        "theme": "dark",
        "theme_config": {
            "dark": {
                "button_primary": "#7C3AED",
                "button_primary_hover": "#6D28D9",
                "button_text_primary": "#FFFFFF",
                "bg_primary": "#1A1A2E",
                "bg_secondary": "#16213E",
                "text_primary": "#E2E8F0",
            },
            "pay_button_text": "Complete Purchase",
            "radius": "8px",
        },
    },
)

See all 24 lines

theme_config अलग-अलग dark और light objects स्वीकार करता है, ताकि palette device के current appearance के अनुसार adapt हो सके। पूर्ण color key reference के लिए Checkout Sessions देखें।

One-Click Returning Customer - saved card, instant confirmation

पहले payment कर चुके signed-in users के लिए इसका उपयोग करें। Checkout form को पूरी तरह skip करने के लिए customer ID, उनका saved payment method और confirm: true combine करें।

• Node.js SDK
• Python SDK

const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'pdt_your_product_id', quantity: 1 }],
  customer: { customer_id: 'cus_returning_customer_id' },
  billing_address: { country: 'US' },
  billing_currency: 'USD',
  return_url: 'myapp://checkout/success',
  payment_method_id: 'pm_saved_payment_method_id',
  confirm: true,
  show_saved_payment_methods: true,           // top-level parameter
  feature_flags: { redirect_immediately: true },
});

See all 11 lines

session = client.checkout_sessions.create(
    product_cart=[{"product_id": "pdt_your_product_id", "quantity": 1}],
    customer={"customer_id": "cus_returning_customer_id"},
    billing_address={"country": "US"},
    billing_currency="USD",
    return_url="myapp://checkout/success",
    payment_method_id="pm_saved_payment_method_id",
    confirm=True,
    show_saved_payment_methods=True,           # top-level parameter
    feature_flags={"redirect_immediately": True},
)

See all 11 lines

Deep-link return में status केवल UI hint है। अपने backend पर payment.succeeded webhook सुनकर access की पुष्टि करें।

Subscription with Free Trial - trial before first charge

Subscription products के लिए इसका उपयोग करें जो पहले billing cycle से पहले free trial period offer करते हैं।

• Node.js SDK
• Python SDK

const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'pdt_your_subscription_product_id', quantity: 1 }],
  customer: { email: 'user@example.com', name: 'Jane Smith' },
  billing_address: { country: 'US' },
  billing_currency: 'USD',
  return_url: 'myapp://subscription/activated',
  cancel_url: 'myapp://subscription/cancelled',
  minimal_address: true,
  customization: {
    show_order_details: false,
    theme: 'system',
  },
  subscription_data: { trial_period_days: 14 },
});

See all 14 lines

session = client.checkout_sessions.create(
    product_cart=[{"product_id": "pdt_your_subscription_product_id", "quantity": 1}],
    customer={"email": "user@example.com", "name": "Jane Smith"},
    billing_address={"country": "US"},
    billing_currency="USD",
    return_url="myapp://subscription/activated",
    cancel_url="myapp://subscription/cancelled",
    minimal_address=True,
    customization={"show_order_details": False, "theme": "system"},
    subscription_data={"trial_period_days": 14},
)

See all 11 lines

जब आपके backend को subscription.active webhook प्राप्त हो, तब feature access grant करें - mobile SDK के return पर नहीं। पूरे webhook flow के लिए Subscription Integration Guide देखें।

On-Demand Mandate - save a card for future variable charges

Customer के card को बाद के charges (wallet top-ups, pay-as-you-go, BNPL) के लिए tokenize करने हेतु इसका उपयोग करें, बिना “subscription” label दिखाए। Customer अपने payment method को एक बार authorize करता है; बाद में आप variable amounts को on demand charge करते हैं।

यह pattern usage के आधार पर charge करने वाले apps में उपयोग होता है - उदाहरण के लिए, एक astrology app जो fixed schedule के बजाय pre-authorized card से प्रति session charge करता है।

• Node.js SDK
• Python SDK

// Step 1: Authorize the mandate (no charge yet)
const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'pdt_your_subscription_product_id', quantity: 1 }],
  customer: { email: 'user@example.com', name: 'Jane Smith' },
  billing_address: { country: 'US' },
  billing_currency: 'USD',
  return_url: 'myapp://mandate/authorized',
  cancel_url: 'myapp://mandate/cancelled',
  minimal_address: true,
  customization: {
    show_order_details: false,
    show_on_demand_tag: false, // hides the "on-demand" / "subscription" label
    theme: 'system',
  },
  subscription_data: {
    on_demand: { mandate_only: true },
  },
});

// Step 2: Later, charge any amount using the subscription ID
// (received via the subscription.active webhook after mandate authorization)
// await client.subscriptions.charge(subscriptionId, {
//   product_price: 2000,         // $20.00 in cents
//   product_currency: 'USD',
//   product_description: 'Session credits',
// });

See all 26 lines

# Step 1: Authorize the mandate (no charge yet)
session = client.checkout_sessions.create(
    product_cart=[{"product_id": "pdt_your_subscription_product_id", "quantity": 1}],
    customer={"email": "user@example.com", "name": "Jane Smith"},
    billing_address={"country": "US"},
    billing_currency="USD",
    return_url="myapp://mandate/authorized",
    cancel_url="myapp://mandate/cancelled",
    minimal_address=True,
    customization={
        "show_order_details": False,
        "show_on_demand_tag": False,  # hides the "on-demand" / "subscription" label
        "theme": "system",
    },
    subscription_data={"on_demand": {"mandate_only": True}},
)

# Step 2: Later, charge any amount using the subscription ID
# client.subscriptions.charge(subscription_id, {
#     "product_price": 2000,  # $20.00 in cents
#     "product_currency": "USD",
#     "product_description": "Session credits",
# })

See all 23 lines

On-demand charges के लिए कम से कम 1 USD (100 cents) आवश्यक है। 1 USD से कम amounts को "value out of range" के साथ reject कर दिया जाएगा। Zero-amount authorization के लिए ऊपर दिखाए गए अनुसार mandate_only: true का उपयोग करें, फिर बाद की calls में कम से कम 1 USD charge करें।

Complete charge flow, webhook events और retry policies के लिए On-Demand Subscriptions देखें।

​

Mobile से Subscription Flows

​

Regular Recurring Subscriptions

​

On-Demand Subscriptions

• show_on_demand_tag: false set करें ताकि checkout page पर “subscription” या “on-demand” language दिखाई न दे। Card-tokenization use cases में customers subscription terminology की अपेक्षा नहीं करते।
• Mandate authorize होने के बाद आपका backend subscription.active प्राप्त करता है। subscription_id store करें - सभी future charges के लिए इसका उपयोग होगा।

​

Subscription with Free Trial

​

Upgrades और Downgrades

​

Checkout Drop-Offs कम करना

​

Form को Optimize करें

​

Customer Data Pre-Fill करें

• New customers - अपनी auth session से customer.email और customer.name set करें।
• Returning customers - सभी stored details automatically pre-fill करने के लिए customer.customer_id set करें।
• Currency - billing_currency और billing_address.country को हमेशा साथ pass करें।

​

Recovery Tools

​

Best Practices

• Security: अपने app में API key कभी ship न करें। Checkout sessions अपने backend पर बनाएँ और केवल resulting checkout_url client को pass करें।
• Authority: CheckoutResult.status को UI hint मानें। Access केवल backend द्वारा payment confirm करने के बाद grant करें।
• User Experience: Backend द्वारा session create किए जाने तक loading state दिखाएँ और cancelled को error के बजाय normal outcome के रूप में handle करें।
• Testing: Test mode और test cards का उपयोग करें और real device तथा simulator दोनों पर return-URL round trip verify करें।
• Conversion: Best mobile checkout completion rates के लिए show_order_details: false और minimal_address: true set करें। Payment methods को above the fold ले जाना और form fields कम करना, आपके द्वारा किए जा सकने वाले दो सबसे प्रभावी बदलाव हैं।
• Currency: billing_currency और billing_address.country दोनों को हमेशा explicitly pass करें - इनमें से कोई missing होने पर adaptive currency customer के IP address के आधार पर billing currency बदल सकती है।
• On-demand billing: Card tokenization के लिए on-demand subscriptions का उपयोग करते समय show_on_demand_tag: false set करें। Wallet top-up flow का उपयोग करने वाले customers “subscription” language देखने की अपेक्षा नहीं करते।
• Recovery: Checkout पूरा न करने वाले customers को automatically re-engage करने के लिए अपने Dodo Payments dashboard में abandoned cart recovery enable करें।

​

Troubleshooting

​

सामान्य समस्याएँ

• Callback कभी नहीं आता: returnUrl में scheme आपके registered scheme से match होना चाहिए। Android पर यह dodoCallbackScheme manifest placeholder है; iOS और React Native पर यह Info.plist URL type है।
• Checkout आपके app के बजाय browser पर लौटता है (iOS): आपने incoming URL forward नहीं किया है। .onOpenURL, scene(_:openURLContexts:) या React Native Linking listener से DodoCheckout.handleOpenURL(url) call करें।
• Android पर PLATFORM_ERROR: अधिकतर मामलों में यह scheme mismatch होता है। यह तब भी दिखाई दे सकता है जब आपका MainActivity android:taskAffinity="" set करता है (stock flutter create default), जिससे कुछ OEM builds in-flight checkout खो सकते हैं।
• ALREADY_IN_PROGRESS: एक checkout अभी भी open है। दूसरा शुरू करने से पहले पिछले checkout का await या dismiss करें।
• Unresolved placeholder के कारण build fail होता है: आपने Android SDK add किया, लेकिन manifestPlaceholders["dodoCallbackScheme"] set नहीं किया।
• Payment सफल हुआ लेकिन access grant नहीं हुआ: यदि आप mobile result पर निर्भर हैं तो यह expected है। इसके बजाय payment.succeeded / subscription.active webhook से access grant करें।
• Mobile पर Apple Pay / Google Pay दिखाई नहीं देते: Checkout embedded WebView (WKWebView / Android WebView) में load हो रहा है, जो wallets को suppress करता है और 3-D Secure को तोड़ सकता है। इसके बजाय SDK से या system browser (Custom Tabs / SFSafariViewController) में खोलें।

​

अतिरिक्त Resources

• Payment Integration Guide
• Webhook Documentation
• Testing Process
• Technical FAQs
• Checkout Session Customization
• On-Demand Subscriptions
• Subscription Upgrade/Downgrade
• Abandoned Cart Recovery
• Customer Portal