mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-10-09 09:05:25 +00:00
Добавлен необязательный параметр metadata в запрос RefundRequest и объект Refund. Добавлена поддержка ставки НДС 22% — она вступает в силу 1 января 2026 года и заменяет основную ставку в 20%.
This commit is contained in:
+24
-24
@@ -123,14 +123,14 @@ use YooKassa\Request\Webhook\WebhookListResponse;
|
||||
/**
|
||||
* Класс клиента API.
|
||||
*
|
||||
* @example 01-client.php 3 7 Создание клиента
|
||||
* @example 01-client.php 3 9 Создание клиента
|
||||
*/
|
||||
class Client extends BaseClient
|
||||
{
|
||||
/**
|
||||
* Текущая версия библиотеки.
|
||||
*/
|
||||
public const SDK_VERSION = '3.11.1';
|
||||
public const SDK_VERSION = '3.12.0';
|
||||
|
||||
/**
|
||||
* Получить список платежей магазина.
|
||||
@@ -206,7 +206,7 @@ class Client extends BaseClient
|
||||
* <li>metadata — дополнительные данные (передаются магазином).</li>
|
||||
* </ul>
|
||||
*
|
||||
* @example 01-client.php 21 28 Запрос на создание платежа
|
||||
* @example 01-client.php 21 27 Запрос на создание платежа
|
||||
*
|
||||
* @param array|CreatePaymentRequestInterface $paymentData Запрос на создание платежа
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -254,7 +254,7 @@ class Client extends BaseClient
|
||||
* Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору.
|
||||
* Выдает объект платежа {@link PaymentInterface} в актуальном статусе.
|
||||
*
|
||||
* @example 01-client.php 173 8 Получить информацию о платеже
|
||||
* @example 01-client.php 173 7 Получить информацию о платеже
|
||||
*
|
||||
* @param string $paymentId Идентификатор платежа
|
||||
*
|
||||
@@ -306,7 +306,7 @@ class Client extends BaseClient
|
||||
* у вас есть 7 дней на подтверждение платежа. Для остальных способов оплаты платеж необходимо подтвердить
|
||||
* в течение 6 часов.
|
||||
*
|
||||
* @example 01-client.php 51 35 Подтверждение платежа
|
||||
* @example 01-client.php 51 34 Подтверждение платежа
|
||||
*
|
||||
* @param array|CreateCaptureRequestInterface $captureData Запрос на создание подтверждения платежа
|
||||
* @param string $paymentId Идентификатор платежа
|
||||
@@ -362,7 +362,7 @@ class Client extends BaseClient
|
||||
* возвращать деньги на счет плательщика. Для платежей банковскими картами отмена происходит мгновенно.
|
||||
* Для остальных способов оплаты возврат может занимать до нескольких дней.
|
||||
*
|
||||
* @example 01-client.php 88 10 Отменить незавершенную оплату заказа
|
||||
* @example 01-client.php 88 9 Отменить незавершенную оплату заказа
|
||||
*
|
||||
* @param string $paymentId Идентификатор платежа
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -461,7 +461,7 @@ class Client extends BaseClient
|
||||
* этого платежа. Создание возврата возможно только для платежей в статусе `succeeded`. Комиссии за проведение
|
||||
* возврата нет. Комиссия, которую ЮKassa берёт за проведение исходного платежа, не возвращается.
|
||||
*
|
||||
* @example 01-client.php 145 26 Запрос на создание возврата
|
||||
* @example 01-client.php 145 25 Запрос на создание возврата
|
||||
*
|
||||
* @param array|CreateRefundRequestInterface $refundData Запрос на создание возврата
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -511,7 +511,7 @@ class Client extends BaseClient
|
||||
* Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору.
|
||||
* В ответ на запрос придет объект возврата {@link RefundResponse} в актуальном статусе.
|
||||
*
|
||||
* @example 01-client.php 183 8 Получить информацию о возврате
|
||||
* @example 01-client.php 183 7 Получить информацию о возврате
|
||||
*
|
||||
* @param string $refundId Идентификатор возврата
|
||||
*
|
||||
@@ -729,7 +729,7 @@ class Client extends BaseClient
|
||||
* Создает объект чека — `Receipt`. Возвращает успешно созданный чек по уникальному идентификатору
|
||||
* платежа или возврата.
|
||||
*
|
||||
* @example 01-client.php 100 43 Запрос на создание чека
|
||||
* @example 01-client.php 100 42 Запрос на создание чека
|
||||
*
|
||||
* @param array|CreatePostReceiptRequestInterface $receiptData Запрос на создание чека
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -777,7 +777,7 @@ class Client extends BaseClient
|
||||
* Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору.
|
||||
* Выдает объект чека {@link ReceiptResponseInterface} в актуальном статусе.
|
||||
*
|
||||
* @example 01-client.php 173 8 Получить информацию о чеке
|
||||
* @example 01-client.php 173 7 Получить информацию о чеке
|
||||
*
|
||||
* @param string $receiptId Идентификатор чека
|
||||
*
|
||||
@@ -834,7 +834,7 @@ class Client extends BaseClient
|
||||
* <li>description — Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @example 01-client.php 316 18 Запрос на создание сделки
|
||||
* @example 01-client.php 316 17 Запрос на создание сделки
|
||||
*
|
||||
* @param array|CreateDealRequestInterface $dealData Запрос на создание сделки
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -879,7 +879,7 @@ class Client extends BaseClient
|
||||
* Запрос позволяет получить информацию о текущем состоянии сделки по её уникальному идентификатору.
|
||||
* Выдает объект чека {@link DealInteface} в актуальном статусе.
|
||||
*
|
||||
* @example 01-client.php 336 8 Получить информацию о сделке
|
||||
* @example 01-client.php 336 7 Получить информацию о сделке
|
||||
*
|
||||
* @param string $dealId Идентификатор сделки
|
||||
*
|
||||
@@ -992,7 +992,7 @@ class Client extends BaseClient
|
||||
* <li>metadata — любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).</li>
|
||||
* </ul>
|
||||
*
|
||||
* @example 01-client.php 376 26 Запрос на создание выплаты
|
||||
* @example 01-client.php 376 25 Запрос на создание выплаты
|
||||
*
|
||||
* @param array|CreatePayoutRequestInterface $payoutData Запрос на создание выплаты
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -1051,7 +1051,7 @@ class Client extends BaseClient
|
||||
* @throws UnauthorizedException Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации
|
||||
* @throws ExtensionNotFoundException Требуемое PHP расширение не установлено
|
||||
*
|
||||
* @example 01-client.php 405 9 Получить информацию о выплате
|
||||
* @example 01-client.php 405 8 Получить информацию о выплате
|
||||
*/
|
||||
public function getPayoutInfo(string $payoutId): ?PayoutInterface
|
||||
{
|
||||
@@ -1084,7 +1084,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* Запрос позволяет получить информацию о магазине для переданного OAuth-токена.
|
||||
*
|
||||
* @example 01-client.php 12 7 Информация о магазине
|
||||
* @example 01-client.php 12 6 Информация о магазине
|
||||
*
|
||||
* @param null|array|int|string $filter Параметры поиска. В настоящее время доступен только `on_behalf_of`
|
||||
*
|
||||
@@ -1133,7 +1133,7 @@ class Client extends BaseClient
|
||||
* Идентификатор созданного объекта персональных данных необходимо использовать в запросе на проведение выплаты через СБП с проверкой получателя.
|
||||
* [Подробнее о выплатах с проверкой получателя](/developers/payouts/scenario-extensions/recipient-check)
|
||||
*
|
||||
* @example 01-client.php 416 17 Запрос на создание персональных данных
|
||||
* @example 01-client.php 416 16 Запрос на создание персональных данных
|
||||
*
|
||||
* @param array|AbstractPersonalDataRequest $personalData Запрос на создание персональных данных
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -1181,7 +1181,7 @@ class Client extends BaseClient
|
||||
* Запрос позволяет получить информацию о текущем состоянии персональных данных по их уникальному идентификатору.
|
||||
* Выдает объект платежа {@link PersonalDataInterface} в актуальном статусе.
|
||||
*
|
||||
* @example 01-client.php 435 9 Получить информацию о персональных данных
|
||||
* @example 01-client.php 435 8 Получить информацию о персональных данных
|
||||
*
|
||||
* @param string $personalDataId Идентификатор персональных данных
|
||||
*
|
||||
@@ -1228,7 +1228,7 @@ class Client extends BaseClient
|
||||
* Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать
|
||||
* в запросе на создание выплаты.
|
||||
*
|
||||
* @example 01-client.php 474 7 Получить список участников СБП
|
||||
* @example 01-client.php 474 6 Получить список участников СБП
|
||||
*
|
||||
* @throws ApiException Неожиданный код ошибки
|
||||
* @throws BadApiRequestException Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API
|
||||
@@ -1267,7 +1267,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* Идентификатор созданного объекта самозанятого необходимо использовать в запросе на проведение выплаты.
|
||||
*
|
||||
* @example 01-client.php 446 15 Запрос на создание самозанятого
|
||||
* @example 01-client.php 446 14 Запрос на создание самозанятого
|
||||
*
|
||||
* @param array|SelfEmployedRequestInterface $selfEmployed Запрос на создание самозанятого
|
||||
* @param null|string $idempotenceKey [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence)
|
||||
@@ -1311,7 +1311,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* С помощью этого запроса вы можете получить информацию о текущем статусе самозанятого по его уникальному идентификатору.
|
||||
*
|
||||
* @example 01-client.php 463 9 Получить информацию о самозанятом
|
||||
* @example 01-client.php 463 8 Получить информацию о самозанятом
|
||||
*
|
||||
* @param string $selfEmployedId Идентификатор самозанятого
|
||||
*
|
||||
@@ -1354,7 +1354,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* Используйте этот запрос, чтобы создать в ЮKassa [объект счета](https://yookassa.ru/developers/api?codeLang=bash#create_invoice).
|
||||
*
|
||||
* @example 01-client.php 484 69 Запрос на создание счёта
|
||||
* @example 01-client.php 483 68 Запрос на создание счёта
|
||||
*
|
||||
* @param array|CreateInvoiceRequestInterface $invoice
|
||||
* @param string|null $idempotenceKey
|
||||
@@ -1402,7 +1402,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* С помощью этого запроса вы можете получить информацию о текущем статусе счета по его уникальному идентификатору.
|
||||
*
|
||||
* @example 01-client.php 555 14 Получить информацию о счете
|
||||
* @example 01-client.php 554 13 Получить информацию о счете
|
||||
*
|
||||
* @param string $invoiceId Идентификатор счета
|
||||
*
|
||||
@@ -1452,7 +1452,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* Идентификатор созданного способа оплаты вы можете использовать при проведении [автоплатежей](/developers/payment-acceptance/scenario-extensions/recurring-payments/create-recurring) или [выплат](/developers/payouts/scenario-extensions/multipurpose-token).
|
||||
*
|
||||
* @example 01-client.php 568 34 Запрос на создание способа оплаты
|
||||
* @example 01-client.php 569 34 Запрос на создание способа оплаты
|
||||
*
|
||||
* @param array|CreatePaymentMethodRequestInterface $paymentMethod
|
||||
* @param string|null $idempotenceKey
|
||||
@@ -1503,7 +1503,7 @@ class Client extends BaseClient
|
||||
*
|
||||
* @param string $paymentMethodId Идентификатор способа оплаты
|
||||
*
|
||||
* @example 01-client.php 604 10 Получить информацию о способе оплаты
|
||||
* @example 01-client.php 605 10 Получить информацию о способе оплаты
|
||||
*
|
||||
* @return SavePaymentMethodInterface|null
|
||||
* @throws ApiConnectionException
|
||||
|
||||
Reference in New Issue
Block a user