getSessionById

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

Payments.getSessionById(id)

const value = await Payments.getSessionById(1764)

Схема

id:* число
Идентификатор извлекаемого объекта платежной сессии
пример: 12

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

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

{
  "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...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret..."
}

Схема

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_3Oyz2kQWz...