وظائف واجهة برمجة تطبيقات الغرض من الدفع

قائمة بجميع نوايا الدفع

إرجاع قائمة بنوايا الدفع.

نقطة النهاية: https://api.stripe.com/v1/payment_intents

العملية: GET

أمثلة

cURL Example:

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

الردود

ستُرجع الردود رموزًا قياسية.

200: موافق

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

400: طلب سيء

{
  "error": {
    "message": "إذا قمت بتمرير مصفوفة بمفاتيح صريحة (مثل foo[0]=a&foo[1]=b) بدلاً من مصفوفة (مثل foo[]=a&foo[]=b)، يجب أن تكون المفاتيح رقمية ومتسلسلة بدءًا من 0. لقد مررت المفاتيح `1`، توقعنا أن يكون المفتاح بالقيمة `0`.",
    "param": "expand",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
    "type": "invalid_request_error"
  }
}

401: غير مصرح به

{
  "error": {
    "type": "invalid_request_error",
    "message": "مفتاح API غير صالح المقدم: sk_test_********************1234"
  }
}

المعلمات

معلمات الاستعلام

المعلمة	النوع	الوصف
limit	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 10.
starting_after	string	مؤشر للاستخدام في ترقيم الصفحات. starting_after هو معرف كائن يحدد مكانك في القائمة.
ending_before	string	مؤشر للاستخدام في ترقيم الصفحات. ending_before هو معرف كائن يحدد مكانك في القائمة.
expand[]	array of strings	يحدد الحقول التي يجب توسيعها في الاستجابة.

إنشاء نية الدفع

بمجرد إنشاء نية الدفع، قم بإرفاق طريقة دفع وتأكيد متابعة الدفع.

استخدام confirm=true أثناء الإنشاء يعادل إنشاء وتأكيد نية الدفع في نفس المكالمة. يتيح تطبيق confirm=true استخدام أي معلمات في confirm واجهة برمجة التطبيقات.

نقطة النهاية: https://api.stripe.com/v1/payment_intents

العملية: POST

ملاحظة

يجب تقديم طلب confirm عبر HTTPS.

أمثلة

cURL Example:

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: موافق

{
    "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: طلب سيء

{
  "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: غير مصرح به

{
  "error": {
    "type": "invalid_request_error",
    "message": "مفتاح API غير صالح المقدم: sk_test_********************1234"
  }
}

المعلمات

معلمات الجسم

المعلمة	النوع	الوصف
amount	integer	(مطلوب) المبلغ المراد تحصيله. عدد صحيح موجب يمثل المبلغ المراد تحصيله بأصغر وحدة عملة (على سبيل المثال، 100 سنت لتحصيل 1.00 دولار أمريكي).
currency	string	(مطلوب) رمز عملة ISO المكون من ثلاثة أحرف، بأحرف صغيرة. يجب أن تكون عملة مدعومة.
confirm	boolean	تعيينه إلى true لمحاولة تأكيد PaymentIntent هذا فورًا.
customer	string	معرف العميل الذي ينتمي إليه PaymentIntent هذا، إذا كان موجودًا.
description	string	سلسلة عشوائية مرفقة بالكائن.
payment_method	string	معرف طريقة الدفع لإرفاقها بـ PaymentIntent هذا.
payment_method_types[]	array of strings	قائمة أنواع طرق الدفع التي يمكن أن يستخدمها PaymentIntent هذا.
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 Example:

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

الردود

ستعيد الردود رموزًا قياسية.

200: موافق

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

400: طلب سيء

{
  "error": {
    "code": "parameter_invalid_string",
    "doc_url": "https://stripe.com/docs/error-codes/parameter-invalid-string",
    "message": "توفير معلمة استعلام بسلسلة استعلام بحث صالحة.",
    "param": "query",
    "type": "invalid_request_error"
  }
}

401: غير مصرح به

{
  "error": {
    "type": "invalid_request_error",
    "message": "مفتاح API غير صالح المقدم: sk_test_********************1234"
  }
}

المعلمات

معلمات الاستعلام

المعلمة	النوع	الوصف
expand[]	array of strings	يحدد الحقول التي يجب توسيعها في الاستجابة.
limit	integer	حد لعدد الكائنات التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 10.
page	string	مؤشر لترقيم الصفحات عبر صفحات متعددة من النتائج. لا تقم بتضمين هذه المعلمة في الاستدعاء الأول. استخدم قيمة next_page التي تم إرجاعها في استجابة سابقة لطلب النتائج اللاحقة.
query	string	(مطلوب) سلسلة استعلام البحث. راجع لغة استعلام البحث وقائمة حقول الاستعلام المدعومة لمقاصد الدفع.