geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-31 12:38:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.1.1
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-TransferData.md
T
Антон Н. Николаев 76aa472b14 PaymentRequest.save_payment_method может быть null
2023-10-17 12:28:43 +03:00

26 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\TransferData

Namespace: \YooKassa\Request\Payments

Summary:

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

Description:

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

Constants

Visibility Name Flag Summary
public MAX_LENGTH_DESCRIPTION Максимальная длина строки описания транзакции

Properties

Visibility Name Flag Summary
public $account_id Идентификатор магазина, в пользу которого вы принимаете оплату
public $accountId Идентификатор магазина, в пользу которого вы принимаете оплату
public $amount Сумма, которую необходимо перечислить магазину
public $description Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)
public $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)
public $platform_fee_amount Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public $platformFeeAmount Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAccountId() Возвращает account_id.
public getAmount() Возвращает amount.
public getDescription() Возвращает description.
public getMetadata() Возвращает metadata.
public getPlatformFeeAmount() Возвращает platform_fee_amount.
public getValidator()
public hasAccountId()
public hasAmount()
public hasDescription()
public hasMetadata()
public hasPlatformFeeAmount()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAccountId() Устанавливает account_id.
public setAmount() Устанавливает amount.
public setDescription() Устанавливает description.
public setMetadata() Устанавливает metadata.
public setPlatformFeeAmount() Устанавливает platform_fee_amount.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_DESCRIPTION

Максимальная длина строки описания транзакции

MAX_LENGTH_DESCRIPTION = 128

Properties

public $account_id : string

Description

Идентификатор магазина, в пользу которого вы принимаете оплату

Type: string

Details:

public $accountId : string

Description

Идентификатор магазина, в пользу которого вы принимаете оплату

Type: string

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма, которую необходимо перечислить магазину

Type: AmountInterface

Details:

public $description : string

Description

Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)

Type: Metadata

Details:

public $platform_fee_amount : \YooKassa\Model\AmountInterface

Description

Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Type: AmountInterface

Details:

public $platformFeeAmount : \YooKassa\Model\AmountInterface

Description

Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу

Type: AmountInterface

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

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

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 getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

Returns: string|null -

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

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

Details:

Returns: \YooKassa\Model\Metadata|null -

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

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

Summary

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

Details:

Returns: \YooKassa\Model\AmountInterface|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasAccountId() : bool

public hasAccountId() : bool

Details:

Returns: bool -

public hasAmount() : bool

public hasAmount() : bool

Details:

Returns: bool -

public hasDescription() : bool

public hasDescription() : bool

Details:

Returns: bool -

public hasMetadata() : bool

public hasMetadata() : bool

Details:

Returns: bool -

public hasPlatformFeeAmount() : bool

public hasPlatformFeeAmount() : bool

Details:

Returns: bool -

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|null $value = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null value

Returns: self -

public setAmount() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null value

Returns: self -

public setDescription() : self

public setDescription(string|null $value = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null value Описание транзакции (не более 128 символов), которое продавец увидит в личном кабинете ЮKassa. Например: «Заказ маркетплейса №72».

Returns: self -

public setMetadata() : self

public setMetadata(string|array|null $value = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR array OR null value Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Returns: self -

public setPlatformFeeAmount() : self

public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null value

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 2023-10-17 using phpDocumentor

© 2023 YooMoney

Reference in New Issue View Git Blame Copy Permalink