yoomoney / yookassa-sdk-php

PHP SDK for YooKassa Payments API
https://yookassa.ru/developers
MIT License
67 stars 30 forks source link
cms payments php sdk yookassa

YooKassa API PHP Client Library

Build Status Latest Stable Version Total Downloads Monthly Downloads License

Russian | English

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

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

Требования

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

Установка

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

  1. Установите менеджер пакетов Composer.
  2. В консоли выполните команду
    composer require yoomoney/yookassa-sdk-php

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

  1. Добавьте строку "yoomoney/yookassa-sdk-php": "^2.1" в список зависимостей вашего проекта в файле composer.json
    ...
    "require": {
        "php": ">=5.3.2",
        "yoomoney/yookassa-sdk-php": "^2.1"
    ...
  2. Обновите зависимости проекта. В консоли перейдите в каталог, где лежит composer.json, и выполните команду:
    composer update
  3. В коде вашего проекта подключите автозагрузку файлов нашего клиента:
    require __DIR__ . '/vendor/autoload.php';

Вручную

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

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

  1. Импортируйте нужные классы
    use YooKassa\Client;
  2. Создайте экземпляр объекта клиента, задайте идентификатор магазина и секретный ключ (их можно получить в личном кабинете ЮKassa). Как выпустить секретный ключ
    $client = new Client();
    $client->setAuth('shopId', 'secretKey');
  3. Вызовите нужный метод API.

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

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

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

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

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

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

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

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