geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-09-19 14:26:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-PaymentOrderData-PaymentOrderUtilities.md
T

53 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\PaymentOrderData\PaymentOrderUtilities

Namespace: \YooKassa\Request\Payments\PaymentOrderData

Summary:

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

Description:

Платежное поручение — распоряжение на перевод банку для оплаты жилищно-коммунальных услуг (ЖКУ), сведения о платеже для регистрации в ГИС ЖКХ.

Необходимо передавать при оплате ЖКУ.

Кроме параметров, отмеченных как обязательные, должен быть передан как минимум один параметр из этого списка: payment_document_id, payment_document_number, account_number, unified_account_number или service_id.

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $account_number Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id.
public $accountNumber Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id.
public $amount Сумма платежного поручения — сумма, которую пользователь переводит получателю платежа. Равна общей сумме платежа.
public $kbk Код бюджетной классификации (КБК).
public $oktmo Код ОКТМО (Общероссийский классификатор территорий муниципальных образований).
public $payment_document_id Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id.
public $payment_document_number Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id.
public $payment_period Период оплаты, за который выставлены начисления и за который вносится оплата.
public $payment_purpose Назначение платежа (не больше 210 символов).
public $paymentDocumentId Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id.
public $paymentDocumentNumber Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id.
public $paymentPeriod Период оплаты, за который выставлены начисления и за который вносится оплата.
public $paymentPurpose Назначение платежа (не больше 210 символов).
public $recipient Получатель платежа — государственная или коммерческая организация, которая предоставляет услуги или является информационным посредником, который собирает и обрабатывает начисления от других поставщиков услуг.
public $service_id Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number.
public $serviceId Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number.
public $type Код вида платежного поручения
public $type Код вида платежного поручения.
public $unified_account_number Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id.
public $unifiedAccountNumber Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id.
protected $_type Код вида платежного поручения

Methods

Visibility Name Flag Summary
public __construct()
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAccountNumber() Возвращает номер лицевого счета на стороне поставщика ЖКУ.
public getAmount() Возвращает amount.
public getKbk() Возвращает kbk.
public getOktmo() Возвращает oktmo.
public getPaymentDocumentId() Возвращает payment_document_id.
public getPaymentDocumentNumber() Возвращает payment_document_number.
public getPaymentPeriod() Возвращает payment_period.
public getPaymentPurpose() Возвращает payment_purpose.
public getRecipient() Возвращает recipient.
public getServiceId() Возвращает идентификатор жилищно-коммунальной услуги (ЖКУ).
public getType() Возвращает type.
public getUnifiedAccountNumber() Возвращает единый лицевой счет.
public getValidator()
public hasAccountNumber() Проверяет, были ли установлен номер лицевого счета на стороне поставщика ЖКУ.
public hasPaymentDocumentId() Проверяет, были ли установлен идентификатор платежного документа.
public hasPaymentDocumentNumber() Проверяет, были ли установлен номер платежного документа на стороне поставщика ЖКУ.
public hasServiceId() Проверяет, были ли установлен идентификатор жилищно-коммунальной услуги (ЖКУ).
public hasUnifiedAccountNumber() Проверяет, были ли установлен единый лицевой счет.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAccountNumber() Устанавливает номер лицевого счета на стороне поставщика ЖКУ.
public setAmount() Устанавливает amount.
public setKbk() Устанавливает kbk.
public setOktmo() Устанавливает oktmo.
public setPaymentDocumentId() Устанавливает идентификатор платежного документа.
public setPaymentDocumentNumber() Устанавливает номер платежного документа на стороне поставщика ЖКУ.
public setPaymentPeriod() Устанавливает payment_period.
public setPaymentPurpose() Устанавливает payment_purpose.
public setRecipient() Устанавливает recipient.
public setServiceId() Устанавливает идентификатор жилищно-коммунальной услуги (ЖКУ).
public setType() Устанавливает type.
public setUnifiedAccountNumber() Устанавливает единый лицевой счет.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет, что все необходимые поля заданы.
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $account_number : string

Description

Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id.

Type: string

Details:

public $accountNumber : string

Description

Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id.

Type: string

Details:

public $amount : \YooKassa\Model\MonetaryAmount

Description

Сумма платежного поручения — сумма, которую пользователь переводит получателю платежа. Равна общей сумме платежа.

Type: MonetaryAmount

Details:

public $kbk : string

Description

Код бюджетной классификации (КБК).

Type: string

Details:

public $oktmo : string

Description

Код ОКТМО (Общероссийский классификатор территорий муниципальных образований).

