satispaython 0.1.4

A simple library to manage Satispay payments

satispaython

A simple library to manage Satispay payments following the Web-button flow.

Requirements

• python 3.8
• cryptography >= 3.1
• requests >= 2.24

Installation

pip

You can install this package with pip: pip install satispaython.

clone

This repo comes with Pipfiles, so if you use pipenv just clone this repo and do pipenv install to create the virtual environment.

Usage

Key generation

Firs of all you nedd an RSA private key. You may generate the key by yourself or you may use the provided utility functions:

from satispaython.utils import generate_key, write_key

rsa_key = generate_key()
write_key(rsa_key, 'path/to/file.pem')

In order to load the key from a PEM encoded file you may use the utility function:

from satispaython.utils import load_key

rsa_key = load_key('path/to/file.pem')

:information_source: The function write_key stores the key in the PEM format. If you generate the key with any other method and you would like to use the load_key function, please make sure the key is stored within a file in the PEM format.

:information_source: Satispaython key management is based on cryptography so all the functions which require an RSA key parameter expect an object of the class RSAPrivateKey. If you don't use the load_key function then make sure your key is an instance of RSAPrivateKey.

You may protect your key with a password simply adding the password parameter:

write_key(rsa_key, 'path/to/file.pem', password='mypassword')
rsa_key = load_key('path/to/file.pem', password='mypassword')

Satispay API

In order to use the Satispay API simply import satispaython:

import satispaython as satispay

Then you can:

• Obtain a key-id using a token

satispay.obtain_key_id(rsa_key, token)

:information_source: The token is the activation code that can be generated from the Satispay Dashboard (or provided manually for Sandbox account).

:warning: Tokens are disposable, then the KeyId must be saved right after its creation.

• Make an authentication test

satispay.test_authentication(key_id, rsa_key)

:information_source: Authentication tests work on Sandbox endpoints only.

• Create a payment

satispay.create_payment(key_id, rsa_key, amount_unit, currency, callback_url, expiration_date=None, external_code=None, metadata=None, idempotency_key=None)

You may use the utility function format_datetime to get a correctly formatted expiration_date to supply to the request:

from datetime import datetime, timezone, timedelta
from satispaython.utils import format_datetime

expiration_date = datetime.now(timezone.utc) + timedelta(hours=1)
expiration_date = format_datetime(expiration_date)

• Get payment details

satispay.get_payment_details(key_id, rsa_key, payment_id)

Satispaython web requests are based on requests so those functions return an instance of Response. On success, Satispay APIs respond with a JSON encoded body, so you can simply check for the response.status_code and eventually get the content with response.json().

If you need to use the Sandbox endpoints, simply set the staging parameter to True:

satispay.obtain_key_id(rsa_key, token, staging=True)
satispay.create_payment(key_id, rsa_key, amount_unit, currency, callback_url, expiration_date=None, external_code=None, metadata=None, idempotency_key=None, staging=True)
satispay.get_payment_details(key_id, rsa_key, payment_id, staging=True)