पेमेंट इंटेंट एपीआई फ़ंक्शंस

सभी पेमेंट इंटेंट्स की सूची प्राप्त करें

पेमेंट इंटेंट्स की एक सूची लौटाता है।

एंडपॉइंट: https://api.stripe.com/v1/payment_intents

ऑपरेशन: GET

उदाहरण

cURL उदाहरण:

curl -X GET https://api.stripe.com/v1/payment_intents \
  -u <YOUR_SECRET_KEY>:

प्रतिक्रियाएँ

प्रतिक्रियाएँ मानक कोड लौटाएँगी।

200: OK

{
  "object": "list",
  "data": [
    {
      "id": "pi_1234567890",
      "object": "payment_intent",
      "amount": 1000,
      "currency": "usd",
      "status": "requires_confirmation"
    }
  ],
  "has_more": false,
  "url": "/v1/payment_intents"
}

400: Bad Request

{
  "error": {
    "message": "यदि सरणी के रूप में पास करने के बजाय स्पष्ट कुंजियों वाली सरणी (जैसे foo[0]=a और foo[1]=b) पास की जा रही है, तो कुंजियाँ 0 से शुरू होकर संख्यात्मक और क्रमागत होनी चाहिए। आपने कुंजियाँ `1` पास कीं, जबकि हमें `0` मान वाली कुंजी की उम्मीद थी。",
    "param": "expand",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
    "type": "invalid_request_error"
  }
}

401: Unauthorized

{
  "error": {
    "type": "invalid_request_error",
    "message": "अमान्य API कुंजी प्रदान की गई: sk_test_********************1234"
  }
}

पैरामीटर

क्वेरी पैरामीटर

Parameter	Type	Description
limit	integer	लौटाए जाने वाले ऑब्जेक्ट्स की संख्या पर एक सीमा। सीमा 1 और 100 के बीच हो सकती है, और डिफ़ॉल्ट 10 है।
starting_after	string	पेजिनेशन में उपयोग के लिए एक कर्सर। starting_after एक ऑब्जेक्ट आईडी है जो सूची में आपके स्थान को परिभाषित करता है।
ending_before	string	पेजिनेशन में उपयोग के लिए एक कर्सर। ending_before एक ऑब्जेक्ट आईडी है जो सूची में आपके स्थान को परिभाषित करता है।
expand[]	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स को विस्तारित किया जाना चाहिए।

एक पेमेंट इंटेंट बनाएँ

एक बार पेमेंट इंटेंट बन जाने के बाद, भुगतान जारी रखने के लिए एक भुगतान विधि संलग्न करें और पुष्टि करें।

बनाने के दौरान confirm=true का उपयोग करना उसी कॉल में पेमेंट इंटेंट बनाने और पुष्टि करने के बराबर है। confirm=true लागू करने से confirm API में किसी भी पैरामीटर का उपयोग सक्षम हो जाता है।

एंडपॉइंट: https://api.stripe.com/v1/payment_intents

ऑपरेशन: POST

नोट

confirm अनुरोध HTTPS पर किया जाना चाहिए।

उदाहरण

cURL उदाहरण:

curl -X POST https://api.stripe.com/v1/payment_intents \
  -u <YOUR_SECRET_KEY>: \
  -d "amount=212&currency=usd&payment_method=pm_card_visa&confirm=true"

प्रतिक्रियाएँ

प्रतिक्रियाएँ मानक कोड लौटाएँगी।

200: OK

{
    "id": "pi_3Rsx4dDtWMrPDtgt0mUrePJ9",
    "object": "payment_intent",
    "amount": 212,
    "amount_capturable": 0,
    "amount_details": {
        "tip": {}
    },
    "amount_received": 0,
    "application": null,
    "application_fee_amount": null,
    "automatic_payment_methods": {
        "allow_redirects": "always",
        "enabled": true
    },
    "canceled_at": null,
    "cancellation_reason": null,
    "capture_method": "automatic_async",
    "client_secret": "pi_3Rsx4dDtWMrPDtgt0mUrePJ9_secret_7sqfufxuIYiBhbw52Vi51Z47o",
    "confirmation_method": "automatic",
    "created": 1754447247,
    "currency": "usd",
    "customer": null,
    "description": null,
    "last_payment_error": null,
    "latest_charge": null,
    "livemode": false,
    "metadata": {},
    "next_action": null,
    "on_behalf_of": null,
    "payment_method": null,
    "payment_method_configuration_details": {
        "id": "pmc_1RsGk1DtWMrPDtgtcaQ0d3Sg",
        "parent": null
    },
    "payment_method_options": {
        "amazon_pay": {
            "express_checkout_element_session_id": null
        },
        "card": {
            "installments": null,
            "mandate_options": null,
            "network": null,
            "request_three_d_secure": "automatic"
        },
        "cashapp": {},
        "klarna": {
            "preferred_locale": null
        },
        "link": {
            "persistent_token": null
        }
    },
    "payment_method_types": [
        "card",
        "klarna",
        "link",
        "cashapp",
        "amazon_pay"
    ],
    "processing": null,
    "receipt_email": null,
    "review": null,
    "setup_future_usage": null,
    "shipping": null,
    "source": null,
    "statement_descriptor": null,
    "statement_descriptor_suffix": null,
    "status": "requires_payment_method",
    "transfer_data": null,
    "transfer_group": null
}

