safepay-python 0.0.5

Safepay's python SDK for checkout integration

Safepay Python SDK

Official python library for Safepay API.

Installation

With Pip

pip install safepay-python

Usage

Import and create a Safepay client by passing your config;

from safepay_python.safepay import *

env = Safepay(
    {
        "environment": "sandbox",
        "apiKey": "sec_asd12-2342s-1231s",
        "v1Secret": "bar",
        "webhookSecret": "foo",
    }
)

You can now create payments and checkout links.

Payments

Create payment

Parameter	Type	Required
amount	number	Yes
currency	PKR, USD	Yes

payment_response = env.set_payment_details({"amount": 10000, "currency": "PKR"})

token = (payment_response['data'])['token']



# Pass `token` to create checkout link

Checkout

Create checkout link

Parameter	Type	Description	Required
token	string	Token from env.set_payment_details	Yes
orderId	string	Your internal invoice / order id	No
cancelUrl	string	Url to redirect to if user cancels the flow	Yes
redirectUrl	string	Url to redirect to if user completes the flow	Yes
source	string	Optional, defaults to custom	No
webhooks	boolean	Optional, defaults to false	No

checkout_url = env.get_checkout_url(
    {
        "beacon": token,
        "cancelUrl": "http://example.com/cancel",
        "orderId": "T800",
        "redirectUrl": "http://example.com/success",
        "source": "custom",
        "webhooks": True,
    }
)


# set webhooks = True if want to subscribe to webhooks
# redirect user to `url`

Verification

Signature

Parameter	Type	Description	Required
sig	string	The signature string from your server	Yes
tracker	string	The tracker string from your server	Yes

signature_verification = env.is_signature_valid({"sig": "abcd", "tracker": token})


# mark the invoice as paid if valid
# show an error if invalid

Webhook

Parameter	Type	Description	Required
x-sfpy-signature	string	The signature string from your server	Yes
data	object	The data object from your server	Yes

webhook_verification = env.is_webhook_valid(
    {"x-sfpy-signature": "abcd"}, {"data": data}
)



# mark the invoice as paid if valid
# show an error if invalid