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.4.0
yookassa-sdk-php/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md
T
Антон Н. Николаев 16e2595c61 Устанавливаем cms_name = yookassa_sdk_php_3 если он не установлен в запросе. Обновлены тесты 
Исправлены неточности в типах и описаниях
2024-06-14 17:38:54 +03:00

79 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Payments\CreatePaymentRequest

Namespace: \YooKassa\Request\Payments

Summary:

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

Description:

Класс объекта запроса к API на проведение нового платежа.

Examples

Пример использования билдера

try {
    $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder();
    $builder->setAmount(100)
        ->setCurrency(\YooKassa\Model\CurrencyCode::RUB)
        ->setCapture(true)
        ->setDescription('Оплата заказа 112233')
        ->setMetadata([
            'cms_name' => 'yoo_api_test',
            'order_id' => '112233',
            'language' => 'ru',
            'transaction_id' => '123-456-789',
        ])
    ;

    // Устанавливаем страницу для редиректа после оплаты
    $builder->setConfirmation([
        'type' => \YooKassa\Model\Payment\ConfirmationType::REDIRECT,
        'returnUrl' => 'https://merchant-site.ru/payment-return-page',
    ]);

    // Можем установить конкретный способ оплаты
    $builder->setPaymentMethodData(\YooKassa\Model\Payment\PaymentMethodType::BANK_CARD);

    // Составляем чек
    $builder->setReceiptEmail('john.doe@merchant.com');
    $builder->setReceiptPhone('71111111111');
    // Добавим товар
    $builder->addReceiptItem(
        'Платок Gucci',
        3000,
        1.0,
        2,
        'full_payment',
        'commodity'
    );
    // Добавим доставку
    $builder->addReceiptShipping(
        'Delivery/Shipping/Доставка',
        100,
        1,
        \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT,
        \YooKassa\Model\Receipt\PaymentSubject::SERVICE
    );

    // Можно добавить распределение денег по магазинам
    $builder->setTransfers([
        [
            'account_id' => '1b68e7b15f3f',
            'amount' => [
                'value' => 1000,
                'currency' => \YooKassa\Model\CurrencyCode::RUB,
            ],
        ],
        [
            'account_id' => '0c37205b3208',
            'amount' => [
                'value' => 2000,
                'currency' => \YooKassa\Model\CurrencyCode::RUB,
            ],
        ],
    ]);

    // Создаем объект запроса
    $request = $builder->build();

    // Можно изменить данные, если нужно
    $request->setDescription($request->getDescription() . ' - merchant comment');

    $idempotenceKey = uniqid('', true);
    $response = $client->createPayment($request, $idempotenceKey);
} catch (\Exception $e) {
    $response = $e;
}

var_dump($response);

Constants

Visibility Name Flag Summary
public MAX_LENGTH_PAYMENT_TOKEN

Properties

