mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-19 18:20:41 +00:00
260d13f890
Добавлены нулевые привязки по СБП Добавлена причина отмены возвратов `payment_expired`
938 lines
35 KiB
Markdown
938 lines
35 KiB
Markdown
# [YooKassa API SDK](../home.md)
|
|
|
|
# Class: \YooKassa\Model\SavePaymentMethod\SavePaymentMethodBankCard
|
|
### Namespace: [\YooKassa\Model\SavePaymentMethod](../namespaces/yookassa-model-savepaymentmethod.md)
|
|
---
|
|
**Summary:**
|
|
|
|
Класс, представляющий модель SavePaymentMethod.
|
|
|
|
**Description:**
|
|
|
|
Сохраненный способ оплаты.
|
|
|
|
---
|
|
### Constants
|
|
* No constants found
|
|
|
|
---
|
|
### Properties
|
|
| Visibility | Name | Flag | Summary |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| public | [$card](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md#property_card) | | Данные банковской карты |
|
|
| public | [$confirmation](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_confirmation) | | Выбранный сценарий подтверждения привязки. Присутствует, когда привязка ожидает подтверждения от пользователя. |
|
|
| public | [$holder](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_holder) | | Данные магазина, для которого сохраняется способ оплаты. |
|
|
| public | [$id](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_id) | | Идентификатор сохраненного способа оплаты. |
|
|
| public | [$saved](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_saved) | | Признак сохранения способа оплаты для [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved). Возможные значения: * ~`true` — способ оплаты сохранен для автоплатежей и выплат; * ~`false` — способ оплаты не сохранен. |
|
|
| public | [$status](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_status) | | Статус проверки и сохранения способа оплаты. |
|
|
| public | [$title](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_title) | | Название способа оплаты. |
|
|
| public | [$type](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property_type) | | Код способа оплаты. Возможное значение: ~`bank_card` — банковская карта, ~`sbp` - СБП (Система быстрых платежей) |
|
|
| protected | [$_card](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md#property__card) | | Данные банковской карты |
|
|
| protected | [$_confirmation](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__confirmation) | | |
|
|
| protected | [$_holder](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__holder) | | Данные магазина, для которого сохраняется способ оплаты. |
|
|
| protected | [$_id](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__id) | | Идентификатор сохраненного способа оплаты. |
|
|
| protected | [$_saved](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__saved) | | Признак сохранения способа оплаты для [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved). Возможные значения: * ~`true` — способ оплаты сохранен для автоплатежей и выплат; * ~`false` — способ оплаты не сохранен. |
|
|
| protected | [$_status](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__status) | | Статус проверки и сохранения способа оплаты. |
|
|
| protected | [$_title](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__title) | | Название способа оплаты. |
|
|
| protected | [$_type](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#property__type) | | Код способа оплаты. Возможное значение: ~`bank_card` — банковская карта, ~`sbp` - СБП (Система быстрых платежей) |
|
|
|
|
---
|
|
### Methods
|
|
| Visibility | Name | Flag | Summary |
|
|
| ----------:| ---- | ---- | ------- |
|
|
| public | [__construct()](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md#method___construct) | | |
|
|
| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства. |
|
|
| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства. |
|
|
| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства. |
|
|
| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство. |
|
|
| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива. |
|
|
| public | [getCard()](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md#method_getCard) | | Возвращает card. |
|
|
| public | [getConfirmation()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getConfirmation) | | Возвращает confirmation. |
|
|
| public | [getHolder()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getHolder) | | Возвращает holder. |
|
|
| public | [getId()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getId) | | Возвращает id. |
|
|
| public | [getSaved()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getSaved) | | Возвращает saved. |
|
|
| public | [getStatus()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getStatus) | | Возвращает status. |
|
|
| public | [getTitle()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getTitle) | | Возвращает title. |
|
|
| public | [getType()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_getType) | | Возвращает type. |
|
|
| public | [getValidator()](../classes/YooKassa-Common-AbstractObject.md#method_getValidator) | | |
|
|
| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации. |
|
|
| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства. |
|
|
| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства. |
|
|
| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства. |
|
|
| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство. |
|
|
| public | [setCard()](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md#method_setCard) | | Устанавливает card. |
|
|
| public | [setConfirmation()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setConfirmation) | | Устанавливает confirmation. |
|
|
| public | [setHolder()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setHolder) | | Устанавливает holder. |
|
|
| public | [setId()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setId) | | Устанавливает id. |
|
|
| public | [setSaved()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setSaved) | | Устанавливает saved. |
|
|
| public | [setStatus()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setStatus) | | Устанавливает status. |
|
|
| public | [setTitle()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setTitle) | | Устанавливает title. |
|
|
| public | [setType()](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md#method_setType) | | Устанавливает type. |
|
|
| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize(). |
|
|
| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта. |
|
|
| protected | [validatePropertyValue()](../classes/YooKassa-Common-AbstractObject.md#method_validatePropertyValue) | | |
|
|
|
|
---
|
|
### Details
|
|
* File: [lib/Model/SavePaymentMethod/SavePaymentMethodBankCard.php](../../lib/Model/SavePaymentMethod/SavePaymentMethodBankCard.php)
|
|
* Package: YooKassa\Model
|
|
* Class Hierarchy:
|
|
* [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
* [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
* \YooKassa\Model\SavePaymentMethod\SavePaymentMethodBankCard
|
|
|
|
* See Also:
|
|
* [](https://yookassa.ru/developers/api)
|
|
|
|
---
|
|
### Tags
|
|
| Tag | Version | Description |
|
|
| --- | ------- | ----------- |
|
|
| category | | Class |
|
|
| author | | cms@yoomoney.ru |
|
|
|
|
---
|
|
## Properties
|
|
<a name="property_card"></a>
|
|
#### public $card : \YooKassa\Model\Payment\PaymentMethod\BankCard
|
|
---
|
|
***Description***
|
|
|
|
Данные банковской карты
|
|
|
|
**Type:** <a href="../classes/YooKassa-Model-Payment-PaymentMethod-BankCard.html"><abbr title="\YooKassa\Model\Payment\PaymentMethod\BankCard">BankCard</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property_confirmation"></a>
|
|
#### public $confirmation : \YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation
|
|
---
|
|
***Description***
|
|
|
|
Выбранный сценарий подтверждения привязки. Присутствует, когда привязка ожидает подтверждения от пользователя.
|
|
|
|
**Type:** <a href="../classes/YooKassa-Model-SavePaymentMethod-Confirmation-AbstractConfirmation.html"><abbr title="\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation">AbstractConfirmation</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_holder"></a>
|
|
#### public $holder : \YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder
|
|
---
|
|
***Description***
|
|
|
|
Данные магазина, для которого сохраняется способ оплаты.
|
|
|
|
**Type:** <a href="../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodHolder.html"><abbr title="\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder">SavePaymentMethodHolder</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_id"></a>
|
|
#### public $id : string
|
|
---
|
|
***Description***
|
|
|
|
Идентификатор сохраненного способа оплаты.
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_saved"></a>
|
|
#### public $saved : bool
|
|
---
|
|
***Description***
|
|
|
|
Признак сохранения способа оплаты для [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved). Возможные значения: * ~`true` — способ оплаты сохранен для автоплатежей и выплат; * ~`false` — способ оплаты не сохранен.
|
|
|
|
**Type:** <a href="../bool"><abbr title="bool">bool</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_status"></a>
|
|
#### public $status : string
|
|
---
|
|
***Description***
|
|
|
|
Статус проверки и сохранения способа оплаты.
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_title"></a>
|
|
#### public $title : string
|
|
---
|
|
***Description***
|
|
|
|
Название способа оплаты.
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property_type"></a>
|
|
#### public $type : string
|
|
---
|
|
***Description***
|
|
|
|
Код способа оплаты. Возможное значение: ~`bank_card` — банковская карта, ~`sbp` - СБП (Система быстрых платежей)
|
|
|
|
**Type:** <a href="../string"><abbr title="string">string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__card"></a>
|
|
#### protected $_card : ?\YooKassa\Model\Payment\PaymentMethod\BankCard
|
|
---
|
|
**Summary**
|
|
|
|
Данные банковской карты
|
|
|
|
**Type:** <a href="../?\YooKassa\Model\Payment\PaymentMethod\BankCard"><abbr title="?\YooKassa\Model\Payment\PaymentMethod\BankCard">BankCard</abbr></a>
|
|
|
|
**Details:**
|
|
|
|
|
|
<a name="property__confirmation"></a>
|
|
#### protected $_confirmation : ?\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation
|
|
---
|
|
**Type:** <a href="../?\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation"><abbr title="?\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation">AbstractConfirmation</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__holder"></a>
|
|
#### protected $_holder : ?\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder
|
|
---
|
|
**Summary**
|
|
|
|
Данные магазина, для которого сохраняется способ оплаты.
|
|
|
|
**Type:** <a href="../?\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder"><abbr title="?\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder">SavePaymentMethodHolder</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__id"></a>
|
|
#### protected $_id : ?string
|
|
---
|
|
**Summary**
|
|
|
|
Идентификатор сохраненного способа оплаты.
|
|
|
|
**Type:** <a href="../?string"><abbr title="?string">?string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__saved"></a>
|
|
#### protected $_saved : ?bool
|
|
---
|
|
**Summary**
|
|
|
|
Признак сохранения способа оплаты для [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved). Возможные значения: * ~`true` — способ оплаты сохранен для автоплатежей и выплат; * ~`false` — способ оплаты не сохранен.
|
|
|
|
***Description***
|
|
|
|
* true — способ оплаты сохранен для автоплатежей и выплат;
|
|
* false — способ оплаты не сохранен.
|
|
|
|
**Type:** <a href="../?bool"><abbr title="?bool">?bool</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__status"></a>
|
|
#### protected $_status : ?string
|
|
---
|
|
**Summary**
|
|
|
|
Статус проверки и сохранения способа оплаты.
|
|
|
|
**Type:** <a href="../?string"><abbr title="?string">?string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__title"></a>
|
|
#### protected $_title : ?string
|
|
---
|
|
**Summary**
|
|
|
|
Название способа оплаты.
|
|
|
|
**Type:** <a href="../?string"><abbr title="?string">?string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
<a name="property__type"></a>
|
|
#### protected $_type : ?string
|
|
---
|
|
**Summary**
|
|
|
|
Код способа оплаты. Возможное значение: ~`bank_card` — банковская карта, ~`sbp` - СБП (Система быстрых платежей)
|
|
|
|
**Type:** <a href="../?string"><abbr title="?string">?string</abbr></a>
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
|
|
|
|
---
|
|
## Methods
|
|
<a name="method___construct" class="anchor"></a>
|
|
#### public __construct() : mixed
|
|
|
|
```php
|
|
public __construct(?array $data = []) : mixed
|
|
```
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\SavePaymentMethodBankCard](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">?array</code> | data | |
|
|
|
|
**Returns:** mixed -
|
|
|
|
|
|
<a name="method___get" class="anchor"></a>
|
|
#### public __get() : mixed
|
|
|
|
```php
|
|
public __get(string $propertyName) : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|
|
|
**Returns:** mixed - Значение свойства
|
|
|
|
|
|
<a name="method___isset" class="anchor"></a>
|
|
#### public __isset() : bool
|
|
|
|
```php
|
|
public __isset(string $propertyName) : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя проверяемого свойства |
|
|
|
|
**Returns:** bool - True если свойство имеется, false если нет
|
|
|
|
|
|
<a name="method___set" class="anchor"></a>
|
|
#### public __set() : void
|
|
|
|
```php
|
|
public __set(string $propertyName, mixed $value) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя свойства |
|
|
| <code lang="php">mixed</code> | value | Значение свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method___unset" class="anchor"></a>
|
|
#### public __unset() : void
|
|
|
|
```php
|
|
public __unset(string $propertyName) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Удаляет свойство.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | Имя удаляемого свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_fromArray" class="anchor"></a>
|
|
#### public fromArray() : void
|
|
|
|
```php
|
|
public fromArray(array|\Traversable $sourceArray) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значения свойств текущего объекта из массива.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">array OR \Traversable</code> | sourceArray | Ассоциативный массив с настройками |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_getCard" class="anchor"></a>
|
|
#### public getCard() : \YooKassa\Model\Payment\PaymentMethod\BankCard|null
|
|
|
|
```php
|
|
public getCard() : \YooKassa\Model\Payment\PaymentMethod\BankCard|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает card.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\SavePaymentMethodBankCard](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md)
|
|
|
|
**Returns:** \YooKassa\Model\Payment\PaymentMethod\BankCard|null -
|
|
|
|
|
|
<a name="method_getConfirmation" class="anchor"></a>
|
|
#### public getConfirmation() : \YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation|null
|
|
|
|
```php
|
|
public getConfirmation() : \YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает confirmation.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** \YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation|null -
|
|
|
|
|
|
<a name="method_getHolder" class="anchor"></a>
|
|
#### public getHolder() : \YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder|null
|
|
|
|
```php
|
|
public getHolder() : \YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает holder.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** \YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder|null -
|
|
|
|
|
|
<a name="method_getId" class="anchor"></a>
|
|
#### public getId() : string|null
|
|
|
|
```php
|
|
public getId() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает id.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** string|null -
|
|
|
|
|
|
<a name="method_getSaved" class="anchor"></a>
|
|
#### public getSaved() : bool|null
|
|
|
|
```php
|
|
public getSaved() : bool|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает saved.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** bool|null -
|
|
|
|
|
|
<a name="method_getStatus" class="anchor"></a>
|
|
#### public getStatus() : string|null
|
|
|
|
```php
|
|
public getStatus() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает status.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** string|null -
|
|
|
|
|
|
<a name="method_getTitle" class="anchor"></a>
|
|
#### public getTitle() : string|null
|
|
|
|
```php
|
|
public getTitle() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает title.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** string|null -
|
|
|
|
|
|
<a name="method_getType" class="anchor"></a>
|
|
#### public getType() : string|null
|
|
|
|
```php
|
|
public getType() : string|null
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает type.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
**Returns:** string|null -
|
|
|
|
|
|
<a name="method_getValidator" class="anchor"></a>
|
|
#### public getValidator() : \YooKassa\Validator\Validator
|
|
|
|
```php
|
|
public getValidator() : \YooKassa\Validator\Validator
|
|
```
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** \YooKassa\Validator\Validator -
|
|
|
|
|
|
<a name="method_jsonSerialize" class="anchor"></a>
|
|
#### public jsonSerialize() : array
|
|
|
|
```php
|
|
public jsonSerialize() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
|
|
|
|
|
|
<a name="method_offsetExists" class="anchor"></a>
|
|
#### public offsetExists() : bool
|
|
|
|
```php
|
|
public offsetExists(string $offset) : bool
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Проверяет наличие свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя проверяемого свойства |
|
|
|
|
**Returns:** bool - True если свойство имеется, false если нет
|
|
|
|
|
|
<a name="method_offsetGet" class="anchor"></a>
|
|
#### public offsetGet() : mixed
|
|
|
|
```php
|
|
public offsetGet(string $offset) : mixed
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя свойства |
|
|
|
|
**Returns:** mixed - Значение свойства
|
|
|
|
|
|
<a name="method_offsetSet" class="anchor"></a>
|
|
#### public offsetSet() : void
|
|
|
|
```php
|
|
public offsetSet(string $offset, mixed $value) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает значение свойства.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя свойства |
|
|
| <code lang="php">mixed</code> | value | Значение свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_offsetUnset" class="anchor"></a>
|
|
#### public offsetUnset() : void
|
|
|
|
```php
|
|
public offsetUnset(string $offset) : void
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Удаляет свойство.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | offset | Имя удаляемого свойства |
|
|
|
|
**Returns:** void -
|
|
|
|
|
|
<a name="method_setCard" class="anchor"></a>
|
|
#### public setCard() : self
|
|
|
|
```php
|
|
public setCard(\YooKassa\Model\Payment\PaymentMethod\BankCard|array|null $card = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает card.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\SavePaymentMethodBankCard](../classes/YooKassa-Model-SavePaymentMethod-SavePaymentMethodBankCard.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Model\Payment\PaymentMethod\BankCard OR array OR null</code> | card | Данные банковской карты. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setConfirmation" class="anchor"></a>
|
|
#### public setConfirmation() : self
|
|
|
|
```php
|
|
public setConfirmation(\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation|array|null $confirmation = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает confirmation.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Model\SavePaymentMethod\Confirmation\AbstractConfirmation OR array OR null</code> | confirmation | Выбранный сценарий подтверждения привязки. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setHolder" class="anchor"></a>
|
|
#### public setHolder() : self
|
|
|
|
```php
|
|
public setHolder(\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder|array|null $holder = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает holder.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">\YooKassa\Model\SavePaymentMethod\SavePaymentMethodHolder OR array OR null</code> | holder | Данные магазина, для которого сохраняется способ оплаты. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setId" class="anchor"></a>
|
|
#### public setId() : self
|
|
|
|
```php
|
|
public setId(string|null $id = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает id.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | id | Идентификатор сохраненного способа оплаты. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setSaved" class="anchor"></a>
|
|
#### public setSaved() : self
|
|
|
|
```php
|
|
public setSaved(bool|null $saved = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает saved.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">bool OR null</code> | saved | Признак сохранения способа оплаты для [автоплатежей](https://yookassa.ru/developers/payment-acceptance/scenario-extensions/recurring-payments/pay-with-saved). Возможные значения: * ~`true` — способ оплаты сохранен для автоплатежей и выплат; * ~`false` — способ оплаты не сохранен. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setStatus" class="anchor"></a>
|
|
#### public setStatus() : self
|
|
|
|
```php
|
|
public setStatus(string|null $status = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает status.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | status | Статус проверки и сохранения способа оплаты. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setTitle" class="anchor"></a>
|
|
#### public setTitle() : self
|
|
|
|
```php
|
|
public setTitle(string|null $title = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает title.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | title | Название способа оплаты. |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_setType" class="anchor"></a>
|
|
#### public setType() : self
|
|
|
|
```php
|
|
public setType(string|null $type = null) : self
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Устанавливает type.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Model\SavePaymentMethod\AbstractSavePaymentMethod](../classes/YooKassa-Model-SavePaymentMethod-AbstractSavePaymentMethod.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string OR null</code> | type | Код способа оплаты. Возможное значение: ~`bank_card` — банковская карта, ~`sbp` - СБП (Система быстрых платежей) |
|
|
|
|
**Returns:** self -
|
|
|
|
|
|
<a name="method_toArray" class="anchor"></a>
|
|
#### public toArray() : array
|
|
|
|
```php
|
|
public toArray() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
|
|
Является алиасом метода AbstractObject::jsonSerialize().
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив со свойствами текущего объекта
|
|
|
|
|
|
<a name="method_getUnknownProperties" class="anchor"></a>
|
|
#### protected getUnknownProperties() : array
|
|
|
|
```php
|
|
protected getUnknownProperties() : array
|
|
```
|
|
|
|
**Summary**
|
|
|
|
Возвращает массив свойств которые не существуют, но были заданы у объекта.
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами
|
|
|
|
|
|
<a name="method_validatePropertyValue" class="anchor"></a>
|
|
#### protected validatePropertyValue() : mixed
|
|
|
|
```php
|
|
protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed
|
|
```
|
|
|
|
**Details:**
|
|
* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md)
|
|
|
|
##### Parameters:
|
|
| Type | Name | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <code lang="php">string</code> | propertyName | |
|
|
| <code lang="php">mixed</code> | propertyValue | |
|
|
|
|
**Returns:** mixed -
|
|
|
|
|
|
|
|
---
|
|
|
|
### Top Namespaces
|
|
|
|
* [\YooKassa](../namespaces/yookassa.md)
|
|
|
|
---
|
|
|
|
### Reports
|
|
* [Errors - 0](../reports/errors.md)
|
|
* [Markers - 0](../reports/markers.md)
|
|
* [Deprecated - 43](../reports/deprecated.md)
|
|
|
|
---
|
|
|
|
This document was automatically generated from source code comments on 2026-06-29 using [phpDocumentor](http://www.phpdoc.org/)
|
|
|
|
© 2026 YooMoney |