Files
yookassa-sdk-php/docs/classes/YooKassa-Model-Settings-Me.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

37 KiB

YooKassa API SDK

Class: \YooKassa\Model\Settings\Me

Namespace: \YooKassa\Model\Settings


Summary:

Класс, представляющий модель Me.

Description:

Объект настроек магазина или шлюза (Me) — актуальная информация о настройках магазина или шлюза.


Constants

Visibility Name Flag Summary
public STATUS_ENABLED Подключен к ЮKassa, может проводить платежи или выплаты
public STATUS_DISABLED Не может проводить платежи или выплаты (еще не подключен, закрыт или временно не работает)

Properties

Visibility Name Flag Summary
public $account_id Идентификатор магазина или шлюза.
public $accountId Идентификатор магазина или шлюза.
public $fiscalization Настройки магазина для отправки чеков в налоговую.
public $fiscalization_enabled Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. Используйте объект ~fiscalization, чтобы определить, какие у магазина настройки отправки чеков.
public $fiscalizationEnabled Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. Используйте объект ~fiscalization, чтобы определить, какие у магазина настройки отправки чеков.
public $itn ИНН магазина (10 или 12 цифр). Присутствует, если вы запрашивали настройки магазина.
public $name Название шлюза, которое отображается в личном кабинете ЮKassa. Присутствует, если вы запрашивали настройки шлюза.
public $payment_methods Список способов оплаты, доступных магазину. Присутствует, если вы запрашивали настройки магазина.
public $paymentMethods Список способов оплаты, доступных магазину. Присутствует, если вы запрашивали настройки магазина.
public $payout_balance Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.
public $payout_methods Список способов получения выплат, доступных шлюзу. Возможные значения: bank_card — выплаты на банковские карты; yoo_money — выплаты на кошельки ЮMoney; sbp — выплаты через СБП. Присутствует, если вы запрашивали настройки шлюза.
public $payoutBalance Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.
public $payoutMethods Список способов получения выплат, доступных шлюзу. Возможные значения: bank_card — выплаты на банковские карты; yoo_money — выплаты на кошельки ЮMoney; sbp — выплаты через СБП. Присутствует, если вы запрашивали настройки шлюза.
public $status Статус магазина или шлюза.
public $test Это тестовый магазин или шлюз.

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAccountId() Возвращает идентификатор магазина или шлюза.
public getFiscalization() Возвращает настройки магазина для отправки чеков в налоговую.
public getFiscalizationEnabled() deprecated Возвращает признак включенной фискализации.
public getItn() Возвращает ИНН магазина.
public getName() Возвращает название шлюза.
public getPaymentMethods() Возвращает список способов оплаты, доступных магазину.
public getPayoutBalance() Возвращает баланс вашего шлюза.
public getPayoutMethods() Возвращает список способов получения выплат.
public getStatus() Возвращает статус магазина или шлюза.
public getTest() Возвращает тестовый магазин или шлюз.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAccountId() Устанавливает идентификатор магазина или шлюза.
public setFiscalization() Устанавливает настройки магазина для отправки чеков в налоговую.
public setFiscalizationEnabled() deprecated Устанавливает признак включенной фискализации.
public setItn() Устанавливает ИНН магазина.
public setName() Устанавливает название шлюза.
public setPaymentMethods() Устанавливает список способов оплаты, доступных магазину.
public setPayoutBalance() Устанавливает Баланс вашего шлюза.
public setPayoutMethods() Устанавливает список способов получения выплат.
public setStatus() Устанавливает статус магазина или шлюза.
public setTest() Устанавливает тестовый магазин или шлюз.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

STATUS_ENABLED

Подключен к ЮKassa, может проводить платежи или выплаты

STATUS_ENABLED = 'enabled'

STATUS_DISABLED

Не может проводить платежи или выплаты (еще не подключен, закрыт или временно не работает)

STATUS_DISABLED = 'disabled'

Properties

public $account_id : string


Description

Идентификатор магазина или шлюза.

Type: string

Details:

public $accountId : string


Description

Идентификатор магазина или шлюза.

Type: string

Details:

public $fiscalization : \YooKassa\Model\Settings\FiscalizationData


Description

Настройки магазина для отправки чеков в налоговую.

Type: FiscalizationData

Details:

public $fiscalization_enabled : bool


Description

Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. Используйте объект ~fiscalization, чтобы определить, какие у магазина настройки отправки чеков.

Type: bool

Details:

public $fiscalizationEnabled : bool


Description

Устаревший параметр, который раньше использовался для определения настроек отправки чеков в налоговую. Сохранен для поддержки обратной совместимости, в новых версиях API может быть удален. Используйте объект ~fiscalization, чтобы определить, какие у магазина настройки отправки чеков.

Type: bool

Details:

public $itn : string|null


Description

ИНН магазина (10 или 12 цифр). Присутствует, если вы запрашивали настройки магазина.

Type: string|null

Details:

public $name : string|null


Description

Название шлюза, которое отображается в личном кабинете ЮKassa. Присутствует, если вы запрашивали настройки шлюза.

Type: string|null

Details:

public $payment_methods : string[]|array


Description

Список способов оплаты, доступных магазину. Присутствует, если вы запрашивали настройки магазина.

Type: string[]|array

Details:

public $paymentMethods : string[]|array


Description

Список способов оплаты, доступных магазину. Присутствует, если вы запрашивали настройки магазина.

Type: string[]|array

Details:

public $payout_balance : \YooKassa\Model\AmountInterface|null


Description

Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.

Type: AmountInterface|null

Details:

public $payout_methods : string[]|array


Description

