flick-payment 0.0.2

Flick Python SDKs contains FlickPay inflow and outflow solutions

flick_paymentSDK PYTHON

flick_paymentSDK is a secure and quick way for customers to access accounts and interact with the Flick API for Identity, Financial Data, Payouts, Collections, and Miscellaneous operations. It provides a straightforward integration for python developers.

Features

• Checkout: Collect payments easily with various options.
• Banking: Retrieve bank lists, perform name inquiries, and manage payouts.
• Identity Verification: Verify BVN, NIN, CAC, and more.
• Secure SDK: Handles multi-factor authentication, credential validation, and error handling.

---

Getting Started

1. Register on Flick: Sign up at Flick to obtain your API keys (secret_key and public_key).

2. Installation: Install the package via pip:

   pip install flick_paymentsdk
   

Initialization: Create an instance of the flick_payment class using your secret_key.

Usage Initialize the SDK

from flick_paymentsdk.sdk import flick_payment

# Replace with your actual secret key
secret_key = "your_secret_key"
flick_payment = flick_payment(secret_key)
Checkout
Initiate a checkout process:

checkout_payload = {
    "amount": "1000",
    "Phoneno": "1234567890",
    "currency_collected": "NGN",
    "currency_settled": "USD",
    "email": "[e-mail]",
    "redirectUrl": "https://example.com/redirect",
    "webhookUrl": "https://example.com/webhook",
}
response = flick_payment.flickCheckOut(checkout_payload)
print(response)
Bank List Retrieval
Retrieve a list of supported banks:

response = flick_payment.flickBankListSdk()
print(response)
Bank Name Inquiry
Perform a bank name inquiry:

bank_name_payload = {
    "account_number": "1234567890",
    "bank_code": "001"
}
response = flick_payment.flickBankNameInquirySdk(bank_name_payload)
print(response)

Payout Initialization Initiate a payout:

payout_payload = {
    "bank_name": "Example Bank",
    "bank_code": "012",
    "account_number": "1234567890",
    "amount": "1000",
    "narration": "Payment for services",
    "currency": "NGN",
    "beneficiary_name": "John Doe",
}
response = flick_payment.flickInitiatePayoutSdk(payout_payload)
print(response)

Payout Verification Verify a payout:

transaction_id = "1234567890"
response = flick_payment.flickVerifyPayoutSdk(transaction_id)
print(response)

Identity Verification Perform various identity verifications:

# BVN Verification
response = flick_payment.flickIdentityBvnSdk({"bvn": "12345678901"})
print(response)

# NIN Verification
response = flick_payment.flickIdentityNinSdk({"nin": "12345678901"})
print(response)

# CAC Verification (Basic)
response = flick_payment.flickIdentityCacBasicSdk({"rc_number": "123456"})
print(response)

# Best Practices
Always handle exceptions raised by API calls.
Store your secret_key securely to prevent unauthorized access.
# Support
If you need help with flick_paymentSDK or your Flick integration, reach out to [e-mail] or join our Slack channel.

License
This project is licensed under the MIT License.