Visibility Name Flag Summary
public $airline Объект с данными для продажи авиабилетов
public $amount Сумма создаваемого платежа
public $amount Сумма
public $capture Автоматически принять поступившую оплату
public $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
public $clientIp IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения
public $confirmation Способ подтверждения платежа
public $deal Данные о сделке, в составе которой проходит платеж
public $description Описание транзакции
public $fraud_data Информация для проверки операции на мошенничество
public $fraudData Информация для проверки операции на мошенничество
public $merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public $merchantCustomerId Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
public $metadata Метаданные привязанные к платежу
public $payment_method_data Данные используемые для создания метода оплаты
public $payment_method_id Идентификатор записи о сохраненных платежных данных покупателя
public $payment_token Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
public $paymentMethodData Данные используемые для создания метода оплаты
public $paymentMethodId Идентификатор записи о сохраненных платежных данных покупателя
public $paymentToken Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
public $receipt Данные фискального чека 54-ФЗ
public $receipt Данные фискального чека 54-ФЗ
public $recipient Получатель платежа, если задан
public $save_payment_method Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
public $savePaymentMethod Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method
public $transfers Данные о распределении платежа между магазинами
protected $_airline
protected $_amount
protected $_receipt
protected $_transfers

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов запросов создания платежа.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAirline() Возвращает данные авиабилетов.
public getAmount() Возвращает сумму оплаты.
public getCapture() Возвращает флаг автоматического принятия поступившей оплаты.
public getClientIp() Возвращает IPv4 или IPv6-адрес покупателя.
public getConfirmation() Возвращает способ подтверждения платежа.
public getDeal() Возвращает данные о сделке, в составе которой проходит платеж.
public getDescription() Возвращает описание транзакции
public getFraudData() Возвращает информацию для проверки операции на мошенничество.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getMerchantCustomerId() Возвращает идентификатор покупателя в вашей системе.
public getMetadata() Возвращает данные оплаты установленные мерчантом
public getPaymentMethodData() Возвращает данные для создания метода оплаты.
public getPaymentMethodId() Устанавливает идентификатор записи платёжных данных покупателя.
public getPaymentToken() Возвращает одноразовый токен для проведения оплаты.
public getReceipt() Возвращает чек, если он есть.
public getRecipient() Возвращает объект получателя платежа.
public getSavePaymentMethod() Возвращает флаг сохранения платёжных данных.
public getTransfers() Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
public getValidator()
public hasAirline() Проверяет, были ли установлены данные авиабилетов.
public hasAmount() Проверяет, была ли установлена сумма оплаты.
public hasCapture() Проверяет, был ли установлен флаг автоматического принятия поступившей оплаты.
public hasClientIp() Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя.
public hasConfirmation() Проверяет, был ли установлен способ подтверждения платежа.
public hasDeal() Проверяет, были ли установлены данные о сделке.
public hasDescription() Проверяет наличие описания транзакции в создаваемом платеже.
public hasFraudData() Проверяет, была ли установлена информация для проверки операции на мошенничество.
public hasMerchantCustomerId() Проверяет, был ли установлен идентификатор покупателя в вашей системе.
public hasMetadata() Проверяет, были ли установлены метаданные заказа.
public hasPaymentMethodData() Проверяет установлен ли объект с методом оплаты.
public hasPaymentMethodId() Проверяет наличие идентификатора записи о платёжных данных покупателя.
public hasPaymentToken() Проверяет наличие одноразового токена для проведения оплаты.
public hasReceipt() Проверяет наличие чека.
public hasRecipient() Проверяет наличие получателя платежа в запросе.
public hasSavePaymentMethod() Проверяет, был ли установлен флаг сохранения платёжных данных.
public hasTransfers() Проверяет наличие данных о распределении денег.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public removeReceipt() Удаляет чек из запроса.
public setAirline() Устанавливает данные авиабилетов.
public setAmount() Устанавливает сумму оплаты.
public setCapture() Устанавливает флаг автоматического принятия поступившей оплаты.
public setClientIp() Устанавливает IP адрес покупателя.
public setConfirmation() Устанавливает способ подтверждения платежа.
public setDeal() Устанавливает данные о сделке, в составе которой проходит платеж.
public setDescription() Устанавливает описание транзакции
public setFraudData() Устанавливает информацию для проверки операции на мошенничество.
public setMerchantCustomerId() Устанавливает идентификатор покупателя в вашей системе.
public setMetadata() Устанавливает метаданные, привязанные к платежу.
public setPaymentMethodData() Устанавливает объект с информацией для создания метода оплаты.
public setPaymentMethodId() Устанавливает идентификатор записи о сохранённых данных покупателя.
public setPaymentToken() Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget.
public setReceipt() Устанавливает чек.
public setRecipient() Устанавливает объект с информацией о получателе платежа.
public setSavePaymentMethod() Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
public setTransfers() Устанавливает transfers (массив распределения денег между магазинами).
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет на валидность текущий объект
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LENGTH_PAYMENT_TOKEN
MAX_LENGTH_PAYMENT_TOKEN = 10240

Properties

public $airline : \YooKassa\Request\Payments\AirlineInterface|null

Description

Объект с данными для продажи авиабилетов

Type: AirlineInterface|null

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма создаваемого платежа

Type: AmountInterface

Details:

public $amount : \YooKassa\Model\AmountInterface

Description

Сумма

Type: AmountInterface

Details:

public $capture : bool

Description

Автоматически принять поступившую оплату

Type: bool

Details:

public $client_ip : string

Description

IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения

Type: string

Details:

public $clientIp : string

Description

IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения

Type: string

Details:

public $confirmation : \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes

Description

Способ подтверждения платежа

Type: AbstractConfirmationAttributes

Details:

public $deal : \YooKassa\Model\Deal\PaymentDealInfo

Description

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

Type: PaymentDealInfo

Details:

public $description : string

Description

Описание транзакции

Type: string

Details:

public $fraud_data : \YooKassa\Request\Payments\FraudData

Description

Информация для проверки операции на мошенничество

Type: FraudData

Details:

public $fraudData : \YooKassa\Request\Payments\FraudData

Description

Информация для проверки операции на мошенничество

Type: FraudData

Details:

public $merchant_customer_id : string

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $merchantCustomerId : string

Description

Идентификатор покупателя в вашей системе, например электронная почта или номер телефона

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

Description

Метаданные привязанные к платежу

Type: Metadata

Details:

public $payment_method_data : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData

Description

Данные используемые для создания метода оплаты

Type: AbstractPaymentData

Details:

public $payment_method_id : string

Description

Идентификатор записи о сохраненных платежных данных покупателя

Type: string

Details:

public $payment_token : string

Description

Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget

Type: string

Details:

public $paymentMethodData : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData

Description

Данные используемые для создания метода оплаты

Type: AbstractPaymentData

Details:

public $paymentMethodId : string

Description

Идентификатор записи о сохраненных платежных данных покупателя

Type: string

Details:

public $paymentToken : string

Description

Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget

Type: string

Details:

public $receipt : \YooKassa\Model\Receipt\ReceiptInterface

Description

Данные фискального чека 54-ФЗ

Type: ReceiptInterface

Details:

public $receipt : \YooKassa\Model\Receipt\ReceiptInterface|null

Description

Данные фискального чека 54-ФЗ

Type: ReceiptInterface|null

Details:

public $recipient : \YooKassa\Model\Payment\RecipientInterface

Description

Получатель платежа, если задан

Type: RecipientInterface

Details:

public $save_payment_method : bool|null

Description

Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method

Type: bool|null

Details:

public $savePaymentMethod : bool|null

Description

Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method

Type: bool|null

Details:

public $transfers : \YooKassa\Common\ListObjectInterface|\YooKassa\Request\Payments\TransferDataInterface[]|null

Description

Данные о распределении платежа между магазинами

Type: TransferDataInterface[]|null

Details:

protected $_airline : ?\YooKassa\Request\Payments\AirlineInterface

Type: AirlineInterface Объект с данными для продажи авиабилетов Details:

protected $_amount : ?\YooKassa\Model\AmountInterface

Type: AmountInterface Сумма оплаты Details:

protected $_receipt : ?\YooKassa\Model\Receipt\ReceiptInterface

Type: ReceiptInterface Данные фискального чека 54-ФЗ Details:

protected $_transfers : ?\YooKassa\Common\ListObject

Type: ListObject

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 builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Static public builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder

Summary

Возвращает билдер объектов запросов создания платежа.

Details:

Returns: \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера объектов запросов

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getAirline() : null|\YooKassa\Request\Payments\AirlineInterface

public getAirline() : null|\YooKassa\Request\Payments\AirlineInterface

Summary

Возвращает данные авиабилетов.

Details:

Returns: null|\YooKassa\Request\Payments\AirlineInterface - Данные авиабилетов

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

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

Summary

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

Details:

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

public getCapture() : bool

public getCapture() : bool

Summary

Возвращает флаг автоматического принятия поступившей оплаты.

Details:

Returns: bool - True если требуется автоматически принять поступившую оплату, false если нет

public getClientIp() : string|null

public getClientIp() : string|null

Summary

Возвращает IPv4 или IPv6-адрес покупателя.

Details:

Returns: string|null - IPv4 или IPv6-адрес покупателя

public getConfirmation() : \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null

public getConfirmation() : \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null

Summary

Возвращает способ подтверждения платежа.

Details:

Returns: \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes|null - Способ подтверждения платежа

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

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

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

Returns: string|null -

public getFraudData() : null|\YooKassa\Request\Payments\FraudData

public getFraudData() : null|\YooKassa\Request\Payments\FraudData

Summary

Возвращает информацию для проверки операции на мошенничество.

Details:

Returns: null|\YooKassa\Request\Payments\FraudData - Информация для проверки операции на мошенничество

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

Details:

Returns: string|null - Последняя произошедшая ошибка валидации

public getMerchantCustomerId() : string|null

public getMerchantCustomerId() : string|null

Summary

Возвращает идентификатор покупателя в вашей системе.

Details:

Returns: string|null - Идентификатор покупателя в вашей системе

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

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

Summary

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

Details:

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

public getPaymentMethodData() : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null

public getPaymentMethodData() : \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null

Summary

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

Details:

Returns: \YooKassa\Request\Payments\PaymentData\AbstractPaymentData|null - Данные используемые для создания метода оплаты

