getSessions

Получить список платежных сессий. 🔐 Этот метод требует авторизации.

Описание

Этот метод получает список платежной сессии. Он возвращает Promise, который разрешается в объект платежной сессии ISessionsEntity.

Payments.getSessions(

offset, limit

);

Схема параметров

Схема

offset: number
Необязательный параметр для пагинации. По умолчанию: 0
пример: 0

limit: number
Необязательный параметр для пагинации. По умолчанию: 30
пример: 30

Примеры

Минимальный пример

const response = await Payments.getSessions();

Пример с атрибутами

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

Пример ответа

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

Схема ответа

Схема: 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: string
Тип может быть 'session' или 'intent'.
пример: "session"

items.status: string
Статус платежа.
пример: "completed"

items.paymentAccountId: number
ID платежа от внешнего провайдера.
пример: NaN

items.orderId: number
Идентификатор заказа.
пример: 1

items.paymentUrl: string | null
ссылка на платеж.
пример: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M"

---