रिफंड एपीआई फ़ंक्शन

रिफंड बनाएँ

पहले से बनाए गए लेकिन अभी तक रिफंड नहीं किए गए चार्ज के लिए रिफंड बनाता है। रिफंड की जाने वाली राशि निर्दिष्ट की जा सकती है, या राशि निर्दिष्ट न करके पूरे चार्ज की राशि रिफंड की जा सकती है। रिफंड उसी मुद्रा में और उसी भुगतान विधि से बनाया जाएगा जैसे चार्ज था।

एक चार्ज को एक से अधिक बार रिफंड नहीं किया जा सकता। यदि आप किसी ऐसे शुल्क का रिफंड करने का प्रयास करते हैं जो पहले ही रिफंड हो चुका है, तो एक त्रुटि लौटाई जाएगी। ऐसा तब भी होगा जब आप मूल शुल्क राशि से अधिक का रिफंड करने का प्रयास करते हैं।

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

ऑपरेशन: POST

उदाहरण

cURL उदाहरण:

curl -X POST https://api.stripe.com/v1/refunds \
  -u <YOUR_SECRET_KEY>: \
  -d "charge=ch_1NirD82eZvKYlo2CIvbtLWuY"

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

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

200: OK

{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 212,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": 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	रिफंड की जाने वाली राशि, सेंट में। यदि निर्दिष्ट नहीं किया गया है, तो पूरी चार्ज राशि वापस कर दी जाएगी।
`charge`	string	(आवश्यक) उस चार्ज की आईडी जिसे रिफंड करना है।
`currency`	string	लोअरकेस में तीन-अक्षर वाला ISO करेंसी कोड। यह एक समर्थित करेंसी होनी चाहिए। यदि निर्दिष्ट नहीं किया गया है, तो चार्ज की करेंसी का उपयोग किया जाएगा।
`expand[]`	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स को विस्तारित किया जाना चाहिए।
`customer`	string	उस ग्राहक की आईडी जिसे चार्ज से संबंधित है।
`reason`	string	रिफंड का कारण। यदि सेट है, तो संभावित मान `duplicate`, `fraudulent`, या `requested_by_customer` हैं। यदि `fraudulent` के रूप में सेट है, तो चार्ज से जुड़ा कार्ड और ईमेल आपकी ब्लॉक सूचियों में जोड़ दिए जाएँगे, और यह Stripe के धोखाधड़ी का पता लगाने में सुधार करने में मदद करेगा।
`payment_intent`	string	रिफंड करने के लिए PaymentIntent की आईडी।
`refund_application_fee`	boolean	यह इंगित करता है कि आवेदन शुल्क वापस किया जाना चाहिए या नहीं। यदि पूरी राशि वापस की जाती है, तो आवेदन शुल्क भी वापस कर दिया जाएगा। अन्यथा, आवेदन शुल्क रिफंड के अनुपात में वापस कर दिया जाएगा। एप्लिकेशन शुल्क केवल उसी एप्लिकेशन का हो सकता है जिसने चार्ज बनाया था।
`origin`	string	रिफंड का स्रोत।
`reverse_transfer`	boolean	यह इंगित करता है कि क्या ट्रांसफर को उलटना चाहिए। ट्रांसफर, रिफंड राशि के अनुपात में उलटाया जाता है (पूरा या आंशिक रिफंड)।
`instructions_email`	string	जब रिफंड सपोर्ट के बिना भुगतान विधि का उपयोग किया जाता है, तो रिफंड निर्देशों के लिए ग्राहक के ईमेल पते का उपयोग करता है।

रिफंड को अपडेट करें

पास किए गए पैरामीटरों के मानों को सेट करके निर्दिष्ट रिफंड को अपडेट करता है। प्रदान नहीं किए गए किसी भी पैरामीटर को अपरिवर्तित छोड़ा जाएगा। यह रिफंड के बारे में अतिरिक्त जानकारी संग्रहीत करने के लिए उपयोगी है।

एंडपॉइंट: https://api.stripe.com/v1/refunds/{id}

ऑपरेशन: POST

उदाहरण

cURL उदाहरण:

curl -X POST `https://api.stripe.com/v1/refunds/{id}` \
  -u <YOUR_SECRET_KEY>: \
  -d "metadata[order_id]=6735"

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

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

200: OK

{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {
    "order_id": "6735"
  },
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": 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
`metadata`	object	की-वैल्यू जोड़ों का सेट जिसे आप किसी ऑब्जेक्ट से जोड़ सकते हैं। यह किसी संरचित प्रारूप में ऑब्जेक्ट के बारे में अतिरिक्त जानकारी संग्रहीत करने के लिए उपयोगी हो सकता है।
`expand[]`	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स को विस्तारित किया जाना चाहिए।

Path variables

Name	Type	Required	Description
`id`	string	Required	अपडेट किए जाने वाले रिफंड की आईडी।

रिफंड प्राप्त करें

किसी विशिष्ट रिफंड का विवरण प्राप्त करता है।

एंडपॉइंट: https://api.stripe.com/v1/refunds/{id}

ऑपरेशन: GET

उदाहरण

cURL उदाहरण:

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

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

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

200: OK

{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 212,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": 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"
  }
}

पैरामीटर

Query parameters

Parameter	Type	Description
`expand[]`	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में कौन से फ़ील्ड का विस्तार किया जाना चाहिए।

Path variables

Name	Type	Required	Description
`id`	string	Required	पुनर्प्राप्त करने के लिए रिफंड की आईडी।

सभी रिफंड सूचीबद्ध करें

मौजूदा रिफंड की एक सूची लौटाता है। रिफंड क्रमबद्ध क्रम में लौटाए जाते हैं, जिसमें सबसे हाल के रिफंड पहले दिखाई देते हैं। डिफ़ॉल्ट रूप से 10 सबसे हाल के रिफंड लौटाए जाते हैं।

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

ऑपरेशन: GET

उदाहरण

cURL उदाहरण:

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

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

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

200: OK

{
  "object": "list",
  "url": "/v1/refunds",
  "has_more": false,
  "data": [
    {
      "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
      "object": "refund",
      "amount": 212,
      "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
      "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
      "created": 1692942318,
      "currency": "usd",
      "destination_details": {
        "card": {
          "reference": "123456789012",
          "reference_status": "available",
          "reference_type": "acquirer_reference_number",
          "type": "refund"
        },
        "type": "card"
      },
      "metadata": {},
      "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
      "reason": null,
      "receipt_number": null,
      "source_transfer_reversal": null,
      "status": "succeeded",
      "transfer_reversal": null
    }
  ]
}

400: Bad Request

{
    "error": {
        "code": "resource_missing",
        "doc_url": "https://stripe.com/docs/error-codes/resource-missing",
        "message": "ऐसा कोई चार्ज नहीं है: 'ch_1NirD82eZvKYlo2CIvbtLWuY'",
        "param": "charge",
        "request_log_url": "https://dashboard.stripe.com/test/logs/req_HIH2jWkJGecwCk?t=1754504399",
        "type": "invalid_request_error"
    }
}

401: Unauthorized

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

पैरामीटर

Parameter	Type	Description
`charge`	string	उस चार्ज की आईडी जिसके लिए रिफंड प्राप्त करना है। यदि निर्दिष्ट नहीं किया गया है, तो सभी रिफंड वापस कर दिए जाएँगे।
`created`	dictionary	केवल दिए गए दिनांक अंतरालों के दौरान बनाए गए रिफंड लौटाता है। यह निम्नलिखित कुंजियों वाली एक डिक्शनरी हो सकती है: `gt`, `gte`, `lt`, `lte`।
`ending_before`	string	पेजिनेशन में उपयोग के लिए एक कर्सर। सूची में अपनी जगह को परिभाषित करने के लिए ऑब्जेक्ट आईडी `ending_before` का उपयोग करें। यदि आप एक सूची अनुरोध करते हैं और `obj_bar` से शुरू होने वाले 100 परिणाम प्राप्त करते हैं, तो आपकी अगली कॉल में सूची का पिछला पेज प्राप्त करने के लिए `ending_before=obj_bar` शामिल हो सकता है।
`limit`	integer	लौटाए जाने वाले ऑब्जेक्ट्स की संख्या पर सीमा। सीमा 1 और 100 के बीच हो सकती है। डिफ़ॉल्ट 10 है।
`payment_intent`	string	उस पेमेंट इंटेंट की आईडी जिसके लिए रिफंड प्राप्त करना है। यदि निर्दिष्ट नहीं किया गया है, तो सभी रिफंड लौटाए जाएंगे।
`starting_after`	string	पेजिनेशन में उपयोग के लिए एक कर्सर। सूची में अपनी जगह को परिभाषित करने के लिए `starting_after` ऑब्जेक्ट आईडी का उपयोग करें। यदि आप एक सूची अनुरोध करते हैं और `obj_foo` पर समाप्त होने वाले 100 परिणाम प्राप्त करते हैं, तो आपकी अगली कॉल में सूची का अगला पृष्ठ प्राप्त करने के लिए `starting_after=obj_foo` शामिल हो सकता है।
`expand[]`	array of strings	निर्दिष्ट करता है कि प्रतिक्रिया में किन फ़ील्ड्स को विस्तारित किया जाना चाहिए।

रिफंड बनाएँ​

उदाहरण​

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

पैरामीटर​

Body parameters​

रिफंड को अपडेट करें​

उदाहरण​

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

पैरामीटर​

Body parameters​

Path variables​

रिफंड प्राप्त करें​

उदाहरण​

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

पैरामीटर​

Query parameters​

Path variables​

सभी रिफंड सूचीबद्ध करें​

उदाहरण​

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

पैरामीटर​

रिफंड बनाएँ

उदाहरण

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

पैरामीटर

Body parameters

रिफंड को अपडेट करें

उदाहरण

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

पैरामीटर

Body parameters

Path variables

रिफंड प्राप्त करें

उदाहरण

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

पैरामीटर

Query parameters

Path variables

सभी रिफंड सूचीबद्ध करें

उदाहरण

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

पैरामीटर