Type: string

Details:

public $payment_document_id : string

Description

Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id.

Type: string

Details:

public $payment_document_number : string

Description

Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id.

Type: string

Details:

public $payment_period : \YooKassa\Request\Payments\PaymentPeriod

Description

Период оплаты, за который выставлены начисления и за который вносится оплата.

Type: PaymentPeriod

Details:

public $payment_purpose : string

Description

Назначение платежа (не больше 210 символов).

Type: string

Details:

public $paymentDocumentId : string

Description

Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id.

Type: string

Details:

public $paymentDocumentNumber : string

Description

Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id.

Type: string

Details:

public $paymentPeriod : \YooKassa\Request\Payments\PaymentPeriod

Description

Период оплаты, за который выставлены начисления и за который вносится оплата.

Type: PaymentPeriod

Details:

public $paymentPurpose : string

Description

Назначение платежа (не больше 210 символов).

Type: string

Details:

public $recipient : \YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities

Description

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

Type: PaymentOrderRecipientUtilities

Details:

public $service_id : string

Description

Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number.

Type: string

Details:

public $serviceId : string

Description

Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number.

Type: string

Details:

public $type : string

Description

Код вида платежного поручения

Type: string

Details:

public $type : string

Description

Код вида платежного поручения.

Type: string

Details:

public $unified_account_number : string

Description

Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id.

Type: string

Details:

public $unifiedAccountNumber : string

Description

Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id.

Type: string

Details:

protected $_type : ?string

Summary

Код вида платежного поручения

Type: ?string

Details:

Methods

public __construct() : mixed

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

Details:

Parameters:
Type Name Description
?array 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 getAccountNumber() : string|null

public getAccountNumber() : string|null

Summary

Возвращает номер лицевого счета на стороне поставщика ЖКУ.

Details:

Returns: string|null -

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

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

Summary

Возвращает amount.

Details:

Returns: \YooKassa\Model\AmountInterface|null -

public getKbk() : string|null

public getKbk() : string|null

Summary

Возвращает kbk.

Details:

Returns: string|null -

public getOktmo() : string|null

public getOktmo() : string|null

Summary

Возвращает oktmo.

Details:

Returns: string|null -

public getPaymentDocumentId() : string|null

public getPaymentDocumentId() : string|null

Summary

Возвращает payment_document_id.

Details:

Returns: string|null -

public getPaymentDocumentNumber() : string|null

public getPaymentDocumentNumber() : string|null

Summary

Возвращает payment_document_number.

Details:

Returns: string|null -

public getPaymentPeriod() : \YooKassa\Request\Payments\PaymentPeriod|null

public getPaymentPeriod() : \YooKassa\Request\Payments\PaymentPeriod|null

Summary

Возвращает payment_period.

Details:

Returns: \YooKassa\Request\Payments\PaymentPeriod|null -

public getPaymentPurpose() : string|null

public getPaymentPurpose() : string|null

Summary

Возвращает payment_purpose.

Details:

Returns: string|null -

public getRecipient() : \YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities|null

public getRecipient() : \YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities|null

Summary

Возвращает recipient.

Details:

Returns: \YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities|null -

public getServiceId() : string|null

public getServiceId() : string|null

Summary

Возвращает идентификатор жилищно-коммунальной услуги (ЖКУ).

Details:

Returns: string|null -

public getType() : string|null

public getType() : string|null

Summary

Возвращает type.

Details:

Returns: string|null -

public getUnifiedAccountNumber() : string|null

public getUnifiedAccountNumber() : string|null

Summary

Возвращает единый лицевой счет.

Details:

Returns: string|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasAccountNumber() : bool

public hasAccountNumber() : bool

Summary

Проверяет, были ли установлен номер лицевого счета на стороне поставщика ЖКУ.

Details:

Returns: bool - True если номер лицевого счета на стороне поставщика ЖКУ был установлен, false если нет

public hasPaymentDocumentId() : bool

public hasPaymentDocumentId() : bool

Summary

Проверяет, были ли установлен идентификатор платежного документа.

Details:

Returns: bool - True если идентификатор платежного документа был установлен, false если нет

public hasPaymentDocumentNumber() : bool

public hasPaymentDocumentNumber() : bool

Summary

Проверяет, были ли установлен номер платежного документа на стороне поставщика ЖКУ.

Details:

Returns: bool - True если номер платежного документа на стороне поставщика ЖКУ был установлен, false если нет

public hasServiceId() : bool

public hasServiceId() : bool

Summary

