YooKassa Payout API PHP Client Library

Russian | English

Клиент для работы по Протоколу массовых выплат

Возможности

С помощью этого SDK вы можете:

1. Генерировать сертификат для взаимодействия с ЮKassa.
2. Переводить деньги физическим лицам на кошельки в ЮMoney, номера мобильных телефонов, банковские карты и счета (makeDeposition).
3. Проверять возможность зачисления переводов на кошельки в ЮMoney (testDeposition).
4. Отслеживать баланс выплат (balance).
5. Получать уведомления о неуспешном статусе переводов на банковский счет, карту, мобильный телефон (errorDepositionNotification).

Требования

PHP 5.6.0 (и выше) с расширением libcurl и libxml

Установка

Установите SDK одним из трех способов

• с помощью менеджера пакетов Composer;
• с помощью файла composer.json;
• вручную.

В консоли с помощью Composer

1. Установите менеджер пакетов Composer.
2. В консоли выполните команду

composer require yoomoney/yookassa-payout-sdk-php

В файле composer.json своего проекта

1. Добавьте строку "yoomoney/yookassa-payout-sdk-php": "^2.0" в список зависимостей вашего проекта в файле composer.json

...
    "require": {
        "php": ">=5.6.0",
        "yoomoney/yookassa-payout-sdk-php": "^2.0"
...

2. Обновите зависимости проекта: в консоли перейдите в каталог с файлом composer.json и выполните команду:

composer update

3. В коде вашего проекта подключите автозагрузку файлов SDK Payout API ЮKassa:

require __DIR__ . '/vendor/autoload.php';

Вручную

1. Скачайте архив YooKassa Payout API PHP Client Library, распакуйте его и скопируйте каталог lib в папку вашего проекта, где будет размещен SDK.
2. В коде вашего проекта подключите автозагрузку файлов SDK Payout API ЮKassa:

require __DIR__ . '/lib/autoload.php'; 

Примеры использования SDK Payout API ЮKassa

Настройки SDK Payout API ЮKassa

• Получение сертификата для аутентификации запросов
• Запрос баланса

Зачисление переводов

• Проверка возможности зачислений
• Зачисление на банковскую карту
• Зачисление переводов на банковский счет

Уведомление о неуспешном переводе