سرد جميع عمليات استرداد الأموال
تُرجع قائمة بعمليات الاسترداد الحالية. تعرض 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 لتحديد مكانك في القائمة. إذا قمت بإرسال طلب قائمة وتلقيت 100 نتيجة، تبدأ بـ obj_bar، فيمكن أن تتضمن المكالمة التالية ending_before=obj_bar لجلب الصفحة السابقة من القائمة. |
limit | عدد صحيح | يحدد الحد الأقصى لعدد السجلات في الاستجابة. أدخل عددًا صحيحًا من 1 إلى 100 (القيمة الافتراضية: 10). |
payment_intent | سلسلة نصية | معرف PaymentIntent الذي تريد استرداد المبالغ المدفوعة المتعلقة به. إذا تم تجاهله، تعرض Stripe جميع عمليات استرداد المبالغ المدفوعة للحساب. |
starting_after | سلسلة نصية | مؤشر للاستخدام في ترقيم الصفحات. استخدم معرف الكائن starting_after لتحديد مكانك في القائمة. إذا قمت بإجراء طلب قائمة وتلقيت 100 نتيجة، تنتهي بـ obj_foo، فيمكن أن تتضمن استدعاءاتك اللاحقة starting_after=obj_foo لجلب الصفحة التالية من القائمة. |
expand[] | مصفوفة سلاسل نصية | يحدد كائنات الاستجابة المتداخلة لإثرائها وإرجاعها بشكل مضمن. |