README

Russian | English

Клиент для работы с платежами по API ЮKassa Подходит тем, у кого способ подключения к ЮKassa называется API.

Документация по данному SDK.

Требования

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

Установка

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

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

composer require zoonru/yookassa-sdk-php

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

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

...
    "require": {
        "php": "^8.1",
        "zoonru/yookassa-sdk-php": "^2.6.3"
...

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

composer update

1. В коде вашего проекта подключите автозагрузку файлов нашего клиента:

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

Вручную

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

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

Начало работы

1. Импортируйте нужные классы

use YooKassa\Client;

1. Создайте экземпляр объекта клиента, задайте идентификатор магазина и секретный ключ (их можно получить в личном кабинете ЮKassa). Как выпустить секретный ключ

$client = new Client();
$client->setAuth('shopId', 'secretKey');

1. Вызовите нужный метод API.

   Подробнее в документации к API ЮKassa.

   Подробнее в документации к SDK ЮKassa.

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

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

• Аутентификация
• Статистические данные об используемом окружении
• Получение информации о магазине
• Работа с Webhook
• Входящие уведомления

Работа с платежами

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

Работа с возвратами

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

Работа с чеками

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

Работа с безопасными сделками

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