400: Bad Request

{
  "error": {
    "code": "parameter_invalid_integer",
    "doc_url": "https://stripe.com/docs/error-codes/parameter-invalid-integer",
    "message": "अमान्य पूर्णांक: <पूर्णांक>",
    "param": "amount",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_UQf6XBwBl9yk66?t=1734829676",
    "type": "invalid_request_error"
  }
}

401: Unauthorized

{
  "error": {
    "type": "invalid_request_error",
    "message": "अमान्य API कुंजी प्रदान की गई: sk_test_********************1234"
  }
}

पैरामीटर

Body parameters

Parameter	Type	Description
amount	integer	(आवश्यक) एकत्र की जाने वाली राशि। एक धनात्मक पूर्णांक जो दर्शाता है कि सबसे छोटी मुद्रा इकाई में कितना शुल्क लेना है (उदाहरण के लिए, $1.00 का शुल्क लगाने के लिए 100 सेंट)।
currency	string	(आवश्यक) तीन-अक्षर का ISO मुद्रा कोड, छोटे अक्षरों में। यह एक समर्थित मुद्रा होनी चाहिए।
confirm	boolean	इस पेमेंटइंटेंट को तुरंत पुष्टि करने का प्रयास करने के लिए इसे true पर सेट करें।
customer	string	उस ग्राहक की आईडी जिससे यह पेमेंटइंटेंट संबंधित है, यदि कोई हो।
description	string	ऑब्जेक्ट से जुड़ी कोई भी स्ट्रिंग।
payment_method	string	इस पेमेंटइंटेंट से जोड़ने के लिए भुगतान विधि की आईडी।
payment_method_types[]	array of strings	भुगतान विधि प्रकारों की सूची जिनका यह पेमेंटइंटेंट उपयोग कर सकता है।
shipping	object	PaymentIntent के लिए शिपिंग जानकारी।
statement_descriptor	string	आपके ग्राहक के क्रेडिट कार्ड स्टेटमेंट पर प्रदर्शित एक मनमाना स्ट्रिंग।
statement_descriptor_suffix	string	आपके ग्राहक के क्रेडिट कार्ड स्टेटमेंट पर प्रदर्शित अतिरिक्त विवरण प्रदान करता है।
expand[]	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स का विस्तार किया जाना चाहिए।

पेमेंट इंटेंट खोजें

Stripe की सर्च क्वेरी भाषा का उपयोग करके, आप पहले से बनाए गए पेमेंट इंटेंट खोज सकते हैं।

रीड-आफ्टर-राइट फ़्लो में, जहाँ सख्त संगति की आवश्यकता होती है, वहाँ खोज अनुरोध का उपयोग न करें। सामान्य संचालन में, डेटा एक मिनट से कम समय के लिए खोजने योग्य होता है। कभी-कभी, आउटेज के दौरान नए या अपडेट किए गए डेटा का प्रसारण एक घंटे तक पीछे हो सकता है।

नोट

खोज फ़ंक्शन भारत में व्यापारियों के लिए उपलब्ध नहीं है।

एंडपॉइंट: https://api.stripe.com/v1/payment_intents/search

ऑपरेशन: GET

उदाहरण

cURL उदाहरण:

curl -X GET "https://api.stripe.com/v1/payment_intents/search?query=amount:1000" \
  -u <YOUR_SECRET_KEY>:

प्रतिक्रियाएँ

प्रतिक्रियाएँ मानक कोड लौटाएँगी।

200: OK

{
  "object": "search_result",
  "data": [],
  "has_more": false,
  "next_page": null,
  "url": "/v1/payment_intents/search"
}

400: Bad Request

{
  "error": {
    "code": "parameter_invalid_string",
    "doc_url": "https://stripe.com/docs/error-codes/parameter-invalid-string",
    "message": "एक मान्य खोज क्वेरी स्ट्रिंग के साथ एक क्वेरी पैरामीटर प्रदान करें।",
    "param": "query",
    "type": "invalid_request_error"
  }
}

401: Unauthorized

{
  "error": {
    "type": "invalid_request_error",
    "message": "अमान्य API कुंजी प्रदान की गई: sk_test_********************1234"
  }
}

पैरामीटर

Query parameters

Parameter	Type	Description
expand[]	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स को विस्तारित किया जाना चाहिए।
limit	integer	लौटाए जाने वाले ऑब्जेक्ट्स की संख्या पर एक सीमा। सीमा 1 और 100 के बीच हो सकती है, और डिफ़ॉल्ट 10 है।
page	string	परिणामों के कई पृष्ठों पर पेजिनेशन के लिए एक कर्सर। पहली कॉल पर इस पैरामीटर को शामिल न करें। बाद के परिणामों का अनुरोध करने के लिए पिछले प्रतिक्रिया में लौटाए गए next_page मान का उपयोग करें।
query	string	(आवश्यक) खोज क्वेरी स्ट्रिंग। खोज क्वेरी भाषा और भुगतान इरादों के लिए समर्थित क्वेरी फ़ील्ड की सूची देखें।