Перейти к основному контенту

createSession

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

Описание

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

Payments.createSession(

orderId, type, automaticTaxEnabled

);

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

Схема

orderId(обязательно): number
Идентификатор заказа
пример: 12345

type(обязательно): 'session' | 'intent'
Тип сессии. Возможные значения: "session" или "intent"
пример: 'session'

automaticTaxEnabled: boolean
Автоматический расчет налоговой ставки. По умолчанию: false
пример: false

Примеры

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

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

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

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

Схема ответа

Схема: ICreateSessionEntity

id: number
Идентификатор объекта.
пример: 12345

updatedDate: string
Дата изменения объекта.
пример: "2023-10-01T12:00:00Z"

version: number
Версия объекта.
пример: 1

identifier: string
Текстовый идентификатор для поля записи.
пример: "payment_12345"

paymentUrl: string
Ссылка на платеж.
пример: "https://example.com/payment/12345"