Payment providers

Payment Interface

Interface for every payment is Payment.

It has properties:

authorized - Is payment provider class authorized.
id - ID of the payment.
amount - Amount to be invoiced. (May not include commission.)
description - Payment description/comment.
status - PaymentStatus.
income - Income amount.
url - Payment URL.

And methods:

update - Update payment status and income.

Before using any payment provider, you must authorize it with authorize() method.
It accepts specific arguments for every payment provider such as token, key e.t.c.
It also accepts optional arguments such as success_url, expiration_duration e.t.c. that sets default values for every payment of this provider.
However, you can override them while instantiating payment.

To create payment, you need to instantiate chosen payment provider class with required argument amount and optional arguments description, id, and other arguments specific for every provider.

After that, url property will be available.

To get current payment status and income from provider’s server, you need to call update() method first.

Qiwi

QiwiPayment

Qiwi payment provider class is QiwiPayment.

Arguments for authorization:

secret_key - Qiwi secret key.

Settings arguments:

theme_code - Code for displaying custom name and colors of the form. (Get it here)
expiration_duration - Time that the invoice will be available for payment.
payment_type - QiwiPaymentType enum.

Note

You can set default setting for every payment of QiwiPayment and override them for specific payment.

from pypayment import QiwiPayment, QiwiPaymentType
from datetime import timedelta

# Set default setting
QiwiPayment.authorize("my_secret_key",
                      theme_code="my_theme_code",
                      expiration_duration=timedelta(hours=1),
                      payment_type=QiwiPaymentType.CARD)

# Override setting for specific payment
payment = QiwiPayment(amount=100,
                      description="My payment",
                      theme_code="override_theme_code",
                      expiration_duration=timedelta(hours=3),
                      payment_type=QiwiPaymentType.WALLET)

QiwiPaymentType

Enum for payment_type setting argument:

WALLET - Payment using Qiwi wallet.
CARD - Payment using bank card.
ALL - Payment using every type possible.

YooMoney

YooMoneyPayment

YooMoney payment provider class is YooMoneyPayment.

You need to get access_token to authorize.

client_id - Create new application and copy client_id (Do it here)
redirect_uri - redirect_uri you specified when creating the application.
instance_name - (Optional) ID of the authorization instance in the application.

from pypayment import YooMoneyPayment

YooMoneyPayment.get_access_token(client_id="my_client_id",
                                 redirect_uri="my_redirect_uri",
                                 instance_name="my_instance_name")  # access_token = XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Hint

You should use YooMoneyPayment.get_access_token() to get access_token once and save it. You don’t need to get it every time.

Arguments for authorization:

access_token - YooMoney access token.

Settings arguments:

payment_type - YooMoneyPaymentType enum.
charge_commission - ChargeCommission enum.
success_url - User will be redirected to this url after paying.

Note

You can set default setting for every payment of YooMoneyPayment and override them for specific payment.

from pypayment import YooMoneyPayment, YooMoneyPaymentType, ChargeCommission

# Set default setting
YooMoneyPayment.authorize("my_access_token",
                          payment_type=YooMoneyPaymentType.CARD,
                          charge_commission=ChargeCommission.FROM_CUSTOMER,
                          success_url="my_success_url.com")

# Override default values
payment = YooMoneyPayment(amount=100,
                          description="My payment",
                          payment_type=YooMoneyPaymentType.WALLET,
                          charge_commission=ChargeCommission.FROM_SELLER,
                          success_url="override_success_url.com")

YooMoneyPaymentType

Enum for payment_type setting argument:

WALLET - Payment with YooMoney wallet.
CARD - Payment with bank card.
PHONE - Payment from phone balance.

PayOk

PayOkPayment

PayOk payment provider class is PayOkPayment.

Arguments for authorization:

api_key - PayOk API Key
api_id - PayOk API ID
shop_id - PayOk Shop ID
shop_secret_key - PayOk Shop secret key

Warning

Balance and Transactions permissions are required for api_key

Settings arguments:

payment_type - PayOkPaymentType enum.
currency - PayOkCurrency enum.
success_url - User will be redirected to this url after paying.

Note

You can set default setting for every payment of PayOkPayment and override them for specific payment.

from pypayment import PayOkPayment, PayOkPaymentType, PayOkCurrency
from datetime import timedelta

# Set default setting
PayOkPayment.authorize("my_api_key", "my_api_id", "my_shop_id", "my_shop_secret_key",
                       payment_type=PayOkPaymentType.CARD,
                       currency=PayOkCurrency.RUB,
                       success_url="my_success_url.com")

