SDK that allows you to access PostFinance Checkout
Project description
PostFinance Checkout Python SDK
Python SDK to access PostFinance Checkout web services API.
Library facilitates your interaction with various services such as transactions, accounts, and subscriptions.
API documentation
PostFinance Checkout Web Service API
Requirements
- Python 3.7+
Installation
pip3 install (recommended)
pip3 install --upgrade postfinancecheckout
pip3 install from source via github
pip3 install git+http://github.com/pfpayments/python-sdk.git
(you may need to run pip3
with root permission: sudo pip3 install git+http://github.com/pfpayments/python-sdk.git
)
install from source via Setuptools
Install via Setuptools.
pip3 install setuptools
python setup.py install
(or sudo python setup.py install
to install the package for all users)
Usage
The library needs to be configured with your account's space id, user id, and secret key which are available in your PostFinance Checkout
account dashboard. Set space_id
, user_id
, and api_secret
to their values.
You can also optionally set default_headers
to set some headers that will be sent to all requests
Configuring a Service
from postfinancecheckout import Configuration
from postfinancecheckout.api import TransactionServiceApi, TransactionPaymentPageServiceApi
from postfinancecheckout.models import LineItem, LineItemType, TransactionCreate
space_id = 405
# default_headers is an optional param, that represents headers sent to all requests
config = Configuration(
user_id=512,
api_secret='FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=',
default_headers={'x-meta-custom-header': 'value-1', 'x-meta-custom-header-2': 'value-2'},
# set a custom request timeout if needed. (If not set, then the default value is: 25 seconds)
request_timeout = 30
)
transaction_service = TransactionServiceApi(configuration=config)
transaction_payment_page_service = TransactionPaymentPageServiceApi(configuration=config)
To get started with sending transactions, please review the example below:
from postfinancecheckout import Configuration
from postfinancecheckout.api import TransactionServiceApi, TransactionPaymentPageServiceApi
from postfinancecheckout.models import LineItem, LineItemType, TransactionCreate
space_id = 405
config = Configuration(
user_id=512,
api_secret='FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=',
# set a custom request timeout if needed. (If not set, then the default value is: 25 seconds)
request_timeout = 30
)
transaction_service = TransactionServiceApi(configuration=config)
transaction_payment_page_service = TransactionPaymentPageServiceApi(configuration=config)
# create line item
line_item = LineItem(
name='Red T-Shirt',
unique_id='5412',
sku='red-t-shirt-123',
quantity=1,
amount_including_tax=29.95,
type=LineItemType.PRODUCT
)
# create transaction model
transaction = TransactionCreate(
line_items=[line_item],
auto_confirmation_enabled=True,
currency='EUR',
)
transaction_create = transaction_service.create(space_id=space_id, transaction=transaction)
payment_page_url = transaction_payment_page_service.payment_page_url(space_id=space_id, id=transaction_create.id)
# redirect your customer to this payment_page_url
License
Please see the license file for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for postfinancecheckout-4.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 485a58ee7fec08038acaed69105bba853674f5a404d8ae6b775e273b17bf2de8 |
|
MD5 | 123ef1eeb16359b469672892f3c17afe |
|
BLAKE2b-256 | c2bae1f7ef331c2297c1fd16cff6d949f30fb96dcaff8e4b9aae92189d73b026 |