mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 03:58:43 +00:00

Files

T

Антон Н. Николаев 31dc0221be Добавлено поле refund_method в возвратах. Добавлено поле sbp_operation_id в PaymentMethodSbp

Добавлено поле `merchant_customer_bank_account` в объекте `FraudData`
Добавлен статус самозанятого `unregistered`
Добавлен список провайдеров онлайн-касс `FiscalizationProvider`
Добавлен объект Me с подобъектом `Fiscalization`

2023-12-11 15:15:42 +03:00

30 KiB

Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Payment\Transfer

Namespace: \YooKassa\Model\Payment

Summary:

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

Description:

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

Constants

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

Properties

Visibility	Name	Summary
public	$account_id	Идентификатор магазина, в пользу которого вы принимаете оплату
public	$accountId	Идентификатор магазина, в пользу которого вы принимаете оплату
public	$amount	Сумма, которую необходимо перечислить магазину
public	$connected_account_id	Идентификатор продавца, подключенного к вашей платформе
public	$connectedAccountId	Идентификатор продавца, подключенного к вашей платформе
public	$description	Описание транзакции, которое продавец увидит в личном кабинете ЮKassa. (например: «Заказ маркетплейса №72»)
public	$metadata	Любые дополнительные данные, которые нужны вам для работы с платежами (например, ваш внутренний идентификатор заказа)
public	$platform_fee_amount	Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	$platformFeeAmount	Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу
public	$release_funds	Порядок перевода денег продавцам: ~`true` — перевести сразу, ~`false` — сначала захолдировать
public	$releaseFunds	Порядок перевода денег продавцам: ~`true` — перевести сразу, ~`false` — сначала захолдировать
public	$status	Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled`

Methods

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

Details

File: lib/Model/Payment/Transfer.php
Package: YooKassa\Model
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Payment\Transfer
Implements:
- \YooKassa\Model\Payment\TransferInterface
See Also:

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 $connected_account_id : string

Description

Идентификатор продавца, подключенного к вашей платформе

Type: string

Details:

public $connectedAccountId : string

Description

Идентификатор продавца, подключенного к вашей платформе

Type: string

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:

public $release_funds : bool

Description

Порядок перевода денег продавцам: ~true — перевести сразу, ~false — сначала захолдировать

Type: bool

Details:

public $releaseFunds : bool

Description

Порядок перевода денег продавцам: ~true — перевести сразу, ~false — сначала захолдировать

Type: bool

Details:

public $status : string

Description

Статус распределения денег между магазинами. Возможные значения: pending, waiting_for_capture, succeeded, canceled

Type: string

Details:

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
`array OR null`	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() : void

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

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public fromArray() : void

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

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public getAccountId() : string|null

public getAccountId() : string|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: string|null -

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

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: \YooKassa\Model\AmountInterface|null -

public getConnectedAccountId() : string|null

public getConnectedAccountId() : string|null

Summary

Возвращает идентификатор продавца.

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: string|null - Идентификатор продавца

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: string|null -

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

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: \YooKassa\Model\Metadata|null -

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

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: \YooKassa\Model\AmountInterface|null -

public getReleaseFunds() : bool|null

public getReleaseFunds() : bool|null

Summary

Возвращает порядок перевода денег продавцам.

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: bool|null - Порядок перевода денег продавцам

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Returns: string|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetSet() : void

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

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public setAccountId() : self

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

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:

Inherited From: \YooKassa\Model\Payment\Transfer

Parameters:

Type	Name	Description
`\YooKassa\Model\AmountInterface OR array OR null`	value

Returns: self -

public setConnectedAccountId() : self

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

Summary

Устанавливает идентификатор продавца.

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Parameters:

Type	Name	Description
`string OR null`	value	Идентификатор продавца, подключенного к вашей платформе.

Returns: self -

public setDescription() : self

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

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:

Inherited From: \YooKassa\Model\Payment\Transfer

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:

Inherited From: \YooKassa\Model\Payment\Transfer

Parameters:

Type	Name	Description
`\YooKassa\Model\AmountInterface OR array OR null`	value

Returns: self -

public setReleaseFunds() : self

public setReleaseFunds(bool|array|null $value = null) : self

Summary

Устанавливает порядок перевода денег продавцам.

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Parameters:

Type	Name	Description
`bool OR array OR null`	value	Порядок перевода денег продавцам: ~`true` — перевести сразу, ~`false` — сначала захолдировать.

Returns: self -

public setStatus() : self

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

Summary

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

Details:

Inherited From: \YooKassa\Model\Payment\Transfer

Parameters:

Type	Name	Description
`string OR null`	value

Returns: self -

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 - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
`string`	propertyName
`mixed`	propertyValue

Returns: mixed -

Top Namespaces

\YooKassa

Reports

This document was automatically generated from source code comments on 2023-12-11 using phpDocumentor

30 KiB Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Payment\Transfer

Namespace: \YooKassa\Model\Payment

Constants

Properties

Methods

Details

Tags

Constants

MAX_LENGTH_DESCRIPTION

Properties

public $account_id : string

public $accountId : string

public $amount : \YooKassa\Model\AmountInterface

public $connected_account_id : string

public $connectedAccountId : string

public $description : string

public $metadata : \YooKassa\Model\Metadata

public $platform_fee_amount : \YooKassa\Model\AmountInterface

public $platformFeeAmount : \YooKassa\Model\AmountInterface

public $release_funds : bool

public $releaseFunds : bool

public $status : string

Methods

public __construct() : mixed

Parameters:

public __get() : mixed

Parameters:

public __isset() : bool

Parameters:

public __set() : void

Parameters:

public __unset() : void

Parameters:

public fromArray() : void

Parameters:

public getAccountId() : string|null

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

public getConnectedAccountId() : string|null

public getDescription() : string|null

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

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

public getReleaseFunds() : bool|null

public getStatus() : string|null

public getValidator() : \YooKassa\Validator\Validator

public jsonSerialize() : array

public offsetExists() : bool

Parameters:

public offsetGet() : mixed

Parameters:

public offsetSet() : void

Parameters:

public offsetUnset() : void

Parameters:

public setAccountId() : self

Parameters:

public setAmount() : self

Parameters:

public setConnectedAccountId() : self

Parameters:

public setDescription() : self

Parameters:

public setMetadata() : self

Parameters:

public setPlatformFeeAmount() : self

Parameters:

public setReleaseFunds() : self

Parameters:

public setStatus() : self

Parameters:

public toArray() : array

protected getUnknownProperties() : array

protected validatePropertyValue() : mixed

Parameters:

Top Namespaces

Reports

30 KiB

Raw Blame History