yoomoney/yookassa-sdk-php

This is a developer tool for integration with YooMoney.

3.7.4 2024-12-16 16:39 UTC

Requires

• php: >=8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• php-ds/php-ds: ^1.4
• psr/log: ^2.0 || ^3.0
• yoomoney/yookassa-sdk-validator: ^1.0

Requires (Dev)

• ext-xml: *
• friendsofphp/php-cs-fixer: ^3.15
• mockery/mockery: ^1.5
• php-parallel-lint/php-parallel-lint: ^1.3
• phpmd/phpmd: ^2.13
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.6
• yoomoney/yookassa-fakerphp: ^1.0

MIT

• YooMoney

• api
• payments
• sdk
• yookassa
• yoomoney

README

Russian | English

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

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

Требования

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

Установка

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

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

   composer require yoomoney/yookassa-sdk-php
   

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

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

   ...
    "require": {
        "php": ">=8.0",
        "yoomoney/yookassa-sdk-php": "^3.0"
   ...
   

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

   composer update
   

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

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

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

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

   use YooKassa\Client;
   

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

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

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

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

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

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

Что нового в SDK версии 3.x

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

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

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

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

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

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

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

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

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

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

Работа с выплатами

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

Работа с самозанятыми

• Запрос на создание самозанятого
• Получить информацию о самозанятом

Работа с персональными данными

• Создание персональных данных
• Получить информацию о персональных данных

Работа со списком участников СБП

• Получить список участников СБП

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

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