Skip to main content

A Python client for the WaafiPay API

Project description

WaafiPay Python Client

WaafiPay Logo

Overview

The WaafiPay Python Client is a simple and intuitive library for integrating with the WaafiPay payment gateway. It allows you to perform various payment operations such as preauthorizing payments, committing transactions, and canceling preauthorizations, all while managing your API requests seamlessly.

Features

  • Preauthorize Payments: Easily initiate payment preauthorizations with just a few lines of code.
  • Commit Transactions: Securely commit preauthorized payments to finalize transactions.
  • Cancel Preauthorizations: Cancel any pending preauthorizations quickly and efficiently.
  • Easy to Use: Designed with simplicity in mind, making integration straightforward.
  • Secure: Handles sensitive payment information with care.

Installation

You can install the WaafiPay package via pip:

pip install waafipay

Usage

1. Import the Client

First, import the WaafiPayClient class from the package:

from waafipay import WaafiPayClient

2. Initialize the Client

client = WaafiPayClient(
    merchant_uid="XXXXXXX",  # Your merchant UID
    api_user_id="XXXXXX",     # Your API user ID
    api_key="API-XXXXXXXX"  # Your API key
)

3. Preauthorize a Payment

client.preauthorize_payment(
    payer_account="61XXXXXXX", # Payer Account
    amount="0.01", # Amount
    )

4. Commit the Preauthorization

response = client.preauthorize(
    payer_account="61XXXXXXXX", 
    amount="0.01",
    )

response_code = response['responseCode']
if response_code == '2001':
    transaction_id = response['transactionId']
    client.commit(transaction_id=transaction_id)
else:
    errorMessage = response['responseMsg']
    print(errorMessage)

5. Cancel the Preauthorization

response = client.preauthorize(
    payer_account="61XXXXXXXX", 
    amount="0.01",
    )

response_code = response['responseCode']
if response_code == '2001':
    transaction_id = response['transactionId']
    client.cancel(transaction_id=transaction_id)
else:
    errorMessage = response['responseMsg']
    print(errorMessage)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waafipay-0.0.7.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waafipay-0.0.7-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file waafipay-0.0.7.tar.gz.

File metadata

  • Download URL: waafipay-0.0.7.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for waafipay-0.0.7.tar.gz
Algorithm Hash digest
SHA256 7fa553eb42571c564a7a79815acd123e2fb6879c12918f68d8a4e856cde41f62
MD5 a09aa8661cec0778af56aa39b05e4c22
BLAKE2b-256 dc4e38bdc993ca490d57b8c11908c8247f1315afbc65155f2c5c49d5b1e126df

See more details on using hashes here.

File details

Details for the file waafipay-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: waafipay-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for waafipay-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b9be11deebc8ff0e0ee8fa25007f0996f0fd7d55613049e271a8d7ec5fc8f9e6
MD5 51414c3faeb156131a4f519ab7e877da
BLAKE2b-256 4440b675d3d91c754841234c99459f7f1179df6c22e2a26d1e86c5df45ec0a77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page