createSession

Создание платежной сессии 🔐 Этот метод требует авторизации.

Payments.createSession(orderId, type, automaticTaxEnabled)

const value = await Payments.createSession(1, 'session')

Схема

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

type:* 'session' | 'intent'
Тип сессии
пример: session

automaticTaxEnabled: логическое значение
Автоматический расчет налоговой ставки
пример: false

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

Пример возвращаемого значения:

{
  "id": 1764,
  "updatedDate": "2024-06-21T09:53:28.898Z",
  "version": 10,
  "identifier": "my-id",
  "paymentUrl": "https://paymewntlink.com"
}

Схема

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

.