# Override setting for specific payment
payment = PayOkPayment(amount=100,
                       description="My payment",
                       payment_type=PayOkPaymentType.BITCOIN,
                       currency=PayOkCurrency.USD,
                       success_url="override_success_url.com")

PayOkPaymentType

Enum for payment_type setting argument:

CARD - Payment with bank card.
YOOMONEY - Payment with YooMoney.
QIWI - Payment with QIWI.
WEBMONEY - Payment with WebMoney.
PAYEER - Payment with Payeer.
PERFECT_MONEY - Payment with Perfect Money.
ADVCASH - Payment with Advcash.
BEELINE - Payment with Beeline.
MEGAFON - Payment with Megafon.
TELE2 - Payment with Tele2.
MTS - Payment with MTS.
QIWI_MOBILE - Payment with QIWI Mobile.
BITCOIN - Payment with Bitcoin.
LITECOIN - Payment with Litecoin.
DOGECOIN - Payment with Dogecoin.
DASH - Payment with Dash.
ZCASH - Payment with Zcash.

PayOkCurrency

Enum for currency setting argument:

RUB - Russian ruble.
UAH - Ukrainian hryvnia.
USD - United States dollar.
EUR - Euro.
RUB2 - Russian ruble. (Alternative Gateway)

BetaTransfer

BetaTransferPayment

BetaTransfer payment provider class is BetaTransferPayment.

Arguments for authorization:

public_key - BetaTransfer Public API Key
private_key - BetaTransfer Secret API Key

Warning

account-info, payment and info methods are required for API keys

Settings arguments:

payment_type - BetaTransferPaymentType enum.
url_result - Callback URL.
url_success - User will be redirected to this url after paying.
url_fail - User will be redirected to this url if payment failed.
locale - BetaTransferLocale enum.
charge_commission - ChargeCommission enum.

Note

You can set default setting for every payment of BetaTransferPayment and override them for specific payment.

from pypayment import BetaTransferPayment, BetaTransferPaymentType, BetaTransferCurrency, BetaTransferGateway, BetaTransferLocale
from datetime import timedelta

# Set default setting
BetaTransferPayment.authorize("my_api_key", "my_api_id", "my_shop_id", "my_shop_secret_key",
                       payment_type=BetaTransferPaymentType.RUB_CARD,
                       url_result="my_result_url.com",
                       url_success="my_success_url.com",
                       url_fail="my_fail_url.com",
                       locale=BetaTransferLocale.RUSSIAN,
                       charge_commission=ChargeCommission.FROM_SELLER)

# Override setting for specific payment
payment = BetaTransferPayment(amount=100,
                        description="My payment",
                        payment_type=BetaTransferPaymentType.BTC,
                        url_result="override_result_url.com",
                        url_success="override_success_url.com",
                        url_fail="override_fail_url.com",
                        locale=BetaTransferLocale.ENGLISH,
                        charge_commission=ChargeCommission.FROM_CUSTOMER)

Warning

There are minimum and maximum amount for every payment type. You can get them from BetaTransferGateway. Like this: BetaTransferPaymentType.RUB_CARD.value.min_amount and BetaTransferPaymentType.RUB_CARD.value.max_amount

Warning

url_success and url_fail must be specified either in default or payment init params.

BetaTransferPaymentType

Enum for payment_type setting argument (It contains BetaTransferGateway):

USDT_TRC20 - Payment with USDT TRC20.
USDT_ERC20 - Payment with USDT ERC20.
ETH - Payment with Ethereum.
BTC - Payment with Bitcoin.
KZT_CARD - Payment with Kazakhstani tenge.
UZS_CARD - Payment with Uzbekistan sum.
RUB_SBP - Payment with Russian ruble using SBP.
RUB_P2R - Payment with Russian ruble using P2R.
RUB_CARD - Payment with Russian ruble using card.
YOOMONEY - Payment with YooMoney.
QIWI - Payment with QIWI.
UAH_CARD - Payment with Ukrainian hryvnia.

BetaTransferGateway

Dataclass that is used in BetaTransferPaymentType enum.

name - Gateway name in BetaTransfer.
currency - BetaTransferCurrency enum.
min_amount - Minimum payment amount.
max_amount - Maximum payment amount.
commission - Commission for payment in percent.

BetaTransferCurrency

Enum for currency setting argument:

RUB - Russian ruble.
UAH - Ukrainian hryvnia.
USD - United States dollar.
KZT - Kazakhstani tenge.
UZS - Uzbekistan sum.

BetaTransferLocale

Enum for locale setting argument:

RUSSIAN - Russian language.
ENGLISH - English language.
UKRAINIAN - Ukrainian language.