README.en.md

YooKassa API Python Client Library

Russian | English

This product is used for managing payments under The YooKassa API For usage by those who implemented YooKassa using the API method.

Requirements

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

Installation

Under console using pip

1. Install pip.
2. In the console, run the following command:

pip install --upgrade yookassa

Under console using easy_install

1. Install easy_install.
2. In the console, run the following command:

easy_install --upgrade yookassa

Manually

1. In the console, run the following command:

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

Commencing work

1. Import module

import yookassa

2. Configure a Client

from yookassa import Configuration

Configuration.configure('<Account Id>', '<Secret Key>')

or

from yookassa import Configuration

Configuration.account_id = '<Account Id>'
Configuration.secret_key = '<Secret Key>'

or via oauth

from yookassa import Configuration

Configuration.configure_auth_token('<Oauth Token>')

If you agree to participate in the development of the SDK, you can submit data about your framework, cms or module:

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

Configuration.configure('<Account Id>', '<Secret Key>')
Configuration.configure_user_agent(
    framework=Version('Django', '2.2.3'),
    cms=Version('Wagtail', '2.6.2'),
    module=Version('Y.CMS', '0.0.1')
)

3. Call the required API method. More details in our documentation for the YooKassa API

Examples of using the API SDK

YooKassa SDK Settings

• Authentication
• Statistics about the environment used
• Getting information about the store
• Working with Webhook
• Notifications

Working with payments

• Request to create a payment
• Request to create a payment via the builder
• Request for partial payment confirmation
• Request to cancel an incomplete payment
• Get payment information
• Get a list of payments with filtering

Working with refunds

• Request to create a refund
• Request to create a refund via the builder
• Get refund information
• Get a list of returns with filtering

Working with receipts

• Request to create a receipt
• Request to create a receipt via the builder
• Get information about the receipt
• Get a list of receipts with filtering