README.md

YooKassa API Python Client Library

Russian | English

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

Требования

1. Python 2.7 or Python 3.x
2. pip

Установка

C помощью pip

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

pip install --upgrade yookassa

С помощью easy_install

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

easy_install --upgrade yookassa

Вручную

1. В консоли выполните команды:

wget https://pypi.python.org/packages/5a/be/5eafdfb14aa6f32107e9feb6514ca1ad3fe56f8e5ee59d20693b32f7e79f/yookassa-1.0.0.tar.gz#md5=46595279b5578fd82a199bfd4cd51db2
tar zxf yookassa-1.0.0.tar.gz
cd yookassa-1.0.0
python setup.py install

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

1. Импортируйте модуль

import yookassa

2. Установите данные для конфигурации

from yookassa import Configuration

Configuration.configure('<Идентификатор магазина>', '<Секретный ключ>')

или

from yookassa import Configuration

Configuration.account_id = '<Идентификатор магазина>'
Configuration.secret_key = '<Секретный ключ>'

или через oauth

from yookassa import Configuration

Configuration.configure_auth_token('<Oauth Token>')

Если вы согласны участвовать в развитии SDK, вы можете передать данные о вашем фреймворке, cms или модуле:

from yookassa import Configuration
from yookassa.domain.common.user_agent import Version

Configuration.configure('<Идентификатор магазина>', '<Секретный ключ>')
Configuration.configure_user_agent(
    framework=Version('Django', '2.2.3'),
    cms=Version('Wagtail', '2.6.2'),
    module=Version('Y.CMS', '0.0.1')
)

3. Вызовите нужный метод API. Подробнее в документации к API ЮKassa

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

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

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

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

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

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

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

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

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