meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Recipient.md

YooKassa API SDK

Class: \YooKassa\Model\Recipient

Namespace: \YooKassa\Model

---

Summary:

Класс получателя платежа.

Description:

Получатель платежа нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес другого аккаунта.

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$account_id		Идентификатор магазина
public	$accountId		Идентификатор магазина
public	$gateway_id		Идентификатор шлюза
public	$gatewayId		Идентификатор шлюза

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAccountId()		Возвращает идентификатор магазина
public	getGatewayId()		Возвращает идентификатор шлюза.
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setAccountId()		Устанавливает идентификатор магазина
public	setGatewayId()		Устанавливает идентификатор шлюза
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Recipient.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Recipient
• Implements:
  • \YooKassa\Model\RecipientInterface

---

Properties

public $account_id : string

---

Description

Идентификатор магазина

Type: string

Details:

public $accountId : string

---

Description

Идентификатор магазина

Type: string

Details:

public $gateway_id : string

---

Description

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

Type: string

Details:

public $gatewayId : string

---

Description

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

Type: string

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __set() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAccountId() : string

public getAccountId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Recipient

Returns: string - Идентификатор магазина

public getGatewayId() : string

public getGatewayId() : string

Summary

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

Description

Идентификатор шлюза используется для разделения потоков платежей в рамках одного аккаунта.

Details:

• Inherited From: \YooKassa\Model\Recipient

Returns: string - Идентификатор шлюза

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAccountId() : mixed

public setAccountId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Recipient

Parameters:

Type	Name	Description
string	value	Идентификатор магазина

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если было передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не строковое значение

Returns: mixed -

public setGatewayId() : mixed

public setGatewayId(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Recipient

Parameters:

Type	Name	Description
string	value	Идентификатор шлюза

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если было передано пустое значение
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если было передано не строковое значение

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney