mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-19 07:40:19 +00:00
Антон Н. Николаев
344 lines
17 KiB
PHP
344 lines
17 KiB
PHP
<?php
|
||
|
||
/**
|
||
* The MIT License
|
||
*
|
||
* Copyright (c) 2022 "YooMoney", NBСO LLC
|
||
*
|
||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
* of this software and associated documentation files (the "Software"), to deal
|
||
* in the Software without restriction, including without limitation the rights
|
||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
* copies of the Software, and to permit persons to whom the Software is
|
||
* furnished to do so, subject to the following conditions:
|
||
*
|
||
* The above copyright notice and this permission notice shall be included in
|
||
* all copies or substantial portions of the Software.
|
||
*
|
||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
* THE SOFTWARE.
|
||
*/
|
||
|
||
namespace YooKassa\Request\Payments;
|
||
|
||
use YooKassa\Model\Airline;
|
||
use YooKassa\Model\AirlineInterface;
|
||
use YooKassa\Model\AmountInterface;
|
||
use YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes;
|
||
use YooKassa\Model\Deal\PaymentDealInfo;
|
||
use YooKassa\Model\Metadata;
|
||
use YooKassa\Model\PaymentData\AbstractPaymentData;
|
||
use YooKassa\Model\ReceiptInterface;
|
||
use YooKassa\Model\RecipientInterface;
|
||
use YooKassa\Model\TransferInterface;
|
||
|
||
/**
|
||
* Interface CreatePaymentRequestInterface
|
||
*
|
||
* @package YooKassa
|
||
*
|
||
* @property-read RecipientInterface|null $recipient Получатель платежа, если задан
|
||
* @property-read AmountInterface $amount Сумма создаваемого платежа
|
||
* @property-read ReceiptInterface $receipt Данные фискального чека 54-ФЗ
|
||
* @property-read string $paymentToken Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
|
||
* @property-read string $payment_token Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
|
||
* @property-read string $paymentMethodId Идентификатор записи о сохраненных платежных данных покупателя
|
||
* @property-read string $payment_method_id Идентификатор записи о сохраненных платежных данных покупателя
|
||
* @property-read AbstractPaymentData $paymentMethodData Данные используемые для создания метода оплаты
|
||
* @property-read AbstractPaymentData $payment_method_data Данные используемые для создания метода оплаты
|
||
* @property-read AbstractConfirmationAttributes $confirmation Способ подтверждения платежа
|
||
* @property-read bool $savePaymentMethod Сохранить платежные данные для последующего использования
|
||
* @property-read bool $save_payment_method Сохранить платежные данные для последующего использования
|
||
* @property-read bool $capture Автоматически принять поступившую оплату
|
||
* @property-read string $clientIp IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения.
|
||
* @property-read string $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения.
|
||
* @property-read Metadata $metadata Метаданные привязанные к платежу
|
||
* @property-read TransferInterface[] $transfers Метаданные привязанные к платежу
|
||
* @property-read PaymentDealInfo $deal Данные о сделке, в составе которой проходит платеж
|
||
* @property-read string $merchantCustomerId Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
|
||
* @property-read string $merchant_customer_id Идентификатор покупателя в вашей системе, например электронная почта или номер телефона
|
||
*/
|
||
interface CreatePaymentRequestInterface
|
||
{
|
||
/**
|
||
* Возвращает объект получателя платежа
|
||
* @return RecipientInterface|null Объект с информацией о получателе платежа или null, если получатель не задан
|
||
*/
|
||
function getRecipient();
|
||
|
||
/**
|
||
* Проверяет наличие получателя платежа в запросе
|
||
* @return bool True если получатель платежа задан, false если нет
|
||
*/
|
||
function hasRecipient();
|
||
|
||
/**
|
||
* Устанавливает объект с информацией о получателе платежа
|
||
* @param RecipientInterface|null $value Инстанс объекта информации о получателе платежа или null
|
||
*/
|
||
function setRecipient($value);
|
||
|
||
/**
|
||
* Возвращает сумму заказа
|
||
* @return AmountInterface Сумма заказа
|
||
*/
|
||
function getAmount();
|
||
|
||
/**
|
||
* Возвращает описание транзакции
|
||
* @return string Описание транзакции
|
||
*/
|
||
function getDescription();
|
||
|
||
/**
|
||
* Проверяет наличие описания транзакции в создаваемом платеже
|
||
* @return bool True если описание транзакции установлено, false если нет
|
||
*/
|
||
function hasDescription();
|
||
|
||
/**
|
||
* Устанавливает описание транзакции
|
||
* @param string $value Описание транзакции
|
||
*/
|
||
function setDescription($value);
|
||
|
||
/**
|
||
* Возвращает чек, если он есть
|
||
* @return ReceiptInterface|null Данные фискального чека 54-ФЗ или null, если чека нет
|
||
*/
|
||
function getReceipt();
|
||
|
||
/**
|
||
* Проверяет наличие чека в создаваемом платеже
|
||
* @return bool True если чек есть, false если нет
|
||
*/
|
||
function hasReceipt();
|
||
|
||
/**
|
||
* Возвращает одноразовый токен для проведения оплаты
|
||
* @return string Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
|
||
*/
|
||
function getPaymentToken();
|
||
|
||
/**
|
||
* Проверяет наличие одноразового токена для проведения оплаты
|
||
* @return bool True если токен установлен, false если нет
|
||
*/
|
||
function hasPaymentToken();
|
||
|
||
/**
|
||
* Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget
|
||
* @param string $value Одноразовый токен для проведения оплаты
|
||
*/
|
||
function setPaymentToken($value);
|
||
|
||
/**
|
||
* Устанавливает идентификатор записи платёжных данных покупателя
|
||
* @return string Идентификатор записи о сохраненных платежных данных покупателя
|
||
*/
|
||
function getPaymentMethodId();
|
||
|
||
/**
|
||
* Проверяет наличие идентификатора записи о платёжных данных покупателя
|
||
* @return bool True если идентификатор задан, false если нет
|
||
*/
|
||
function hasPaymentMethodId();
|
||
|
||
/**
|
||
* Устанавливает идентификатор записи о сохранённых данных покупателя
|
||
* @param string $value Идентификатор записи о сохраненных платежных данных покупателя
|
||
*/
|
||
function setPaymentMethodId($value);
|
||
|
||
/**
|
||
* Возвращает данные для создания метода оплаты
|
||
* @return AbstractPaymentData Данные используемые для создания метода оплаты
|
||
*/
|
||
function getPaymentMethodData();
|
||
|
||
/**
|
||
* Проверяет установлен ли объект с методом оплаты
|
||
* @return bool True если объект метода оплаты установлен, false если нет
|
||
*/
|
||
function hasPaymentMethodData();
|
||
|
||
/**
|
||
* Устанавливает объект с информацией для создания метода оплаты
|
||
* @param AbstractPaymentData|null $value Объект создания метода оплаты или null
|
||
*/
|
||
function setPaymentMethodData($value);
|
||
|
||
/**
|
||
* Возвращает способ подтверждения платежа
|
||
* @return AbstractConfirmationAttributes Способ подтверждения платежа
|
||
*/
|
||
function getConfirmation();
|
||
|
||
/**
|
||
* Проверяет, был ли установлен способ подтверждения платежа
|
||
* @return bool True если способ подтверждения платежа был установлен, false если нет
|
||
*/
|
||
function hasConfirmation();
|
||
|
||
/**
|
||
* Устанавливает способ подтверждения платежа
|
||
* @param AbstractConfirmationAttributes|null $value Способ подтверждения платежа
|
||
*/
|
||
function setConfirmation($value);
|
||
|
||
/**
|
||
* Возвращает флаг сохранения платёжных данных
|
||
* @return bool Флаг сохранения платёжных данных
|
||
*/
|
||
function getSavePaymentMethod();
|
||
|
||
/**
|
||
* Проверяет, был ли установлен флаг сохранения платёжных данных
|
||
* @return bool True если флыг был установлен, false если нет
|
||
*/
|
||
function hasSavePaymentMethod();
|
||
|
||
/**
|
||
* Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method.
|
||
* @param bool $value Сохранить платежные данные для последующего использования
|
||
*/
|
||
function setSavePaymentMethod($value);
|
||
|
||
/**
|
||
* Возвращает флаг автоматического принятия поступившей оплаты
|
||
* @return bool True если требуется автоматически принять поступившую оплату, false если нет
|
||
*/
|
||
function getCapture();
|
||
|
||
/**
|
||
* Проверяет, был ли установлен флаг автоматического приняти поступившей оплаты
|
||
* @return bool True если флаг автоматического принятия оплаты был установлен, false если нет
|
||
*/
|
||
function hasCapture();
|
||
|
||
/**
|
||
* Устанавливает флаг автоматического принятия поступившей оплаты
|
||
* @param bool $value Автоматически принять поступившую оплату
|
||
*/
|
||
function setCapture($value);
|
||
|
||
/**
|
||
* Возвращает IPv4 или IPv6-адрес покупателя
|
||
* @return string IPv4 или IPv6-адрес покупателя
|
||
*/
|
||
function getClientIp();
|
||
|
||
/**
|
||
* Проверяет, был ли установлен IPv4 или IPv6-адрес покупателя
|
||
* @return bool True если IP адрес покупателя был установлен, false если нет
|
||
*/
|
||
function hasClientIp();
|
||
|
||
/**
|
||
* Устанавливает IP адрес покупателя
|
||
* @param string $value IPv4 или IPv6-адрес покупателя
|
||
*/
|
||
function setClientIp($value);
|
||
|
||
/**
|
||
* Возвращает данные оплаты установленные мерчантом
|
||
* @return Metadata Метаданные привязанные к платежу
|
||
*/
|
||
function getMetadata();
|
||
|
||
/**
|
||
* Проверяет, были ли установлены метаданные заказа
|
||
* @return bool True если метаданные были установлены, false если нет
|
||
*/
|
||
function hasMetadata();
|
||
|
||
/**
|
||
* Устанавливает метаданные, привязанные к платежу
|
||
* @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом
|
||
*/
|
||
function setMetadata($value);
|
||
|
||
/**
|
||
* Возвращает данные длинной записи
|
||
* @return Airline
|
||
*/
|
||
function getAirline();
|
||
|
||
/**
|
||
* Проверяет, были ли установлены данные длинной записи
|
||
* @return bool
|
||
*/
|
||
function hasAirline();
|
||
|
||
/**
|
||
* Устанавливает данные авиабилетов
|
||
* @param AirlineInterface $value Данные авиабилетов
|
||
*/
|
||
function setAirline($value);
|
||
|
||
/**
|
||
* Проверяет наличие данных о распределении денег
|
||
* @return bool
|
||
*/
|
||
function hasTransfers();
|
||
|
||
/**
|
||
* Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести.
|
||
* Присутствует, если вы используете решение ЮKassa для платформ.
|
||
* (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics)
|
||
*
|
||
* @return TransferInterface[] Данные о распределении денег
|
||
*/
|
||
function getTransfers();
|
||
|
||
/**
|
||
* Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести.
|
||
* Присутствует, если вы используете решение ЮKassa для платформ.
|
||
* (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics)
|
||
*
|
||
* @param TransferInterface[]|array|null Данные о распределении денег
|
||
*/
|
||
function setTransfers($value);
|
||
|
||
/**
|
||
* Возвращает данные о сделке, в составе которой проходит платеж
|
||
* @return PaymentDealInfo Данные о сделке, в составе которой проходит платеж.
|
||
*/
|
||
function getDeal();
|
||
|
||
/**
|
||
* Проверяет, были ли установлены данные о сделке
|
||
* @return bool True если данные о сделке были установлены, false если нет
|
||
*/
|
||
function hasDeal();
|
||
|
||
/**
|
||
* Устанавливает данные о сделке, в составе которой проходит платеж.
|
||
* @param PaymentDealInfo|array|null $value Данные о сделке, в составе которой проходит платеж
|
||
*/
|
||
function setDeal($value);
|
||
|
||
/**
|
||
* Возвращает идентификатор покупателя в вашей системе
|
||
* @return string Идентификатор покупателя в вашей системе
|
||
*/
|
||
function getMerchantCustomerId();
|
||
|
||
/**
|
||
* Проверяет, был ли установлен идентификатор покупателя в вашей системе
|
||
* @return bool True если идентификатор покупателя был установлен, false если нет
|
||
*/
|
||
function hasMerchantCustomerId();
|
||
|
||
/**
|
||
* Устанавливает идентификатор покупателя в вашей системе
|
||
* @param string $value Идентификатор покупателя в вашей системе, например электронная почта или номер телефона. Не более 200 символов
|
||
*/
|
||
function setMerchantCustomerId($value);
|
||
}
|