Проверяет, были ли установлен идентификатор жилищно-коммунальной услуги (ЖКУ).

Details:

Returns: bool - True если идентификатор жилищно-коммунальной услуги (ЖКУ) был установлен, false если нет

public hasUnifiedAccountNumber() : bool

public hasUnifiedAccountNumber() : bool

Summary

Проверяет, были ли установлен единый лицевой счет.

Details:

Returns: bool - True если единый лицевой счет был установлен, false если нет

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 setAccountNumber() : self

public setAccountNumber(string|null $account_number = null) : self

Summary

Устанавливает номер лицевого счета на стороне поставщика ЖКУ.

Details:

Parameters:
Type Name Description
string OR null account_number Номер лицевого счета на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, payment_document_number, unified_account_number или service_id.

Returns: self -

public setAmount() : self

public setAmount(\YooKassa\Model\AmountInterface|array|null $amount = null) : self

Summary

Устанавливает amount.

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null amount Сумма платежного поручения — сумма, которую пользователь переводит получателю платежа. Равна общей сумме платежа.

Returns: self -

public setKbk() : self

public setKbk(string|null $kbk = null) : self

Summary

Устанавливает kbk.

Details:

Parameters:
Type Name Description
string OR null kbk Код бюджетной классификации (КБК).

Returns: self -

public setOktmo() : self

public setOktmo(string|null $oktmo = null) : self

Summary

Устанавливает oktmo.

Details:

Parameters:
Type Name Description
string OR null oktmo Код ОКТМО (Общероссийский классификатор территорий муниципальных образований).

Returns: self -

public setPaymentDocumentId() : self

public setPaymentDocumentId(string|null $payment_document_id = null) : self

Summary

Устанавливает идентификатор платежного документа.

Details:

Parameters:
Type Name Description
string OR null payment_document_id Идентификатор платежного документа. Обязательный параметр, если не передан payment_document_number, account_number, unified_account_number или service_id.

Returns: self -

public setPaymentDocumentNumber() : self

public setPaymentDocumentNumber(string|null $payment_document_number = null) : self

Summary

Устанавливает номер платежного документа на стороне поставщика ЖКУ.

Details:

Parameters:
Type Name Description
string OR null payment_document_number Номер платежного документа на стороне поставщика ЖКУ. Обязательный параметр, если не передан payment_document_id, account_number, unified_account_number или service_id.

Returns: self -

public setPaymentPeriod() : self

public setPaymentPeriod(\YooKassa\Request\Payments\PaymentPeriod|array|null $payment_period = null) : self

Summary

Устанавливает payment_period.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\PaymentPeriod OR array OR null payment_period Период оплаты, за который выставлены начисления и за который вносится оплата.

Returns: self -

public setPaymentPurpose() : self

public setPaymentPurpose(string|null $payment_purpose = null) : self

Summary

Устанавливает payment_purpose.

Details:

Parameters:
Type Name Description
string OR null payment_purpose Назначение платежа (не больше 210 символов).

Returns: self -

public setRecipient() : self

public setRecipient(\YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities|array|null $recipient = null) : self

Summary

Устанавливает recipient.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\PaymentOrderData\PaymentOrderRecipientUtilities OR array OR null recipient Получатель платежа — государственная или коммерческая организация, которая предоставляет услуги или является информационным посредником, который собирает и обрабатывает начисления от других поставщиков услуг.

Returns: self -

public setServiceId() : self

public setServiceId(string|null $service_id = null) : self

Summary

Устанавливает идентификатор жилищно-коммунальной услуги (ЖКУ).

Details:

Parameters:
Type Name Description
string OR null service_id Идентификатор жилищно-коммунальной услуги (ЖКУ). Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или unified_account_number.

Returns: self -

public setType() : self

public setType(string|null $type = null) : self

Summary

Устанавливает type.

Details:

Parameters:
Type Name Description
string OR null type Код вида платежного поручения

Returns: self -

public setUnifiedAccountNumber() : self

public setUnifiedAccountNumber(string|null $unified_account_number = null) : self

Summary

Устанавливает единый лицевой счет.

Details:

Parameters:
Type Name Description
string OR null unified_account_number Единый лицевой счет. Уникальный идентификатор в ГИС ЖКХ, который характеризует связку «собственник-помещение». Обязательный параметр, если не передан payment_document_id, payment_document_number, account_number или service_id.

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

Проверяет, что все необходимые поля заданы.

Details:

Returns: bool -

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-08-13 using phpDocumentor

© 2026 YooMoney

Reference in New Issue View Git Blame Copy Permalink