A simple, clean and less dependant client to handle payments through Redsys.
Project description
Welcome to python-redsys!
A simple, clean and less dependant client to handle payments through the Redsys platform using one of the available methods: redirect connection or (secure method).
The purpose of this library is to provide a normalized interface between Redsys and other Python applications.
About RedirectClient
Although redirect connection depends on a webserver to resolve the communication step, the RedirectClient provided in this library does not assume any kind of procedure to resolve that step; it merely prepares the necessary parameters to make a request and handles the corresponding response parameters. That's what less dependant means.
Example using redirect connection
0. Install python-redsys
You can add python-redsys to your project with pip:
pip install python-redsys
Or with poetry:
poetry add python-redsys
1. Instantiate the redirect client
from decimal import Decimal as D, ROUND_HALF_UP
from redsys.constants import EUR, STANDARD_PAYMENT
from redsys.client import RedirectClient
secret_key = "123456789abcdef"
client = RedirectClient(secret_key)
2. Create a request
request = client.create_request()
3. Set up the request parameters
request.merchant_code = "100000001"
request.terminal = "1"
request.transaction_type = STANDARD_PAYMENT
request.currency = EUR
request.order = "000000001"
# The amount must be defined as decimal and pre-formatted with only two decimals
request.amount = D("10.56489").quantize(D(".01"), ROUND_HALF_UP)
request.merchant_data = "merchant data for tracking purpose like order_id, session_key, ..."
request.merchant_name = "Example Commerce"
request.titular = "Example Ltd."
request.product_description = "Products of Example Commerce"
request.merchant_url = "https://example.com/redsys/response"
4. Prepare the request
This method returns a dict with the necessary post parameters that are needed during the communication step.
args = client.prepare_request(request)
5. Communication step
Redirect the user-agent to the corresponding Redsys's endpoint using the post parameters given in the previous step.
After the payment process is finish, Redsys will respond making a
request to the merchant_url
defined in step 3.
6. Create and check the response
Create the response object using the received parameters from Redsys.
The method create_response()
throws a ValueError
in case the
received signature is not equal to the calculated one using the
given merchant_parameters
. This normally means that the response is
not coming from Redsys or that it has been compromised.
signature = "YqFenHc2HpB273l8c995...."
merchant_parameters = "AndvIh66VZdkC5TG3nYL5j4XfCnFFbo3VkOu9TAeTs58fxddgc..."
response = client.create_response(signature, merchant_parameters)
if response.is_paid():
# Do the corresponding actions after a successful payment
else:
# Do the corresponding actions after a failed payment
raise Exception(response.response, response.message)
Methods for checking the response:
According to the Redsys documentation:
response.is_paid()
: ReturnsTrue
if the response code is between 0 and 99 (both included).response.is_canceled()
: ReturnsTrue
if the response code is 400.response.is_refunded()
: ReturnsTrue
if the response code is 900.response.is_authorized()
: ReturnsTrue
if the response is paid, refunded or canceled.
Also, you can directly access the code or the message defined in Redsys
documentation using response.response_code
or
response.response_message
.
Contributions
Please, feel free to send any contribution that maintains the less dependant philosophy.
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
Built Distribution
Hashes for python_redsys-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4b010b4ea08598c2ecff7449347389cbc923bc022e3764e5e7f1b123004074b |
|
MD5 | 2b5adbb04b218cdfe9bf08aa73a9372f |
|
BLAKE2b-256 | c83d7a67e2dcad31c0b5e78e470be4f1274e1afacc4700c15f57d535cf668e6f |