getSessions

Get list of payment sessions. 🔐 This method requires authorization?.

Payments?.getSessions( offset?, limit? );

Minimal example

const value = await Payments.getSessions()

Schema

offset: number
Optional parameter for pagination. Default: 0
example: 0

limit: number
Optional parameter for pagination. Default: 30
example: 30

This method get list of a payment session. It returns a Promise that resolves to a payment session object.

Example response

{
  "items": [
    {
      "id": 39,
      "createdDate": "2025-07-21T01:54:37.970Z",
      "updatedDate": "2025-07-21T01:54:37.970Z",
      "type": "session",
      "status": "waiting",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1ViNRkfG52Bc4Y0rkCL2314sDbHEou2OgLonclktvY2z01sW1N77xCJ2Z#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 38,
      "createdDate": "2025-07-20T18:14:14.130Z",
      "updatedDate": "2025-07-21T01:54:37.963Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1NcxusFpMTralMKJ5K3NbszxwZnVls8U8wTSSRgso5VN34xq2KLqoZy3U#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    {
      "id": 37,
      "createdDate": "2025-07-18T05:51:20.359Z",
      "updatedDate": "2025-07-21T01:54:37.963Z",
      "type": "session",
      "status": "canceled",
      "paymentAccountId": 3,
      "orderId": 205,
      "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a11RVsxlC8MNSuzMMi9dR7Bm63vteiDK7lzXJnD8DeGcT5ozpWNeKIwmAu#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"
    },
    "..."
  ],
  "total": 35
}

Schema

total: number
Total number of found records.
example: 100

items: ISessionEntity
Array of session objects.
example:

[
  {
    "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
  }
]

id: number
Object identifier.
example: 1764

createdDate: string
Object creation date.
example: "2025-02-26T10:13:16.839Z"

updatedDate: string
Object modification date.
example: "2025-02-26T10:13:16.839Z"

type: string
Type may be 'session' or 'intent'.
example: "session"

status: string
Payment status.
example: "completed"

paymentAccountId: number
Payment ID from an external provider.
example: NaN

orderId: number
Order identifier.
example: 1

paymentUrl: string | null
payment link.
example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

---