# [YooKassa API SDK](../home.md)
# Class: \YooKassa\Client
### Namespace: [\YooKassa](../namespaces/yookassa.md)
---
**Summary:**
Класс клиента API.
---
### Examples
Создание клиента
```php
require_once '../vendor/autoload.php';
$client = new \YooKassa\Client();
// по логин/паролю
$client->setAuth('xxxxxx', 'test_XXXXXXX');
// или по oauth токену
$client->setAuthToken('token_XXXXXXX');
```
---
### Constants
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [ME_PATH](../classes/YooKassa-Client-BaseClient.md#constant_ME_PATH) | | Точка входа для запроса к API по магазину |
| public | [PAYMENTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYMENTS_PATH) | | Точка входа для запросов к API по платежам |
| public | [REFUNDS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_REFUNDS_PATH) | | Точка входа для запросов к API по возвратам |
| public | [WEBHOOKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_WEBHOOKS_PATH) | | Точка входа для запросов к API по вебхукам |
| public | [RECEIPTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_RECEIPTS_PATH) | | Точка входа для запросов к API по чекам |
| public | [DEALS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_DEALS_PATH) | | Точка входа для запросов к API по сделкам |
| public | [PAYOUTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYOUTS_PATH) | | Точка входа для запросов к API по выплатам |
| public | [PERSONAL_DATA_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PERSONAL_DATA_PATH) | | Точка входа для запросов к API по персональным данным |
| public | [SBP_BANKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SBP_BANKS_PATH) | | Точка входа для запросов к API по участникам СБП |
| public | [SELF_EMPLOYED_PATH](../classes/YooKassa-Client-BaseClient.md#constant_SELF_EMPLOYED_PATH) | | Точка входа для запросов к API по самозанятым |
| public | [IDEMPOTENCY_KEY_HEADER](../classes/YooKassa-Client-BaseClient.md#constant_IDEMPOTENCY_KEY_HEADER) | | Имя HTTP заголовка, используемого для передачи idempotence key |
| public | [DEFAULT_DELAY](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_DELAY) | | Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202. |
| public | [DEFAULT_TRIES_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_TRIES_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 |
| public | [DEFAULT_ATTEMPTS_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_ATTEMPTS_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 |
| public | [SDK_VERSION](../classes/YooKassa-Client.md#constant_SDK_VERSION) | | Текущая версия библиотеки. |
---
### Properties
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| protected | [$apiClient](../classes/YooKassa-Client-BaseClient.md#property_apiClient) | | CURL клиент |
| protected | [$attempts](../classes/YooKassa-Client-BaseClient.md#property_attempts) | | Количество повторных запросов при ответе API статусом 202. |
| protected | [$config](../classes/YooKassa-Client-BaseClient.md#property_config) | | Настройки для CURL клиента. |
| protected | [$logger](../classes/YooKassa-Client-BaseClient.md#property_logger) | | Объект для логирования работы SDK. |
| protected | [$login](../classes/YooKassa-Client-BaseClient.md#property_login) | | shopId магазина. |
| protected | [$password](../classes/YooKassa-Client-BaseClient.md#property_password) | | Секретный ключ магазина. |
| protected | [$timeout](../classes/YooKassa-Client-BaseClient.md#property_timeout) | | Время через которое будут осуществляться повторные запросы. |
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [__construct()](../classes/YooKassa-Client-BaseClient.md#method___construct) | | Constructor. |
| public | [addWebhook()](../classes/YooKassa-Client.md#method_addWebhook) | | Создание Webhook. |
| public | [cancelPayment()](../classes/YooKassa-Client.md#method_cancelPayment) | | Отменить незавершенную оплату заказа. |
| public | [capturePayment()](../classes/YooKassa-Client.md#method_capturePayment) | | Подтверждение платежа. |
| public | [createDeal()](../classes/YooKassa-Client.md#method_createDeal) | | Создание сделки. |
| public | [createPayment()](../classes/YooKassa-Client.md#method_createPayment) | | Создание платежа. |
| public | [createPayout()](../classes/YooKassa-Client.md#method_createPayout) | | Создание выплаты. |
| public | [createPersonalData()](../classes/YooKassa-Client.md#method_createPersonalData) | | Создание персональных данных. |
| public | [createReceipt()](../classes/YooKassa-Client.md#method_createReceipt) | | Отправка чека в облачную кассу. |
| public | [createRefund()](../classes/YooKassa-Client.md#method_createRefund) | | Проведение возврата платежа. |
| public | [createSelfEmployed()](../classes/YooKassa-Client.md#method_createSelfEmployed) | | Создание самозанятого. |
| public | [getApiClient()](../classes/YooKassa-Client-BaseClient.md#method_getApiClient) | | Возвращает CURL клиента для работы с API. |
| public | [getConfig()](../classes/YooKassa-Client-BaseClient.md#method_getConfig) | | Возвращает настройки клиента. |
| public | [getDealInfo()](../classes/YooKassa-Client.md#method_getDealInfo) | | Получить информацию о сделке. |
| public | [getDeals()](../classes/YooKassa-Client.md#method_getDeals) | | Получить список сделок магазина. |
| public | [getPaymentInfo()](../classes/YooKassa-Client.md#method_getPaymentInfo) | | Получить информацию о платеже. |
| public | [getPayments()](../classes/YooKassa-Client.md#method_getPayments) | | Получить список платежей магазина. |
| public | [getPayoutInfo()](../classes/YooKassa-Client.md#method_getPayoutInfo) | | Получить информацию о выплате. |
| public | [getPersonalDataInfo()](../classes/YooKassa-Client.md#method_getPersonalDataInfo) | | Получить информацию о персональных данных. |
| public | [getReceiptInfo()](../classes/YooKassa-Client.md#method_getReceiptInfo) | | Получить информацию о чеке. |
| public | [getReceipts()](../classes/YooKassa-Client.md#method_getReceipts) | | Получить список чеков магазина. |
| public | [getRefundInfo()](../classes/YooKassa-Client.md#method_getRefundInfo) | | Получить информацию о возврате. |
| public | [getRefunds()](../classes/YooKassa-Client.md#method_getRefunds) | | Получить список возвратов платежей. |
| public | [getSbpBanks()](../classes/YooKassa-Client.md#method_getSbpBanks) | | Получить список участников СБП |
| public | [getSelfEmployedInfo()](../classes/YooKassa-Client.md#method_getSelfEmployedInfo) | | Получить информацию о самозанятом |
| public | [getWebhooks()](../classes/YooKassa-Client.md#method_getWebhooks) | | Список созданных Webhook. |
| public | [isNotificationIPTrusted()](../classes/YooKassa-Client-BaseClient.md#method_isNotificationIPTrusted) | | Метод проверяет, находится ли IP адрес среди IP адресов Юkassa, с которых отправляются уведомления. |
| public | [me()](../classes/YooKassa-Client.md#method_me) | | Информация о магазине. |
| public | [removeWebhook()](../classes/YooKassa-Client.md#method_removeWebhook) | | Удаление Webhook. |
| public | [setApiClient()](../classes/YooKassa-Client-BaseClient.md#method_setApiClient) | | Устанавливает CURL клиента для работы с API. |
| public | [setAuth()](../classes/YooKassa-Client-BaseClient.md#method_setAuth) | | Устанавливает авторизацию по логин/паролю. |
| public | [setAuthToken()](../classes/YooKassa-Client-BaseClient.md#method_setAuthToken) | | Устанавливает авторизацию по Oauth-токену. |
| public | [setConfig()](../classes/YooKassa-Client-BaseClient.md#method_setConfig) | | Устанавливает настройки клиента. |
| public | [setLogger()](../classes/YooKassa-Client-BaseClient.md#method_setLogger) | | Устанавливает логгер приложения. |
| public | [setMaxRequestAttempts()](../classes/YooKassa-Client-BaseClient.md#method_setMaxRequestAttempts) | | Установка значения количества попыток повторных запросов при статусе 202. |
| public | [setRetryTimeout()](../classes/YooKassa-Client-BaseClient.md#method_setRetryTimeout) | | Установка значения задержки между повторными запросами. |
| protected | [decodeData()](../classes/YooKassa-Client-BaseClient.md#method_decodeData) | | Декодирует JSON строку в массив данных. |
| protected | [delay()](../classes/YooKassa-Client-BaseClient.md#method_delay) | | Задержка между повторными запросами. |
| protected | [encodeData()](../classes/YooKassa-Client-BaseClient.md#method_encodeData) | | Кодирует массив данных в JSON строку. |
| protected | [execute()](../classes/YooKassa-Client-BaseClient.md#method_execute) | | Выполнение запроса и обработка 202 статуса. |
| protected | [handleError()](../classes/YooKassa-Client-BaseClient.md#method_handleError) | | Выбрасывает исключение по коду ошибки. |
---
### Details
* File: [lib/Client.php](../../lib/Client.php)
* Package: Default
* Class Hierarchy:
* [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
* \YooKassa\Client
---
## Constants
###### ME_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запроса к API по магазину
```php
ME_PATH = '/me'
```
###### PAYMENTS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по платежам
```php
PAYMENTS_PATH = '/payments'
```
###### REFUNDS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по возвратам
```php
REFUNDS_PATH = '/refunds'
```
###### WEBHOOKS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по вебхукам
```php
WEBHOOKS_PATH = '/webhooks'
```
###### RECEIPTS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по чекам
```php
RECEIPTS_PATH = '/receipts'
```
###### DEALS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по сделкам
```php
DEALS_PATH = '/deals'
```
###### PAYOUTS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по выплатам
```php
PAYOUTS_PATH = '/payouts'
```
###### PERSONAL_DATA_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по персональным данным
```php
PERSONAL_DATA_PATH = '/personal_data'
```
###### SBP_BANKS_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по участникам СБП
```php
SBP_BANKS_PATH = '/sbp_banks'
```
###### SELF_EMPLOYED_PATH
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Точка входа для запросов к API по самозанятым
```php
SELF_EMPLOYED_PATH = '/self_employed'
```
###### IDEMPOTENCY_KEY_HEADER
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Имя HTTP заголовка, используемого для передачи idempotence key
```php
IDEMPOTENCY_KEY_HEADER = 'Idempotence-Key'
```
###### DEFAULT_DELAY
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202.
```php
DEFAULT_DELAY = 1800
```
###### DEFAULT_TRIES_COUNT
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202
```php
DEFAULT_TRIES_COUNT = 3
```
###### DEFAULT_ATTEMPTS_COUNT
Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202
```php
DEFAULT_ATTEMPTS_COUNT = 3
```
###### SDK_VERSION
Текущая версия библиотеки.
```php
SDK_VERSION = '3.1.0'
```
---
## Properties
#### protected $apiClient : ?\YooKassa\Client\ApiClientInterface
---
**Summary**
CURL клиент
**Type:** ApiClientInterface
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $attempts : int
---
**Summary**
Количество повторных запросов при ответе API статусом 202.
***Description***
Значение по умолчанию 3
**Type:** int
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $config : array
---
**Summary**
Настройки для CURL клиента.
**Type:** array
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $logger : ?\Psr\Log\LoggerInterface
---
**Summary**
Объект для логирования работы SDK.
**Type:** LoggerInterface
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $login : ?int
---
**Summary**
shopId магазина.
**Type:** ?int
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $password : ?string
---
**Summary**
Секретный ключ магазина.
**Type:** ?string
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
#### protected $timeout : int
---
**Summary**
Время через которое будут осуществляться повторные запросы.
***Description***
Значение по умолчанию - 1800 миллисекунд.
**Type:** int
Значение в миллисекундах
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
---
## Methods
#### public __construct() : mixed
```php
public __construct(\YooKassa\Client\ApiClientInterface $apiClient = null, \YooKassa\Helpers\Config\ConfigurationLoaderInterface $configLoader = null) : mixed
```
**Summary**
Constructor.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Client\ApiClientInterface | apiClient | |
| \YooKassa\Helpers\Config\ConfigurationLoaderInterface | configLoader | |
**Returns:** mixed -
#### public addWebhook() : ?\YooKassa\Model\Webhook\Webhook
```php
public addWebhook(array|\YooKassa\Model\Webhook\Webhook $request, null|string $idempotencyKey = null) : ?\YooKassa\Model\Webhook\Webhook
```
**Summary**
Создание Webhook.
**Description**
Запрос позволяет подписаться на уведомления о событии (например, на переход платежа в статус successed).
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Model\Webhook\Webhook | request | Запрос на создание вебхука |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Model\Webhook\Webhook -
##### Examples:
Создание Webhook:
```php
// Работа с Webhook
// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений.
// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем.
$client->setAuthToken('token_XXXXXXX');
try {
$webHookUrl = 'https://merchant-site.ru/payment-notification';
$needWebHookList = [
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_SUCCEEDED,
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_CANCELED,
];
$currentWebHookList = $client->getWebhooks()->getItems();
foreach ($needWebHookList as $event) {
$hookIsSet = false;
foreach ($currentWebHookList as $webHook) {
if ($webHook->getEvent() !== $event) {
continue;
}
if ($webHook->getUrl() !== $webHookUrl) {
$client->removeWebhook($webHook->getId());
} else {
$hookIsSet = true;
}
break;
}
if (!$hookIsSet) {
$client->addWebhook(['event' => $event, 'url' => $webHookUrl]);
}
}
$response = 'SUCCESS';
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public cancelPayment() : ?\YooKassa\Request\Payments\CancelResponse
```php
public cancelPayment(string $paymentId, null|string $idempotencyKey = null) : ?\YooKassa\Request\Payments\CancelResponse
```
**Summary**
Отменить незавершенную оплату заказа.
**Description**
Отменяет платеж, находящийся в статусе `waiting_for_capture`. Отмена платежа значит, что вы
не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем
возвращать деньги на счет плательщика. Для платежей банковскими картами отмена происходит мгновенно.
Для остальных способов оплаты возврат может занимать до нескольких дней.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | paymentId | Идентификатор платежа |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Payments\CancelResponse -
##### Examples:
Отменить незавершенную оплату заказа:
```php
$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df';
try {
$response = $client->cancelPayment($paymentId, uniqid('', true));
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public capturePayment() : ?\YooKassa\Request\Payments\CreateCaptureResponse
```php
public capturePayment(array|\YooKassa\Request\Payments\CreateCaptureRequestInterface $captureRequest, string $paymentId, null|string $idempotencyKey = null) : ?\YooKassa\Request\Payments\CreateCaptureResponse
```
**Summary**
Подтверждение платежа.
**Description**
Подтверждает вашу готовность принять платеж. Платеж можно подтвердить, только если он находится
в статусе `waiting_for_capture`. Если платеж подтвержден успешно — значит, оплата прошла, и вы можете выдать
товар или оказать услугу пользователю. На следующий день после подтверждения платеж попадет в реестр,
и ЮKassa переведет деньги на ваш расчетный счет. Если вы не подтверждаете платеж до момента, указанного
в `expire_at`, по умолчанию он отменяется, а деньги возвращаются пользователю. При оплате банковской картой
у вас есть 7 дней на подтверждение платежа. Для остальных способов оплаты платеж необходимо подтвердить
в течение 6 часов.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Payments\CreateCaptureRequestInterface | captureRequest | Запрос на создание подтверждения платежа |
| string | paymentId | Идентификатор платежа |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Payments\CreateCaptureResponse -
##### Examples:
Подтверждение платежа:
```php
$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df';
try {
$response = $client->capturePayment(
[
'amount' => [
'value' => '1500.00',
'currency' => 'RUB',
],
'transfers' => [
[
'account_id' => '123',
'amount' => [
'value' => '1000.00',
'currency' => 'RUB',
],
],
[
'account_id' => '456',
'amount' => [
'value' => '500.00',
'currency' => 'RUB',
],
],
],
],
$paymentId,
uniqid('', true)
);
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public createDeal() : ?\YooKassa\Request\Deals\CreateDealResponse
```php
public createDeal(array|\YooKassa\Request\Deals\CreateDealRequestInterface $deal, null|string $idempotenceKey = null) : ?\YooKassa\Request\Deals\CreateDealResponse
```
**Summary**
Создание сделки.
**Description**
Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу.
Необходимо указать следующие параметры:
- type — Тип сделки. Фиксированное значение: safe_deal — Безопасная сделка;
- fee_moment — Момент перечисления вам вознаграждения платформы. Возможные значения: payment_succeeded — после успешной оплаты;
- deal_closed — при закрытии сделки после успешной выплаты.
Дополнительные параметры:
- metadata — Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа);
- description — Описание сделки (не более 128 символов). Используется для фильтрации при получении списка сделок.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Deals\CreateDealRequestInterface | deal | Запрос на создание сделки |
| null OR string | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Request\Deals\CreateDealResponse -
##### Examples:
Запрос на создание сделки:
```php
try {
$response = $client->createDeal(
[
'type' => \YooKassa\Model\Deal\DealType::SAFE_DEAL,
'fee_moment' => \YooKassa\Model\Deal\FeeMoment::PAYMENT_SUCCEEDED,
'metadata' => [
'order_id' => '37',
],
'description' => 'SAFE_DEAL 123554642-2432FF344R',
],
uniqid('', true)
);
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public createPayment() : \YooKassa\Request\Payments\CreatePaymentResponse|null
```php
public createPayment(array|\YooKassa\Request\Payments\CreatePaymentRequestInterface $payment, null|string $idempotenceKey = null) : \YooKassa\Request\Payments\CreatePaymentResponse|null
```
**Summary**
Создание платежа.
**Description**
Чтобы принять оплату, необходимо создать объект платежа — `Payment`. Он содержит всю необходимую информацию
для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно
переходит из статуса в статус.
Необходимо указать один из параметров:
- payment_token — оплата по одноразовому PaymentToken, сформированному виджетом YooKassa JS;
- payment_method_id — оплата по сохраненным платежным данным;
- payment_method_data — оплата по новым платежным данным.
Если не указан ни один параметр и `confirmation.type = redirect`, то в качестве `confirmation_url`
возвращается ссылка, по которой пользователь сможет самостоятельно выбрать подходящий способ оплаты.
Дополнительные параметры:
- confirmation — передается, если необходимо уточнить способ подтверждения платежа;
- recipient — указывается при наличии нескольких товаров;
- metadata — дополнительные данные (передаются магазином).
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Payments\CreatePaymentRequestInterface | payment | Запрос на создание платежа |
| null OR string | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\AuthorizeException | |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ApiConnectionException | |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
**Returns:** \YooKassa\Request\Payments\CreatePaymentResponse|null -
##### Examples:
Запрос на создание платежа:
```php
try {
$idempotenceKey = uniqid('', true);
$response = $client->createPayment(
[
'amount' => [
'value' => '1.00',
'currency' => 'RUB',
],
'confirmation' => [
'type' => 'redirect',
'return_url' => 'https://merchant-site.ru/payment-notification',
],
'description' => 'Оплата заказа на сумму 1 руб',
'metadata' => [
'orderNumber' => 1001,
],
'capture' => true,
],
$idempotenceKey
);
$confirmation = $response->getConfirmation();
$redirectUrl = $confirmation->getConfirmationUrl();
// Далее производим редирект на полученный URL
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public createPayout() : ?\YooKassa\Request\Payouts\CreatePayoutResponse
```php
public createPayout(array|\YooKassa\Request\Payouts\CreatePayoutRequestInterface $payout, null|string $idempotenceKey = null) : ?\YooKassa\Request\Payouts\CreatePayoutResponse
```
**Summary**
Создание выплаты.
**Description**
Запрос позволяет перечислить продавцу оплату за выполненную услугу или проданный товар в рамках Безопасной сделки.
Выплату можно сделать на банковскую карту или на кошелек ЮMoney.
Обязательный параметр:
- amount — сумма выплаты. Есть ограничения на минимальный и максимальный размер выплаты и сумму выплат за месяц.
Необходимо указать один из параметров:
- payout_destination_data — данные платежного средства, на которое нужно сделать выплату;
- payout_token — токенизированные данные для выплаты. Например, синоним банковской карты.
Дополнительные параметры:
- description — описание транзакции (не более 128 символов);
- deal — сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку;
- metadata — любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Payouts\CreatePayoutRequestInterface | payout | Запрос на создание выплаты |
| null OR string | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности * @throws NotFoundException Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Payouts\CreatePayoutResponse -
##### Examples:
Запрос на создание выплаты:
```php
$request = [
'amount' => [
'value' => '80.00',
'currency' => 'RUB',
],
'payout_destination_data' => [
'type' => \YooKassa\Model\Payment\PaymentMethodType::YOO_MONEY,
'accountNumber' => '4100116075156746',
],
'description' => 'Выплата по заказу №37',
'metadata' => [
'order_id' => '37',
],
'deal' => [
'id' => 'dl-2909e77d-0022-5000-8000-0c37205b3208',
],
];
try {
$idempotenceKey = uniqid('', true);
$result = $client->createPayout($request, $idempotenceKey);
} catch (\Exception $e) {
$result = $e;
}
var_dump($result);
```
#### public createPersonalData() : null|\YooKassa\Request\PersonalData\PersonalDataResponse
```php
public createPersonalData(array|\YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface $request, null|string $idempotencyKey = null) : null|\YooKassa\Request\PersonalData\PersonalDataResponse
```
**Summary**
Создание персональных данных.
**Description**
Используйте этот запрос, чтобы создать в ЮKassa [объект персональных данных](#personal_data_object).
В запросе необходимо передать фамилию, имя, отчество пользователя и указать, с какой целью эти данные будут использоваться.
Идентификатор созданного объекта персональных данных необходимо использовать в запросе на проведение выплаты через СБП с проверкой получателя.
[Подробнее о выплатах с проверкой получателя](/developers/payouts/scenario-extensions/recipient-check)
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\PersonalData\CreatePersonalDataRequestInterface | request | Запрос на создание персональных данных |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** null|\YooKassa\Request\PersonalData\PersonalDataResponse - Объект персональных данных
##### Examples:
Запрос на создание персональных данных:
```php
$request = [
'type' => 'sbp_payout_recipient',
'last_name' => 'Иванов',
'first_name' => 'Иван',
'middle_name' => 'Иванович',
'metadata' => ['recipient_id' => '37'],
];
$idempotenceKey = uniqid('', true);
try {
$idempotenceKey = uniqid('', true);
$result = $client->createPersonalData($request, $idempotenceKey);
} catch (\Exception $e) {
$result = $e;
}
var_dump($result);
```
#### public createReceipt() : ?\YooKassa\Request\Receipts\AbstractReceiptResponse
```php
public createReceipt(array|\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface $receipt, null|string $idempotenceKey = null) : ?\YooKassa\Request\Receipts\AbstractReceiptResponse
```
**Summary**
Отправка чека в облачную кассу.
**Description**
Создает объект чека — `Receipt`. Возвращает успешно созданный чек по уникальному идентификатору
платежа или возврата.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface | receipt | Запрос на создание чека |
| null OR string | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок |
| \Exception | |
**Returns:** ?\YooKassa\Request\Receipts\AbstractReceiptResponse -
##### Examples:
Запрос на создание чека:
```php
try {
$response = $client->createReceipt(
[
'customer' => [
'email' => 'johndoe@yoomoney.ru',
'phone' => '79000000000',
],
'type' => 'payment',
'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df',
'on_behalf_of' => '123',
'send' => true,
'items' => [
[
'description' => 'Платок Gucci',
'quantity' => '1.00',
'amount' => [
'value' => '3000.00',
'currency' => 'RUB',
],
'vat_code' => 2,
'payment_mode' => 'full_payment',
'payment_subject' => 'commodity',
],
],
'settlements' => [
[
'type' => 'prepayment',
'amount' => [
'value' => '3000.00',
'currency' => 'RUB',
],
],
],
'tax_system_code' => 1,
],
uniqid('', true)
);
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public createRefund() : \YooKassa\Request\Refunds\CreateRefundResponse|null
```php
public createRefund(array|\YooKassa\Request\Refunds\CreateRefundRequestInterface $request, null|string $idempotencyKey = null) : \YooKassa\Request\Refunds\CreateRefundResponse|null
```
**Summary**
Проведение возврата платежа.
**Description**
Создает объект возврата — `Refund`. Возвращает успешно завершенный платеж по уникальному идентификатору
этого платежа. Создание возврата возможно только для платежей в статусе `succeeded`. Комиссии за проведение
возврата нет. Комиссия, которую ЮKassa берёт за проведение исходного платежа, не возвращается.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Refunds\CreateRefundRequestInterface | request | Запрос на создание возврата |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiConnectionException | |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\AuthorizeException | |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \Exception | |
**Returns:** \YooKassa\Request\Refunds\CreateRefundResponse|null -
##### Examples:
Запрос на создание возврата:
```php
try {
$response = $client->createRefund(
[
'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df',
'amount' => [
'value' => '1000.00',
'currency' => 'RUB',
],
'sources' => [
[
'account_id' => '456',
'amount' => [
'value' => '1000.00',
'currency' => 'RUB',
],
],
],
],
uniqid('', true)
);
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public createSelfEmployed() : ?\YooKassa\Request\SelfEmployed\SelfEmployedResponse
```php
public createSelfEmployed(array|\YooKassa\Request\SelfEmployed\SelfEmployedRequestInterface $selfEmployed, null|string $idempotenceKey = null) : ?\YooKassa\Request\SelfEmployed\SelfEmployedResponse
```
**Summary**
Создание самозанятого.
**Description**
Используйте этот запрос, чтобы создать в ЮKassa [объект самозанятого](https://yookassa.ru/developers/api?codeLang=bash#self_employed_object).
В запросе необходимо передать ИНН или телефон самозанятого для идентификации в сервисе Мой налог,
сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков и описание самозанятого.
Идентификатор созданного объекта самозанятого необходимо использовать в запросе на проведение выплаты.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\SelfEmployed\SelfEmployedRequestInterface | selfEmployed | Запрос на создание самозанятого |
| null OR string | idempotenceKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Request\SelfEmployed\SelfEmployedResponse -
##### Examples:
Запрос на создание самозанятого:
```php
$request = [
'itn' => '123456789012',
'phone' => '79001002030',
'confirmation' => ['type' => 'redirect'],
];
$idempotenceKey = uniqid('', true);
try {
$idempotenceKey = uniqid('', true);
$result = $client->createSelfEmployed($request, $idempotenceKey);
} catch (\Exception $e) {
$result = $e;
}
var_dump($result);
```
#### public getApiClient() : \YooKassa\Client\ApiClientInterface
```php
public getApiClient() : \YooKassa\Client\ApiClientInterface
```
**Summary**
Возвращает CURL клиента для работы с API.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
**Returns:** \YooKassa\Client\ApiClientInterface -
#### public getConfig() : array
```php
public getConfig() : array
```
**Summary**
Возвращает настройки клиента.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
**Returns:** array -
#### public getDealInfo() : ?\YooKassa\Model\Deal\DealInterface
```php
public getDealInfo(string $dealId) : ?\YooKassa\Model\Deal\DealInterface
```
**Summary**
Получить информацию о сделке.
**Description**
Запрос позволяет получить информацию о текущем состоянии сделки по её уникальному идентификатору.
Выдает объект чека {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | dealId | Идентификатор сделки |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Model\Deal\DealInterface -
##### Examples:
Получить информацию о сделке:
```php
try {
$response = $client->getDealInfo('dl-2909e77d-1022-5003-8004-0c37205b3208');
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getDeals() : ?\YooKassa\Request\Deals\DealsResponse
```php
public getDeals(null|array|\YooKassa\Request\Deals\DealsRequestInterface $filter = null) : ?\YooKassa\Request\Deals\DealsResponse
```
**Summary**
Получить список сделок магазина.
**Description**
Запрос позволяет получить список сделок, отфильтрованный по заданным критериям.
В ответ на запрос вернется список сделок с учетом переданных параметров. В списке будет информация о сделках,
созданных за последние 3 года. Список будет отсортирован по времени создания сделок в порядке убывания.
Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами.
В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| null OR array OR \YooKassa\Request\Deals\DealsRequestInterface | filter | Параметры фильтрации |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Deals\DealsResponse -
##### Examples:
Получить список сделок с фильтрацией:
```php
$cursor = null;
$params = [
'limit' => 30,
'status' => \YooKassa\Model\Deal\DealStatus::OPENED,
'full_text_search' => 'DEAL',
'created_at_gte' => '2023-10-01T00:00:00.000Z',
'created_at_lt' => '2023-11-01T23:59:59.999Z',
];
try {
do {
$params['cursor'] = $cursor;
$deals = $client->getDeals($params);
foreach ($deals->getItems() as $deal) {
$res = [
$deal->getCreatedAt()->format('Y-m-d H:i:s'),
$deal->getBalance()->getValue() . ' ' . $deal->getBalance()->getCurrency(),
$deal->getPayoutBalance()->getValue() . ' ' . $deal->getBalance()->getCurrency(),
$deal->getStatus(),
$deal->getId(),
];
echo implode(' - ', $res) . "\n";
}
} while ($cursor = $deals->getNextCursor());
} catch (\Exception $e) {
$response = $e;
var_dump($response);
}
```
#### public getPaymentInfo() : null|\YooKassa\Model\Payment\PaymentInterface
```php
public getPaymentInfo(string $paymentId) : null|\YooKassa\Model\Payment\PaymentInterface
```
**Summary**
Получить информацию о платеже.
**Description**
Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору.
Выдает объект платежа {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | paymentId | Идентификатор платежа |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** null|\YooKassa\Model\Payment\PaymentInterface - Объект платежа
##### Examples:
Получить информацию о платеже:
```php
try {
$response = $client->getPaymentInfo('24e89cb0-000f-5000-9000-1de77fa0d6df');
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getPayments() : ?\YooKassa\Request\Payments\PaymentsResponse
```php
public getPayments(array|\YooKassa\Request\Payments\PaymentsRequestInterface|null $filter = null) : ?\YooKassa\Request\Payments\PaymentsResponse
```
**Summary**
Получить список платежей магазина.
**Description**
Запрос позволяет получить список платежей, отфильтрованный по заданным критериям.
В ответ на запрос вернется список платежей с учетом переданных параметров. В списке будет информация о платежах,
созданных за последние 3 года. Список будет отсортирован по времени создания платежей в порядке убывания.
Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе
на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array OR \YooKassa\Request\Payments\PaymentsRequestInterface OR null | filter | Параметры фильтрации |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Payments\PaymentsResponse -
##### Examples:
Получить список платежей магазина с фильтрацией:
```php
$cursor = null;
$params = [
'limit' => 30,
'status' => \YooKassa\Model\Payment\PaymentStatus::CANCELED,
'payment_method' => \YooKassa\Model\Payment\PaymentMethodType::BANK_CARD,
'created_at_gte' => '2023-01-01T00:00:00.000Z',
'created_at_lt' => '2023-03-30T23:59:59.999Z',
];
try {
do {
$params['cursor'] = $cursor;
$payments = $client->getPayments($params);
foreach ($payments->getItems() as $payment) {
echo $payment->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' .
$payment->getStatus() . ' - ' .
$payment->getId() . "\n";
}
} while ($cursor = $payments->getNextCursor());
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getPayoutInfo() : null|\YooKassa\Model\Payout\PayoutInterface
```php
public getPayoutInfo(string $payoutId) : null|\YooKassa\Model\Payout\PayoutInterface
```
**Summary**
Получить информацию о выплате.
**Description**
Запрос позволяет получить информацию о текущем состоянии выплаты по ее уникальному идентификатору.
Выдает объект выплаты {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | payoutId | Идентификатор выплаты |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** null|\YooKassa\Model\Payout\PayoutInterface - Объект выплаты
##### Examples:
Получить информацию о выплате:
```php
$payoutId = 'po-285c0ab7-0003-5000-9000-0e1166498fda';
try {
$response = $client->getPayoutInfo($payoutId);
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getPersonalDataInfo() : null|\YooKassa\Model\PersonalData\PersonalDataInterface
```php
public getPersonalDataInfo(string $personalDataId) : null|\YooKassa\Model\PersonalData\PersonalDataInterface
```
**Summary**
Получить информацию о персональных данных.
**Description**
Запрос позволяет получить информацию о текущем состоянии персональных данных по их уникальному идентификатору.
Выдает объект платежа {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | personalDataId | Идентификатор персональных данных |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** null|\YooKassa\Model\PersonalData\PersonalDataInterface - Объект персональных данных
##### Examples:
Получить информацию о персональных данных:
```php
$payoutId = 'pd-285c0ab7-0003-5000-9000-0e1166498fda';
try {
$response = $client->getPersonalDataInfo($payoutId);
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getReceiptInfo() : ?\YooKassa\Request\Receipts\ReceiptResponseInterface
```php
public getReceiptInfo(string $receiptId) : ?\YooKassa\Request\Receipts\ReceiptResponseInterface
```
**Summary**
Получить информацию о чеке.
**Description**
Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору.
Выдает объект чека {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | receiptId | Идентификатор чека |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Request\Receipts\ReceiptResponseInterface -
##### Examples:
Получить информацию о чеке:
```php
try {
$response = $client->getPaymentInfo('24e89cb0-000f-5000-9000-1de77fa0d6df');
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getReceipts() : \YooKassa\Request\Receipts\ReceiptsResponse
```php
public getReceipts(null|array|\YooKassa\Request\Receipts\ReceiptsRequestInterface $filter = null) : \YooKassa\Request\Receipts\ReceiptsResponse
```
**Summary**
Получить список чеков магазина.
**Description**
Запрос позволяет получить список чеков, отфильтрованный по заданным критериям.
Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина.
В ответ на запрос вернется список чеков с учетом переданных параметров. В списке будет информация о чеках,
созданных за последние 3 года. Список будет отсортирован по времени создания чеков в порядке убывания.
Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами.
В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| null OR array OR \YooKassa\Request\Receipts\ReceiptsRequestInterface | filter | Параметры фильтрации |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** \YooKassa\Request\Receipts\ReceiptsResponse -
##### Examples:
Получить список чеков магазина с фильтрацией:
```php
$cursor = null;
$params = [
'limit' => 30,
'status' => \YooKassa\Model\Payment\PaymentStatus::CANCELED,
'payment_method' => \YooKassa\Model\Payment\PaymentMethodType::BANK_CARD,
'created_at_gte' => '2023-01-01T00:00:00.000Z',
'created_at_lt' => '2023-03-30T23:59:59.999Z',
];
try {
do {
$params['cursor'] = $cursor;
$payments = $client->getPayments($params);
foreach ($payments->getItems() as $payment) {
echo $payment->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' .
$payment->getStatus() . ' - ' .
$payment->getId() . "\n";
}
} while ($cursor = $payments->getNextCursor());
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getRefundInfo() : ?\YooKassa\Request\Refunds\RefundResponse
```php
public getRefundInfo(string $refundId) : ?\YooKassa\Request\Refunds\RefundResponse
```
**Summary**
Получить информацию о возврате.
**Description**
Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору.
В ответ на запрос придет объект возврата {@link} в актуальном статусе.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | refundId | Идентификатор возврата |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Refunds\RefundResponse -
##### Examples:
Получить информацию о возврате:
```php
try {
$response = $client->getReceiptInfo('ra-27ed1660-0001-0050-7a5e-10f80e0f0f29');
echo $response->getStatus();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getRefunds() : ?\YooKassa\Request\Refunds\RefundsResponse
```php
public getRefunds(null|array|\YooKassa\Request\Refunds\RefundsRequestInterface $filter = null) : ?\YooKassa\Request\Refunds\RefundsResponse
```
**Summary**
Получить список возвратов платежей.
**Description**
Запрос позволяет получить список возвратов, отфильтрованный по заданным критериям.
В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах,
созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания.
Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе
на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| null OR array OR \YooKassa\Request\Refunds\RefundsRequestInterface | filter | Параметры фильтрации |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Request\Refunds\RefundsResponse -
##### Examples:
Получить список возвратов платежей магазина с фильтрацией:
```php
$cursor = null;
$params = [
'limit' => 30,
'status' => \YooKassa\Model\Refund\RefundStatus::SUCCEEDED,
'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9',
'created_at_gte' => '2023-01-01T00:00:00.000Z',
'created_at_lt' => '2023-03-30T23:59:59.999Z',
];
try {
do {
$params['cursor'] = $cursor;
$refunds = $client->getRefunds($params);
foreach ($refunds->getItems() as $refund) {
echo $refund->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' .
$refund->getStatus() . ' - ' .
$refund->getId() . "\n";
}
} while ($cursor = $refunds->getNextCursor());
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getSbpBanks() : ?\YooKassa\Request\Payouts\SbpBanksResponse
```php
public getSbpBanks() : ?\YooKassa\Request\Payouts\SbpBanksResponse
```
**Summary**
Получить список участников СБП
**Description**
С помощью этого запроса вы можете получить актуальный список всех участников СБП.
Список нужно вывести получателю выплаты, идентификатор выбранного участника СБП необходимо использовать
в запросе на создание выплаты.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Request\Payouts\SbpBanksResponse -
##### Examples:
Получить список участников СБП:
```php
try {
$response = $client->getSbpBanks();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getSelfEmployedInfo() : ?\YooKassa\Model\SelfEmployed\SelfEmployedInterface
```php
public getSelfEmployedInfo(string $selfEmployedId) : ?\YooKassa\Model\SelfEmployed\SelfEmployedInterface
```
**Summary**
Получить информацию о самозанятом
**Description**
С помощью этого запроса вы можете получить информацию о текущем статусе самозанятого по его уникальному идентификатору.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | selfEmployedId | Идентификатор самозанятого |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
**Returns:** ?\YooKassa\Model\SelfEmployed\SelfEmployedInterface -
##### Examples:
Получить информацию о самозанятом:
```php
$payoutId = 'se-285c0ab7-0003-5000-9000-0e1166498fda';
try {
$response = $client->getSelfEmployedInfo($payoutId);
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public getWebhooks() : ?\YooKassa\Request\Webhook\WebhookListResponse
```php
public getWebhooks() : ?\YooKassa\Request\Webhook\WebhookListResponse
```
**Summary**
Список созданных Webhook.
**Description**
Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок |
**Returns:** ?\YooKassa\Request\Webhook\WebhookListResponse -
##### Examples:
Список созданных Webhook:
```php
// Работа с Webhook
// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений.
// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем.
$client->setAuthToken('token_XXXXXXX');
try {
$webHookUrl = 'https://merchant-site.ru/payment-notification';
$needWebHookList = [
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_SUCCEEDED,
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_CANCELED,
];
$currentWebHookList = $client->getWebhooks()->getItems();
foreach ($needWebHookList as $event) {
$hookIsSet = false;
foreach ($currentWebHookList as $webHook) {
if ($webHook->getEvent() !== $event) {
continue;
}
if ($webHook->getUrl() !== $webHookUrl) {
$client->removeWebhook($webHook->getId());
} else {
$hookIsSet = true;
}
break;
}
if (!$hookIsSet) {
$client->addWebhook(['event' => $event, 'url' => $webHookUrl]);
}
}
$response = 'SUCCESS';
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public isNotificationIPTrusted() : bool
```php
public isNotificationIPTrusted(string $ip) : bool
```
**Summary**
Метод проверяет, находится ли IP адрес среди IP адресов Юkassa, с которых отправляются уведомления.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | ip | IPv4 или IPv6 адрес webhook уведомления |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \Exception | Выбрасывается, если будет передан IP адрес неверного формата |
**Returns:** bool -
#### public me() : null|array
```php
public me(null|array|int|string $filter = null) : null|array
```
**Summary**
Информация о магазине.
**Description**
Запрос позволяет получить информацию о магазине для переданного OAuth-токена.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| null OR array OR int OR string | filter | Параметры поиска. В настоящее время доступен только `on_behalf_of` |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок |
**Returns:** null|array - Массив с информацией о магазине
##### Examples:
Информация о магазине:
```php
try {
$response = $client->me();
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public removeWebhook() : ?\YooKassa\Model\Webhook\Webhook
```php
public removeWebhook(string $webhookId, null|string $idempotencyKey = null) : ?\YooKassa\Model\Webhook\Webhook
```
**Summary**
Удаление Webhook.
**Description**
Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена.
Чтобы удалить webhook, вам нужно передать в запросе его идентификатор.
**Details:**
* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | webhookId | Идентификатор Webhook |
| null OR string | idempotencyKey | [Ключ идемпотентности](https://yookassa.ru/developers/using-api/basics?lang=php#idempotence) |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | Неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API |
| \YooKassa\Common\Exceptions\ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности |
| \YooKassa\Common\Exceptions\NotFoundException | Ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | Запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов |
| \YooKassa\Common\Exceptions\UnauthorizedException | Неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | Требуемое PHP расширение не установлено |
| \Exception | |
**Returns:** ?\YooKassa\Model\Webhook\Webhook -
##### Examples:
Удаление Webhook:
```php
// Работа с Webhook
// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений.
// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем.
$client->setAuthToken('token_XXXXXXX');
try {
$webHookUrl = 'https://merchant-site.ru/payment-notification';
$needWebHookList = [
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_SUCCEEDED,
\YooKassa\Model\Notification\NotificationEventType::PAYMENT_CANCELED,
];
$currentWebHookList = $client->getWebhooks()->getItems();
foreach ($needWebHookList as $event) {
$hookIsSet = false;
foreach ($currentWebHookList as $webHook) {
if ($webHook->getEvent() !== $event) {
continue;
}
if ($webHook->getUrl() !== $webHookUrl) {
$client->removeWebhook($webHook->getId());
} else {
$hookIsSet = true;
}
break;
}
if (!$hookIsSet) {
$client->addWebhook(['event' => $event, 'url' => $webHookUrl]);
}
}
$response = 'SUCCESS';
} catch (\Exception $e) {
$response = $e;
}
var_dump($response);
```
#### public setApiClient() : $this
```php
public setApiClient(\YooKassa\Client\ApiClientInterface $apiClient) : $this
```
**Summary**
Устанавливает CURL клиента для работы с API.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Client\ApiClientInterface | apiClient | |
**Returns:** $this -
#### public setAuth() : $this
```php
public setAuth(string|int $login, string $password) : $this
```
**Summary**
Устанавливает авторизацию по логин/паролю.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string OR int | login | |
| string | password | |
**Returns:** $this -
##### Examples:
Пример авторизации:
```php
$client->setAuth('xxxxxx', 'test_XXXXXXX');
```
#### public setAuthToken() : $this
```php
public setAuthToken(string $token) : $this
```
**Summary**
Устанавливает авторизацию по Oauth-токену.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | token | |
**Returns:** $this -
##### Examples:
Пример авторизации:
```php
$client->setAuthToken('token_XXXXXXX');
```
#### public setConfig() : void
```php
public setConfig(array $config) : void
```
**Summary**
Устанавливает настройки клиента.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array | config | |
**Returns:** void -
#### public setLogger() : self
```php
public setLogger(null|callable|\Psr\Log\LoggerInterface|object $value) : self
```
**Summary**
Устанавливает логгер приложения.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| null OR callable OR \Psr\Log\LoggerInterface OR object | value | Инстанс логгера |
**Returns:** self -
#### public setMaxRequestAttempts() : $this
```php
public setMaxRequestAttempts(int $attempts = self::DEFAULT_ATTEMPTS_COUNT) : $this
```
**Summary**
Установка значения количества попыток повторных запросов при статусе 202.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| int | attempts | |
**Returns:** $this -
#### public setRetryTimeout() : $this
```php
public setRetryTimeout(int $timeout = self::DEFAULT_DELAY) : $this
```
**Summary**
Установка значения задержки между повторными запросами.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| int | timeout | |
**Returns:** $this -
#### protected decodeData() : array
```php
protected decodeData(\YooKassa\Common\ResponseObject $response) : array
```
**Summary**
Декодирует JSON строку в массив данных.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \JsonException | |
**Returns:** array - Массив данных
#### protected delay() : void
```php
protected delay(\YooKassa\Common\ResponseObject $response) : void
```
**Summary**
Задержка между повторными запросами.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Common\ResponseObject | response | Объект ответа на запрос к API |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \JsonException | |
**Returns:** void -
#### protected encodeData() : string
```php
protected encodeData(array $serializedData) : string
```
**Summary**
Кодирует массив данных в JSON строку.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| array | serializedData | Массив данных для кодировки |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \JsonException | Выбрасывается, если не удалось конвертировать данные в строку JSON |
**Returns:** string - Строка JSON
#### protected execute() : mixed|\YooKassa\Common\ResponseObject
```php
protected execute(string $path, string $method, array $queryParams, null|string $httpBody = null, array $headers = []) : mixed|\YooKassa\Common\ResponseObject
```
**Summary**
Выполнение запроса и обработка 202 статуса.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| string | path | URL запроса |
| string | method | HTTP метод |
| array | queryParams | Массив GET параметров запроса |
| null OR string | httpBody | Тело запроса |
| array | headers | Массив заголовков запроса |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | |
| \YooKassa\Common\Exceptions\AuthorizeException | |
| \YooKassa\Common\Exceptions\ApiConnectionException | |
| \YooKassa\Common\Exceptions\ExtensionNotFoundException | |
**Returns:** mixed|\YooKassa\Common\ResponseObject -
#### protected handleError() : void
```php
protected handleError(\YooKassa\Common\ResponseObject $response) : void
```
**Summary**
Выбрасывает исключение по коду ошибки.
**Details:**
* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| \YooKassa\Common\ResponseObject | response | |
##### Throws:
| Type | Description |
| ---- | ----------- |
| \YooKassa\Common\Exceptions\ApiException | неожиданный код ошибки |
| \YooKassa\Common\Exceptions\BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. |
| \YooKassa\Common\Exceptions\ForbiddenException | секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции |
| \YooKassa\Common\Exceptions\InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. |
| \YooKassa\Common\Exceptions\NotFoundException | ресурс не найден |
| \YooKassa\Common\Exceptions\ResponseProcessingException | запрос был принят на обработку, но она не завершена |
| \YooKassa\Common\Exceptions\TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
| \YooKassa\Common\Exceptions\UnauthorizedException | неверное имя пользователя или пароль или невалидный OAuth-токен при аутентификации |
| \YooKassa\Common\Exceptions\AuthorizeException | Ошибка авторизации. Не установлен заголовок. |
**Returns:** void -
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 0](../reports/markers.md)
* [Deprecated - 13](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-06-30 using [phpDocumentor](http://www.phpdoc.org/)
© 2023 YooMoney