Список способов получения выплат, доступных шлюзу. Возможные значения: bank_card — выплаты на банковские карты; yoo_money — выплаты на кошельки ЮMoney; sbp — выплаты через СБП. Присутствует, если вы запрашивали настройки шлюза.

Type: string[]|array

Details:

public $payoutBalance : \YooKassa\Model\AmountInterface|null


Description

Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.

Type: AmountInterface|null

Details:

public $payoutMethods : string[]|array


Description

Список способов получения выплат, доступных шлюзу. Возможные значения: bank_card — выплаты на банковские карты; yoo_money — выплаты на кошельки ЮMoney; sbp — выплаты через СБП. Присутствует, если вы запрашивали настройки шлюза.

Type: string[]|array

Details:

public $status : string


Description

Статус магазина или шлюза.

Type: string

Details:

public $test : bool


Description

Это тестовый магазин или шлюз.

Type: bool

Details:


Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства
mixed value Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string propertyName Имя удаляемого свойства

Returns: void -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

Parameters:
Type Name Description
array OR \Traversable sourceArray Ассоциативный массив с настройками

Returns: void -

public getAccountId() : string|null

public getAccountId() : string|null

Summary

Возвращает идентификатор магазина или шлюза.

Details:

Returns: string|null -

public getFiscalization() : \YooKassa\Model\Settings\FiscalizationData|null

public getFiscalization() : \YooKassa\Model\Settings\FiscalizationData|null

Summary

Возвращает настройки магазина для отправки чеков в налоговую.

Details:

Returns: \YooKassa\Model\Settings\FiscalizationData|null -

(deprecated) - public getFiscalizationEnabled() : bool|null

public getFiscalizationEnabled() : bool|null

Summary

Возвращает признак включенной фискализации.

Deprecated DeprecatedУстарел. Details:

Returns: bool|null -

public getItn() : string|null

public getItn() : string|null

Summary

Возвращает ИНН магазина.

Details:

Returns: string|null -

public getName() : string|null

public getName() : string|null

Summary

Возвращает название шлюза.

Details:

Returns: string|null -

public getPaymentMethods() : string[]|array|null

public getPaymentMethods() : string[]|array|null

Summary

Возвращает список способов оплаты, доступных магазину.

Details:

Returns: string[]|array|null -

public getPayoutBalance() : \YooKassa\Model\AmountInterface|null

public getPayoutBalance() : \YooKassa\Model\AmountInterface|null

Summary

Возвращает баланс вашего шлюза.

Details:

Returns: \YooKassa\Model\AmountInterface|null -

public getPayoutMethods() : string[]|null

public getPayoutMethods() : string[]|null

Summary

Возвращает список способов получения выплат.

Details:

Returns: string[]|null -

public getStatus() : string|null

public getStatus() : string|null

Summary

Возвращает статус магазина или шлюза.

Details:

Returns: string|null -

public getTest() : bool|null

public getTest() : bool|null

Summary

Возвращает тестовый магазин или шлюз.

Details:

Returns: bool|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства
mixed value Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string offset Имя удаляемого свойства

Returns: void -

public setAccountId() : self

public setAccountId(string|int|null $account_id = null) : self

Summary

Устанавливает идентификатор магазина или шлюза.

Details:

Parameters:
Type Name Description
string OR int OR null account_id

Returns: self -

public setFiscalization() : self

public setFiscalization(\YooKassa\Model\Settings\FiscalizationData|array|null $fiscalization = null) : self

Summary

Устанавливает настройки магазина для отправки чеков в налоговую.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Settings\FiscalizationData OR array OR null fiscalization Настройки магазина для отправки чеков в налоговую.

Returns: self -

(deprecated) - public setFiscalizationEnabled() : self

public setFiscalizationEnabled(bool|null $fiscalization_enabled = null) : self

Summary

Устанавливает признак включенной фискализации.

Deprecated DeprecatedУстарел. Details:

Parameters:
Type Name Description
bool OR null fiscalization_enabled Признак включенной фискализации.

Returns: self -

public setItn() : self

public setItn(string|null $itn = null) : self

Summary

Устанавливает ИНН магазина.

Details:

Parameters:
Type Name Description
string OR null itn ИНН магазина (10 или 12 цифр).

Returns: self -

public setName() : self

public setName(string|null $name = null) : self

Summary

Устанавливает название шлюза.

Details:

Parameters:
Type Name Description
string OR null name Название шлюза, которое отображается в личном кабинете ЮKassa.

Returns: self -

public setPaymentMethods() : self

public setPaymentMethods(string[]|array|null $payment_methods = null) : self

Summary

Устанавливает список способов оплаты, доступных магазину.

Details:

Parameters:
Type Name Description
string[] OR array OR null payment_methods Список способов оплаты, доступных магазину.

Returns: self -

public setPayoutBalance() : self

public setPayoutBalance(\YooKassa\Model\AmountInterface|array|null $payout_balance = null) : self

Summary

Устанавливает Баланс вашего шлюза.

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null payout_balance Баланс вашего шлюза. Присутствует, если вы запрашивали настройки шлюза.

Returns: self -

public setPayoutMethods() : self

public setPayoutMethods(string[]|array|null $payout_methods = null) : self

Summary

Устанавливает список способов получения выплат.

Details:

Parameters:
Type Name Description
string[] OR array OR null payout_methods Список способов получения выплат, доступных шлюзу.

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

Устанавливает статус магазина или шлюза.

Details:

Parameters:
Type Name Description
string OR null status Статус магазина или шлюза.

Returns: self -

public setTest() : self

public setTest(bool|null $test = null) : self

Summary

Устанавливает тестовый магазин или шлюз.

Details:

Parameters:
Type Name Description
bool OR null test Это тестовый магазин или шлюз.

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney