getAccountById

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

Описание

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

Payments.getAccountById(

id, settings

);

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

Схема

id(обязательно): number
Идентификатор извлекаемого объекта платежного аккаунта
пример: 12345

settings(обязательно): any
Объект настроек
пример: !!!

Примеры

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

const response = await Payments.getAccountById(1764);

Пример с настройками для stripe

const settings = {
  "stripeAccountId": "acct_1RsDXzHy1QOsjfBI",
  "stripeOnboardingComplete": true,
  "stripePublishableKey": "pk_test_51OO...Y7MS3",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "sessionTimeout": 15
};
const response = await Payments.getAccountById(1764, settings);

Пример с настройками для yookassa

const settings = {
  "shopId": "1234567",
  "secretKey": "test_pazk0r3JNlMEEwQq6t3Syk-qapXL0ArHvdXYxtaDvcv",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "sessionTimeout": 15
};
const response = await Payments.getAccountById(1764, settings);

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

{
  "id": 1,
  "localizeInfos": {
    "en_US": {
      "title": "Cash"
    }
  },
  "identifier": "cash",
  "type": "custom",
  "isVisible": true,
  "isUsed": true
}

Схема ответа

Схема: IAccountsEntity

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

localizeInfos: ILocalizeInfo
Json описание объекта платежного аккаунта.

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

type: 'stripe' | 'custom'
Тип может быть 'stripe' или 'custom'.
пример: 'stripe'

isVisible: boolean
Индикатор видимости платежного аккаунта.
пример: true

isUsed: boolean
Индикатор использования платежного аккаунта.
пример: false

---