geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-18 15:40:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ebafcb1e20e1401057fb52317d806f1aa99e986
yookassa-sdk-php/docs/classes/YooKassa-Request-Payouts-CreatePayoutRequestInterface.md
T
Антон Н. Николаев 4ebafcb1e2 Откат поддержки psr/log версий 2 и 3
2022-01-21 16:02:22 +03:00

16 KiB
Raw Blame History

YooKassa API SDK

Interface: CreatePayoutRequestInterface

Namespace: \YooKassa\Request\Payouts

Summary:

Interface CreatePayoutRequestInterface

Constants

  • No constants found

Methods

Visibility Name Flag Summary
public getAmount() Возвращает сумму выплаты
public getDeal() Возвращает сделку, в рамках которой нужно провести выплату
public getDescription() Возвращает описание транзакции
public getMetadata() Возвращает данные оплаты установленные мерчантом
public getPayoutDestinationData() Возвращает данные платежного средства, на которое нужно сделать выплату
public getPayoutToken() Возвращает токенизированные данные для выплаты
public hasAmount() Проверяет наличие суммы в создаваемой выплате
public hasDeal() Проверяет установлена ли сделка, в рамках которой нужно провести выплату
public hasDescription() Проверяет наличие описания транзакции в создаваемой выплате
public hasMetadata() Проверяет, были ли установлены метаданные заказа
public hasPayoutDestinationData() Проверяет наличие данных платежного средства, на которое нужно сделать выплату
public hasPayoutToken() Проверяет наличие токенизированных данных для выплаты
public setAmount() Устанавливает сумму выплаты
public setDeal() Устанавливает сделку, в рамках которой нужно провести выплату
public setDescription() Устанавливает описание транзакции
public setMetadata() Устанавливает метаданные, привязанные к выплате
public setPayoutDestinationData() Устанавливает данные платежного средства, на которое нужно сделать выплату
public setPayoutToken() Устанавливает токенизированные данные для выплаты

Details

Tags

Tag Version Description
property Сумма создаваемой выплаты
property Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
property Данные платежного средства, на которое нужно сделать выплату. Обязательный параметр, если не передан payout_token.
property Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data
property Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data
property Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку
property Описание транзакции (не более 128 символов). Например: «Выплата по договору N»
property Метаданные привязанные к выплате

Methods

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

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

Summary

Возвращает сумму выплаты

Details:

Returns: \YooKassa\Model\AmountInterface|\YooKassa\Model\MonetaryAmount - Сумма выплаты

public hasAmount() : bool

public hasAmount() : bool

Summary

Проверяет наличие суммы в создаваемой выплате

Details:

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

public setAmount() : mixed

public setAmount(mixed $value) : mixed

Summary

Устанавливает сумму выплаты

Details:

Parameters:
Type Name Description
mixed value

Returns: mixed -

public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination|null

public getPayoutDestinationData() : \YooKassa\Model\Payout\AbstractPayoutDestination|null

Summary

Возвращает данные платежного средства, на которое нужно сделать выплату

Details:

Returns: \YooKassa\Model\Payout\AbstractPayoutDestination|null - Данные платежного средства, на которое нужно сделать выплату

public hasPayoutDestinationData() : bool

public hasPayoutDestinationData() : bool

Summary

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

Details:

Returns: bool - True если данные есть, false если нет

public setPayoutDestinationData() : mixed

public setPayoutDestinationData(\YooKassa\Model\Payout\AbstractPayoutDestination|array|null $value) : mixed

Summary

Устанавливает данные платежного средства, на которое нужно сделать выплату

Details:

Parameters:
Type Name Description
\YooKassa\Model\Payout\AbstractPayoutDestination OR array OR null value Данные платежного средства, на которое нужно сделать выплату

Returns: mixed -

public getPayoutToken() : string

public getPayoutToken() : string

Summary

Возвращает токенизированные данные для выплаты

Details:

Returns: string - Токенизированные данные для выплаты

public hasPayoutToken() : bool

public hasPayoutToken() : bool

Summary

Проверяет наличие токенизированных данных для выплаты

Details:

Returns: bool - True если токен установлен, false если нет

public setPayoutToken() : mixed

public setPayoutToken(string $value) : mixed

Summary

Устанавливает токенизированные данные для выплаты

Details:

Parameters:
Type Name Description
string value Токенизированные данные для выплаты

Returns: mixed -

public getDescription() : string

public getDescription() : string

Summary

Возвращает описание транзакции

Details:

Returns: string - Описание транзакции

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

Returns: bool - True если описание транзакции установлено, false если нет

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

Устанавливает описание транзакции

Details:

Parameters:
Type Name Description
string value Описание транзакции

Returns: mixed -

public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null

public getDeal() : \YooKassa\Model\Deal\PayoutDealInfo|null

Summary

Возвращает сделку, в рамках которой нужно провести выплату

Details:

Returns: \YooKassa\Model\Deal\PayoutDealInfo|null - Сделка, в рамках которой нужно провести выплату

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

Returns: bool - True если сделка установлена, false если нет

public setDeal() : mixed

public setDeal(\YooKassa\Model\Deal\PayoutDealInfo|array|null $value) : mixed

Summary

Устанавливает сделку, в рамках которой нужно провести выплату

Details:

Parameters:
Type Name Description
\YooKassa\Model\Deal\PayoutDealInfo OR array OR null value Сделка, в рамках которой нужно провести выплату

Returns: mixed -

public getMetadata() : \YooKassa\Model\Metadata

public getMetadata() : \YooKassa\Model\Metadata

Summary

Возвращает данные оплаты установленные мерчантом

Details:

Returns: \YooKassa\Model\Metadata - Метаданные привязанные к выплате

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные заказа

Details:

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

public setMetadata() : mixed

public setMetadata(\YooKassa\Model\Metadata|array|null $value) : mixed

Summary

Устанавливает метаданные, привязанные к выплате

Details:

Parameters:
Type Name Description
\YooKassa\Model\Metadata OR array OR null value Метаданные платежа, устанавливаемые мерчантом

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2022-01-21 using phpDocumentor

© 2022 YooMoney

Reference in New Issue View Git Blame Copy Permalink