getSessions

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

Payments.getSessions(offset, limit)

const value = await Payments.getSessions()

Schema

offset: number
معامل اختياري للتصفح، القيمة الافتراضية هي 0
مثال: 0

limit: number
معامل اختياري للتصفح، القيمة الافتراضية هي 30
مثال: 30

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

مثال على الإرجاع:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "updatedDate": "2024-06-21T09:51:57.785Z",
      "type": "session",
      "status": "completed",
      "orderId": 1,
      "paymentAccountId": 1,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
      "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
    }
  ]
}

Schema

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

updatedDate: string
تاريخ تعديل الكائن

version: number
رقم إصدار تعديل الكائن
مثال: 10

identifier: string
معرف نصي لحقل السجل
مثال: catalog

type: string
يمكن أن يكون النوع 'session' أو 'intent'
مثال: session

lineItems: array
قائمة العناصر

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

paymentAccountId: number
معرف كائن حساب الدفع
مثال: 1

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

sessionId: string
معرف الدفع من مزود خارجي
مثال: 9BE88048TU058770M

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

successUrl: string
رابط إعادة التوجيه بعد الدفع الناجح
مثال: https://example.com/success

cancelUrl string
رابط إعادة التوجيه بعد إلغاء الدفع
مثال: https://example.com/cancel

intent string
مثال:

{
  "amount": 1,
  "currency": "usd"
}

intentId number
معرف كائن النية
مثال: 1

clientSecret string
مفتاح السر الخاص بالعميل
مثال: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2