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

मौजूदा रिफंड्स की एक सूची लौटाता है। Stripe रिफंड्स को उल्टे कालानुक्रमिक क्रम में प्रदर्शित करता है, सबसे हाल की प्रविष्टियों को पहले दिखाता है। प्रतिक्रिया में डिफ़ॉल्ट रूप से 10 सबसे हाल की रिफंड्स शामिल होती हैं।

GET https://api.stripe.com/v1/refunds

उदाहरण

cURL उदाहरण:

cURL

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

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

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

200: OK

Response

{
  "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

Response

{
    "error": {
        "code": "resource_missing",
        "doc_url": "https://stripe.com/docs/error-codes/resource-missing",
        "message": "No such charge: 'ch_1NirD82eZvKYlo2CIvbtLWuY'",
        "param": "charge",
        "request_log_url": "https://dashboard.stripe.com/test/logs/req_HIH2jWkJGecwCk?t=1754504399",
        "type": "invalid_request_error"
    }
}

401: Unauthorized

Response

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid API Key provided: sk_test_********************1234"
  }
}

पैरामीटर

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

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