public getPaymentMethodId() : string|null

public getPaymentMethodId() : string|null

Summary

Устанавливает идентификатор записи платёжных данных покупателя.

Details:

Returns: string|null - Идентификатор записи о сохраненных платежных данных покупателя

public getPaymentToken() : string|null

public getPaymentToken() : string|null

Summary

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

Details:

Returns: string|null - Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget

public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface

public getReceipt() : null|\YooKassa\Model\Receipt\ReceiptInterface

Summary

Возвращает чек, если он есть.

Details:

Returns: null|\YooKassa\Model\Receipt\ReceiptInterface - Данные фискального чека 54-ФЗ или null, если чека нет

public getRecipient() : null|\YooKassa\Model\Payment\RecipientInterface

public getRecipient() : null|\YooKassa\Model\Payment\RecipientInterface

Summary

Возвращает объект получателя платежа.

Details:

Returns: null|\YooKassa\Model\Payment\RecipientInterface - Объект с информацией о получателе платежа или null, если получатель не задан

public getSavePaymentMethod() : bool|null

public getSavePaymentMethod() : bool|null

Summary

Возвращает флаг сохранения платёжных данных.

Details:

Returns: bool|null - Флаг сохранения платёжных данных

public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface

public getTransfers() : \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.

Description

Присутствует, если вы используете решение ЮKassa для платформ. (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics).

Details:

Returns: \YooKassa\Request\Payments\TransferDataInterface[]|\YooKassa\Common\ListObjectInterface - Данные о распределении денег

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasAirline() : bool

public hasAirline() : bool

Summary

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

Details:

Returns: bool -

public hasAmount() : bool

public hasAmount() : bool

Summary

Проверяет, была ли установлена сумма оплаты.

Details:

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

public hasCapture() : bool

public hasCapture() : bool

Summary

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

Details:

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

public hasClientIp() : bool

public hasClientIp() : bool

Summary

Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя.

Details:

Returns: bool - True если IP адрес покупателя был установлен, false если нет

public hasConfirmation() : bool

public hasConfirmation() : bool

Summary

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

Details:

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

public hasDeal() : bool

public hasDeal() : bool

Summary

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

Details:

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

public hasDescription() : bool

public hasDescription() : bool

Summary

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

Details:

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

public hasFraudData() : bool

public hasFraudData() : bool

Summary

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

Details:

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

public hasMerchantCustomerId() : bool

public hasMerchantCustomerId() : bool

Summary

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

Details:

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

public hasMetadata() : bool

public hasMetadata() : bool

Summary

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

Details:

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

public hasPaymentMethodData() : bool

public hasPaymentMethodData() : bool

Summary

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

Details:

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

public hasPaymentMethodId() : bool

public hasPaymentMethodId() : bool

Summary

Проверяет наличие идентификатора записи о платёжных данных покупателя.

Details:

Returns: bool - True если идентификатор задан, false если нет

public hasPaymentToken() : bool

public hasPaymentToken() : bool

Summary

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

Details:

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

public hasReceipt() : bool

public hasReceipt() : bool

Summary

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

Details:

Returns: bool - True если чек есть, false если нет

public hasRecipient() : bool

public hasRecipient() : bool

Summary

Проверяет наличие получателя платежа в запросе.

Details:

Returns: bool - True если получатель платежа задан, false если нет

public hasSavePaymentMethod() : bool

public hasSavePaymentMethod() : bool

Summary

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

Details:

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

public hasTransfers() : bool

public hasTransfers() : bool

Summary

Проверяет наличие данных о распределении денег.

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

public removeReceipt() : self

Summary

Удаляет чек из запроса.

Details:

Returns: self -

public setAirline() : \YooKassa\Common\AbstractRequestInterface

public setAirline(\YooKassa\Request\Payments\AirlineInterface|array|null $airline) : \YooKassa\Common\AbstractRequestInterface

Summary

Устанавливает данные авиабилетов.

Details:

Parameters:
Type Name Description
\YooKassa\Request\Payments\AirlineInterface OR array OR null airline Данные авиабилетов

Returns: \YooKassa\Common\AbstractRequestInterface -

public setAmount() : self

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

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR string amount Сумма оплаты

Returns: self -

public setCapture() : self

public setCapture(bool $capture) : self

Summary

Устанавливает флаг автоматического принятия поступившей оплаты.

Details:

