Add get balance request

Author: Ruslan Plotnikov

example.php

@@ -26,6 +26,7 @@
             case 'paymentCapture':
             case 'paymentGetStatus':
             case 'payoutCreate':
+            case 'payoutGetBalance':
             case 'paymentWebhook':
             case 'paymentRefund':
             case 'paymentRefundMarketplace':

example_list.php

@@ -118,6 +118,12 @@
         'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payouts-api',
         'link'  => '',
     ],
+    'payoutGetBalance' => [
+        'name'  => 'Получение баланса для выплаты',
+        'about'  => 'Запрос к YPMN для проверки баланса на вылпату',
+        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payouts-api/paths/~1v4~1payout~1balance/get',
+        'link'  => '',
+    ],
     'getSession' => [
         'name'  => 'Создание сессии',
         'about'  => 'Создание уникальной сессии YPMN',

src/ApiRequest.php

@@ -19,6 +19,7 @@ class ApiRequest implements ApiRequestInterface
     public const REFUND_API = '/api/v4/payments/refund';
     public const STATUS_API = '/api/v4/payments/status';
     public const PAYOUT_CREATE_API = '/api/v4/payout';
+    public const PAYOUT_GET_BALANCE_API = '/api/v4/payout/balance';
     public const REPORTS_ORDERS_API = '/reports/orders';
     public const SESSION_API = '/api/v4/payments/sessions';
     public const REPORT_CHART_API = '/api/v4/reports/chart';
@@ -542,6 +543,31 @@ public function sendPayoutCreateRequest(PayoutInterface $payout): array
         return $this->sendPostRequest($payout, self::PAYOUT_CREATE_API);
     }
 
+    /**
+     * @inheritdoc
+     * @throws PaymentException
+     */
+    public function sendPayoutGetBalanceRequest(array $params = []): array
+    {
+        $url = self::PAYOUT_GET_BALANCE_API;
+
+        if (!empty($params)) {
+            $url .= '?' . http_build_query($params);
+        }
+
+        $responseData = $this->sendGetRequest($url);
+
+        if (mb_strlen($responseData['error']) > 0) {
+            throw new PaymentException($responseData['error']);
+        }
+
+        if ($responseData['response'] == null || strlen($responseData['response']) === 0) {
+            throw new PaymentException('Непредвиденная ошибка!.');
+        }
+
+        return $responseData;
+    }
+
     /** @inheritdoc
      * @throws PaymentException
      */

src/ApiRequestInterface.php

@@ -104,6 +104,13 @@ public function sendTokenCreationRequest(PaymentReference $payuPaymentReference)
      */
     public function sendTokenPaymentRequest(MerchantToken $tokenHash): array;
 
+    /**
+     * Отправить запрос на получение баланса
+     * @param array $params
+     * @return array
+     */
+    public function sendPayoutGetBalanceRequest(array $params = []): array;
+
     /**
      * Отправить запрос для получения графика
      * @param array $params

src/Examples/payoutGetBalance.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use Ypmn\ApiRequest;
+
+// Подключим файл, в котором заданы параметры мерчанта
+include_once 'start.php';
+
+/** @var \Ypmn\Merchant $merchant */
+
+/*
+ * Запрос баланса для выплаты
+ */
+
+/* Создадим HTTP-запрос к API */
+$apiRequest = new ApiRequest($merchant);
+
+// Включить режим отладки (закомментируйте или удалите в рабочей программе!) //
+$apiRequest->setDebugMode();
+// Переключиться на тестовый сервер (закомментируйте или удалите в рабочей программе!) //
+$apiRequest->setSandboxMode();
+
+// Отправим запрос
+$responseData = $apiRequest->sendPayoutGetBalanceRequest([
+    'merchantCodes' => 'test1,test2', // Массив кодов отправителя (если у Вас их несколько и необходимо получить отчет только по некоторым из них)
+    'minValue' => 0, // Минимальная сумма баланса.
+    'maxValue' => 100, // Максимальная сумма баланса.
+    'currency' => 'RUB', // Код валюты, в которой выражены цены. Согласно ISO 4217
+]);