getSessions

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

Payments.getSessions(offset, limit)

const value = await Payments.getSessions()

Схема

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

limit: число
Необязательный параметр для постраничной навигации, по умолчанию 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"
    }
  ]
}

Схема

id: число
идентификатор объекта
пример: 1764

updatedDate: строка
дата изменения объекта

version: число
номер версии изменения объекта
пример: 10

identifier: строка
текстовый идентификатор для поля записи
пример: catalog

type: строка
тип может быть 'session' или 'intent'
пример: session

lineItems: массив
список элементов

orderId: число
идентификатор заказа
пример: 1

paymentAccountId: число
идентификатор объекта платежного аккаунта
пример: 1

status: строка
статус платежа
пример: completed

sessionId: строка
ID платежа от внешнего провайдера
пример: 9BE88048TU058770M

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

successUrl: строка
ссылка для перенаправления после успешного платежа
пример: https://example.com/success

cancelUrl строка
ссылка для перенаправления после отмены платежа
пример: https://example.com/cancel

intent строка
пример:

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

intentId число
идентификатор объекта намерения
пример: 1

clientSecret строка
секретный ключ клиента
пример: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2