getSessions

احصل على قائمة بجلسات الدفع. 🔐 تتطلب هذه الطريقة .

الوصف

تقوم هذه الطريقة بالحصول على قائمة بجلسة الدفع. تعيد Promise التي تحل إلى كائن جلسة الدفع ISessionsEntity.

.getSessions(

,

);

مخطط المعاملات

المخطط

offset: number
معامل اختياري للتقسيم. الافتراضي: 0
مثال: 0

limit: number
معامل اختياري للتقسيم. الافتراضي: 30
مثال: 30

بشكل افتراضي، يمكنك استرداد 10 كائنات. وذلك بسبب حد السجلات في إعدادات أذونات الوحدة.
لعمل التقسيم بشكل صحيح، تحتاج إلى تكوين أذونات الوحدة وفقًا لاحتياجاتك في القسم المقابل.

أمثلة

مثال بسيط

const response = await Payments.getSessions();

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

const response = await Payments.getSessions(0, 30);

مثال على الاستجابة

{
  "items": [
    {
      "id": 57,
      "createdDate": "2026-10-08T10:09:10.325Z",
      "updatedDate": "2026-10-08T10:09:10.325Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 56,
      "createdDate": "2026-09-25T17:22:34.327Z",
      "updatedDate": "2026-10-08T10:09:10.321Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    {
      "id": 55,
      "createdDate": "2026-09-03T13:30:30.543Z",
      "updatedDate": "2026-09-25T17:22:34.270Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 1,
      "orderId": 685,
      "amount": null,
      "paymentUrl": null
    },
    "..."
  ],
  "total": 52
}

مخطط الاستجابة

المخطط: ISessionsEntity

total: number
إجمالي عدد السجلات الموجودة.
مثال: 100

items: ISessionEntity[]
مصفوفة من كائنات الجلسة.
مثال:

[
  {
    "id": 27,
    "createdDate": "2025-06-04T04:38:32.849Z",
    "updatedDate": "2025-06-04T04:38:32.849Z",
    "type": "session",
    "status": "waiting",
    "paymentAccountId": 1,
    "orderId": 55,
    "paymentUrl": null
  }
]

items.id: number
معرف الكائن.
مثال: 1764

items.createdDate: string
تاريخ إنشاء الكائن.
مثال: "2025-02-26T10:13:16.839Z"

items.updatedDate: string
تاريخ تعديل الكائن.
مثال: "2025-02-26T10:13:16.839Z"

items.type: 'session' | 'intent'
يمكن أن يكون النوع 'session' أو 'intent'.
مثال: "session"

items.status: string
حالة الدفع.
مثال: "completed"

items.paymentAccountId: number
معرف حساب الدفع.
مثال: 1

items.orderId: number
معرف الطلب.
مثال: 1

items.paymentUrl: string | null
رابط الدفع.
مثال: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

items.amount: number | null
مبلغ جلسة الدفع.
مثال: 100

items.clientSecret: string
مفتاح السر الخاص بالعميل الذي يتم إرجاعه من قبل مزود الدفع (مثل Stripe) عند إنشاء جلسة.
مثال: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"

---