example_list.php

<?php

declare(strict_types=1);

function methodsParamsList(string $url, array $methodsToSkip) : string
{
    $html_list = '';
    foreach (\Ypmn\PaymentMethods::NAMES as $method=>$name) {
        if (in_array($method, $methodsToSkip)) {
            continue;
        }

        $html_list .= '
            <li>
                <a href="' . $url . '&method=' . $method . '"'
            . ( !empty($_GET['method']) && $_GET['method'] === $method ? ' style="color:orange"' : '' )
            . '>' . $name . '</a>
            </li>
        ';
    }

    return $html_list;
}

$examples = [
    'start' => [
        'name'  => 'Начало работы',
        'about'  => '
            Первый шаг интеграции с YPMN API &ndash;получение кода мерчанта и секретного ключа после <a href="https://ypmn.ru/ru/connect/?utm_source=header_btn_1">подключения</a>
            <br>
            <br>
            Получить их можно в <a href="https://secure.payu.ru/cpanel/?from=PHP_SDK" rel="noopener" target="_blank">личном кабинете</a>
            <br>
            <br>На стороне клиента они используются для создания объекта Merchant (см. <a href="https://github.com/yourpayments/php-api-client/blob/main/src/Examples/start.php">файл с примером</a>).
        ',
        'docLink'  => '',
        'link'  => '',
    ],

    'title1' => 'Платежи',
    'authorize' => [
        'name'  => 'Авторизация и токенизация',
        'about'  => '
            При одностадийной (SMS) схеме этого достаточно для автоматического списания средств Плательщика в пользу ТСП.
            <br>
            <br>При двустадийной (DMS) схеме, или для досрочного списания, необходимо сделать <a href="/?function=capture">запрос на списание</a>
            <br>
            <br>Если вам нужен самый простой пример (без формы, токенизации, чеков и т.д), посмотрите файл <a href="https://github.com/yourpayments/php-api-client/blob/main/src/Examples/minimal.php" rel="noopener" target="_blank">minimal.php</a> 
        ',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
        'link'  => '',
    ],
    'capture' => [
        'name'  => 'Списание',
        'about'  => '
            Запрос на списание используется в двустадийной (DMS) схеме платежа, либо если надо списать деньги быстрее, чем сработает автоматическое списание.
            <br>
            <br>При одностадиной (DMS) схеме запрос отправлять необязательно, достаточно <a href="./?function=authorize">авторизации платежа</a>
        ',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1capture/post',
        'link'  => '',
    ],
    'refund' => [
        'name'  => 'Возврат средств',
        'about'  => 'Запрос на полный или частичный возврат средств.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1refund/post',
        'link'  => '',
    ],

    'title2' => 'Выплаты',
    'payout' => [
        'name'  => 'Создание выплаты',
        'about'  => 'Запрос к YPMN для совершения выплаты на карту (для компаний, сертифицированных по PCI-DSS). У вас должно быть достаточно средств на специальном счету для выплат.<br><br>Тестовая карта (для выплат на тестовом контуре): 4149605380309302',
        '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'  => '',
    ],

    'title4' => 'Подключение сабмерчантов',
    'qstCreateOrg' => [
        'name'  => 'Анкета Юридического лица',
        'about'  => 'В этом примере показана реализация отправки анкеты подключаемого продавца-организации на проверку в YPMN.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/qst-api/paths/~1v4~1qst~1create/post',
        'link'  => '',
    ],
    'qstCreateIp' => [
        'name'  => 'Анкета ИП',
        'about'  => 'В этом примере показана реализация отправки анкеты подключаемого продавца-ИП на проверку в YPMN.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/qst-api/paths/~1v4~1qst~1create/post',
        'link'  => '',
    ],
    'qstStatus' => [
        'name'  => 'Статус анкеты',
        'about'  => 'В этом примере показано получение статуса анкеты по её ID.<br/><br/>ID анкеты возвращается при отправке анкеты на проверку.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/qst-api/paths/~1v4~1qst~1status~1%7Bid%7D/get',
        'link'  => '',
    ],
    'qstPrint' => [
        'name'  => 'Печать анкеты',
        'about'  => 'В этом примере показано получение заполненной pdf версии анкеты по её ID.<br/><br/>ID анкеты возвращается при отправке анкеты на проверку.<br/><br/>Распечатать можно только одобренную анкету - в статусе approved.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/qst-api/paths/~1v4~1qst~1print~1%7Bid%7D/get',
        'link'  => '',
    ],
    'qstList' => [
        'name'  => 'Список анкет',
        'about'  => 'В этом примере показано получение списка анкет.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/qst-api/paths/~1v4~1qst~1list/get',
        'link'  => '',
    ],

    'title5' => 'Безопасные поля',
    'secureFields' => [
        'name'  => 'Пример формы',
        'about'  => 'Это пример формы оплаты с использованием Secure Fields.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/secure-fields',
        'link'  => '',
    ],
    'getSession' => [
        'name'  => 'Создание сессии',
        'about'  => 'Создание уникальной сессии YPMN',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/sessions/paths/~1v4~1payments~1sessions/post',
        'link'  => '',
    ],
    'oneTimeTokenPayment' => [
        'name'  => 'Оплата одноразовым токеном',
        'about'  => 'Оплата одноразовым токеном',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
        'link'  => '',
    ],

    'title3' => 'Общее',
    'webhookProcessing' => [
        'name' => 'Обработка вебхука',
        'about' => 'В этом примере показана обработка вебхука о событиях по операции',
        'docLink' => 'https://ypmn.ru/ru/documentation/#tag/webhooks',
        'link' => '',
    ],
    'status' => [
        'name'  => 'Статус операции',
        'about'  => 'Запрос к YPMN API о состоянии операции.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1status~1%7BmerchantPaymentReference%7D/get',
        'link'  => '',
    ],
    'getReportGeneral' => [
        'name'  => 'Отчёт',
        'about'  => 'Это пример получения отчета в формате JSON.',
        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/reports/paths/~1v4~1reports~1general/get',
        'link'  => '',
    ],

// Примеры к удалению после проверки:
//    'token_payment' => [
//        'name'  => 'Оплата токеном',
//        'about'  => '...',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1capture/post',
//        'link'  => '',
//    ],
//    'simpleGetPaymentLink' => [
//        'name'  => 'Самая простая оплата',
//        'about'  => '
//            В этом примере показана самая простая реализация.
//            С минимальным набором полей без детализации, только оплата заказа c определённой суммой.
//            <br>
//            <br>
//            <ol>' . methodsParamsList('./?function=simpleGetPaymentLink', ['PAYOUT', 'PAYOUT_FP']) . '</ol>
//        ',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'getPaymentLink' => [
//        'name'  => 'Подробная оплата',
//        'about'  => '
//            Это пример платежа с максимальным набором полей.
//            <br>
//            <br>
//            <ol>' . methodsParamsList('./?function=getPaymentLink', ['PAYOUT', 'PAYOUT_FP']) . '</ol>
//        ',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'getPaymentLinkWithReceipt' => [
//        'name'  => 'Оплата с чеком',
//        'about'  => '
//            Пример платежа с регистрацией чека
//            <br>
//            <br>
//            <ol>' . methodsParamsList('./?function=getPaymentLinkWithReceipt', ['PAYOUT', 'PAYOUT_FP']) . '</ol>
//        ',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'getBindingFasterPayment' => [
//        'name'  => 'Токенизация СБП',
//        'about'  => 'В этом примере после оплаты СБП в вебхуке придёт токен, который можно использовать для дальнейших оплат',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/',
//        'link'  => '',
//    ],
//    'paymentByFasterBinding' => [
//        'name'  => 'Оплата токеном СБП',
//        'about'  => 'Это пример оплаты СБП с помощью ранее созданного токена',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/',
//        'link'  => '',
//    ],
//    'getBindingPays' => [
//        'name'  => 'Создание токена SberPay',
//        'about'  => 'В этом примере отправляется запрос на создание токена SberPay с одновременной оплатой',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'paymentByBindingPays' => [
//        'name'  => 'Оплата по токену SberPay',
//        'about'  => 'Это пример демонстрирует оплату через SberPay по средством ранее созданного токена',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'getPaymentLinkMarketplace' => [
//        'name'  => 'Платёж со сплитом',
//        'about'  => 'Это пример платежа со сплитом (разделением оплаты на несколько плательщиков).',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-split-api',
//        'link'  => '',
//    ],
//    'getPaymentLinkMarketplaceWithReceipts' => [
//        'name'  => 'Платёж со сплитом и чеком',
//        'about'  => 'Это пример платежа со сплитом (разделением оплаты на несколько плательщиков) и регистрацией чеков.',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-split-api',
//        'link'  => '',
//    ],
//    'getToken' => [
//        'name'  => 'Создание токена',
//        'about'  => 'Приложение передаёт номер успешно оплаченного заказа в YPMN API, и получает в ответ платёжный токен.<br><br>Это называется "Токенизация карты" (чтобы запомнить карту клиента и не вводить повторно.<br><br>Очень полезная функция для подписок и регулярных платежей.',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/token-api/paths/~1v4~1token/post',
//        'link'  => '',
//    ],
//    'paymentByToken' => [
//        'name'  => 'Оплата токеном',
//        'about'  => 'Оплата с помощью токена (теперь не нужно повторно вводить данные банковской карты)',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1authorize/post',
//        'link'  => '',
//    ],
//    'paymentCapture' => [
//        'name'  => 'Списание средств',
//        'about'  => 'Списание ранее заблокированной на счету суммы. Не обязательно, если у Вас настроена оплата в 1 шаг.',
//        'docLink'  => 'https://ypmn.ru/ru/documentation/#tag/payment-api/paths/~1v4~1payments~1capture/post',
//        'link'  => '',
//    ],
];