Основной класс для работы

class aiopayAPI.payok.PayOk(API_ID: int, API_KEY: str, shop: int, payment: str | None = None, payout_id: int | None = None, offset: int = 0, amount: float | None = None, method: ~aiopayAPI.types.methods.Method | None = None, receiver: str | None = None, sbp_bank: str | None = None, commission_type: str = <class 'aiopayAPI.types.commisions.Commission'>, url: str | None = None, json_file: str | None = None, processing_error: bool = False)

Класс для работы с сайтом PayOk

Параметры:

• API_ID (int) – ID ключа

• API_KEY (str) – API Ключ

• shop (int) – ID магазина

• payment (str) – ID платежа в вашей системе

• payout_id (int) – ID выплаты в системе Payok

• offset (int) – Отступ, пропуск указанного количества строк

• amount (float) – Сумма выплаты

• method (Method) – Специальное значение метода выплаты, (Method)

• receiver (str) – Реквизиты получателя выплаты

• sbp_bank (str) – Банк для выплаты по СБП

• commission_type (str) – Тип расчета комиссии (Commission)

• url (str) – URL для отправки Webhook при смене статуса выплаты

• json_file (str) – JSON файл для записи ответов

• processing_error (bool) – Обработка ошибок (boolean, default=False)

api_id: int

ID вашего ключа API

key: str

Ваш ключ API

shop: int

ID магазина

amount: float | None

Сумма выплаты

receiver: str | None

Реквизиты получателя выплаты

sbp: str | None

Банк для выплаты по СБП

commission: str | None

Тип расчета комиссии (Commission)

url: str | None

URL для отправки Webhook при смене статуса выплаты

payout_id: int | None

ID выплаты в системе Payok

offset: int | None

Отступ, пропуск указанного количества строк

method: str | None

Специальное значение метода выплаты (Method)

payment_id: int | None

ID платежа в вашей системе

json: str | None

JSON файл для записи ответов

error: bool | None

Обработка ошибок

get: GetAll

Функция для получения возможных данных (баланс, выплаты) Отностится к классу GetAll

async payment() → Dict

Создание выплат (перевод)

Параметры:

• API_ID (int, обязательно) – ID вашего ключа API

• API_KEY (str, обязательно) – Ваш ключ API

• shop (int, обязательно) – ID магазина

• amount (float, обязательно) – Сумма выплаты

• method (Method, обязательно) – Специальное значение метода выплаты, (default=Method.card)

• reciever (str, обязательно) – Реквизиты получателя выплаты

• sbp_bank (str, опционально) – Банк для выплаты по СБП

• commission_type (str, опционально) – Тип расчета комиссии (Commission.balance | Commission.payment)

• url (str, опционально) – URL для отправки Webhook при смене статуса выплаты

• json_file (str, опционально) – JSON файл для записи ответов

• processing_error (bool, опционально) – Обработка ошибок (boolean, default=False)

Результат:

dict с данными

class aiopayAPI.payok.GetAll(payok: PayOk)

Класс созданный для получения различных данных

баланс, транзакции, выплаты и т.п.

Параметры:

payok (PayOk) – Класс PayOk

pay

Класс PayOk

async balance() → Dict

Получение баланса

Параметры:

• API_ID (int, обязательно) – ID вашего ключа API

• API_KEY (str, обязательно) – Ваш ключ API

• payment (int, опционально) – ID платежа

Результат:

dict с данными баланса

async payout() → Dict

Получение выплат (макс. 100)

Параметры:

• API_ID (int, обязательно) – ID вашего ключа API

• API_KEY (str, обязательно) – Ваш ключ API

• offset (int, опционально) – Отступ, пропуск указанного количества строк

• payout_id (int, опционально) – ID выплаты в системе Payok

Результат:

dict объект с данными выплат