Parameters:
Type Name Description
bool capture Автоматически принять поступившую оплату
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если переданный аргумент не кастится в bool

Returns: self -

public setClientIp() : self

public setClientIp(string|null $client_ip) : self

Summary

Устанавливает IP адрес покупателя.

Details:

Parameters:
Type Name Description
string OR null client_ip IPv4 или IPv6-адрес покупателя

Returns: self -

public setConfirmation() : self

public setConfirmation(null|array|\YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes $confirmation) : self

Summary

Устанавливает способ подтверждения платежа.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Request\Payments\ConfirmationAttributes\AbstractConfirmationAttributes confirmation Способ подтверждения платежа
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null

Returns: self -

public setDeal() : self

public setDeal(null|array|\YooKassa\Model\Deal\PaymentDealInfo $deal) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Deal\PaymentDealInfo deal Данные о сделке, в составе которой проходит платеж
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: self -

public setDescription() : \YooKassa\Request\Payments\CreatePaymentRequest

public setDescription(string|null $description) : \YooKassa\Request\Payments\CreatePaymentRequest

Summary

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

Details:

Parameters:
Type Name Description
string OR null description

Returns: \YooKassa\Request\Payments\CreatePaymentRequest -

public setFraudData() : self

public setFraudData(null|array|\YooKassa\Request\Payments\FraudData $fraud_data = null) : self

Summary

Устанавливает информацию для проверки операции на мошенничество.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Request\Payments\FraudData fraud_data Информация для проверки операции на мошенничество

Returns: self -

public setMerchantCustomerId() : self

public setMerchantCustomerId(string|null $merchant_customer_id) : self

Summary

Устанавливает идентификатор покупателя в вашей системе.

Details:

Parameters:
Type Name Description
string OR null merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов

Returns: self -

public setMetadata() : self

public setMetadata(null|array|\YooKassa\Model\Metadata $metadata) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Metadata metadata Метаданные платежа, устанавливаемые мерчантом
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа

Returns: self -

public setPaymentMethodData() : self

public setPaymentMethodData(null|array|\YooKassa\Request\Payments\PaymentData\AbstractPaymentData $payment_method_data) : self

Summary

Устанавливает объект с информацией для создания метода оплаты.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Request\Payments\PaymentData\AbstractPaymentData payment_method_data Объект создания метода оплаты или null
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если был передан объект невалидного типа

Returns: self -

public setPaymentMethodId() : self

public setPaymentMethodId(string|null $payment_method_id) : self

Summary

Устанавливает идентификатор записи о сохранённых данных покупателя.

Details:

Parameters:
Type Name Description
string OR null payment_method_id Идентификатор записи о сохраненных платежных данных покупателя
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если переданные значение не является строкой или null

Returns: self -

public setPaymentToken() : self

public setPaymentToken(string|null $payment_token) : self

Summary

Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget.

Details:

Parameters:
Type Name Description
string OR null payment_token Одноразовый токен для проведения оплаты
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное значение превышает допустимую длину
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой

Returns: self -

public setReceipt() : self

public setReceipt(null|array|\YooKassa\Model\Receipt\ReceiptInterface $receipt) : self

Summary

Устанавливает чек.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Receipt\ReceiptInterface receipt Инстанс чека или null для удаления информации о чеке

Returns: self -

public setRecipient() : self

public setRecipient(null|array|\YooKassa\Model\Payment\RecipientInterface $recipient) : self

Summary

Устанавливает объект с информацией о получателе платежа.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\Payment\RecipientInterface recipient Инстанс объекта информации о получателе платежа или null

Returns: self -

public setSavePaymentMethod() : self

public setSavePaymentMethod(bool|null $save_payment_method = null) : self

Summary

Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.

Details:

Parameters:
Type Name Description
bool OR null save_payment_method Сохранить платежные данные для последующего использования
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Генерируется если переданный аргумент не кастится в bool

Returns: self -

public setTransfers() : self

public setTransfers(\YooKassa\Common\ListObjectInterface|array|null $transfers = null) : self

Summary

Устанавливает transfers (массив распределения денег между магазинами).

Details:

Parameters:
Type Name Description
\YooKassa\Common\ListObjectInterface OR array OR null transfers Массив распределения денег

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 - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

Parameters:
Type Name Description
string value Ошибка, произошедшая при валидации объекта

Returns: void -

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 2024-06-14 using phpDocumentor

© 2024 YooMoney

Reference in New Issue View Git Blame Copy Permalink