# Flick SDK For 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](https://merchant.getflick.co/) to obtain your API keys (`secret_key` and `public_key`).
2. **Installation:**
Install the package via `pip`:
```bash
pip install flickpaysdk
pip install dataclasses
pip install requests
```
## How to Use the Class
1. ### Initialize the SDK with your secret key:
Create an instance of the flick_payment class using your secret_key.
Usage
Initialize the SDK
```python
import requests
from flickpaysdk.flick import FlickpaySDK, checkOutRequest
# Replace with your actual secret key
sdk = FlickpaySDK(secret_key="your_secret_key")
```
2. ### For Checkout charge request
Initiate a checkout process:
```python
checkout_payload = checkOutRequest(
amount = "1000",
Phoneno = "1234567890",
currency_collected = "NGN",
currency_settled = "USD",
email = "example@example.com",
redirectUrl = "https://example.com/redirect",
webhookUrl = "https://example.com/webhook",
)
charge_response = sdk.flickCheckOut(checkout_payload)
print(charge_response)
```
3. ### Bank List Retrieval
Retrieve a list of supported banks:
```python
bank_list = sdk.flickBankListSdk()
print(bank_list)
```
4. ### Bank Name Inquiry
Perform a bank name inquiry:
```python
bank_name_payload = BankNameRequest(
account_number = "1234567890",
bank_code = "001"
)
response = sdk.flickBankNameInquiry(bank_name_payload)
print(response)
```
5. ### Payout Initialization
Initiate a payout:
```python
payout_payload = PayoutRequest(
bank_name = "Example Bank",
bank_code = "012",
account_number = "1234567890",
amount = "1000",
narration = "Payment for services",
currency = "NGN",
beneficiary_name = "John Doe",
)
response = sdk.flickInitiatePayoutSdk(payout_payload)
print(response)
```
Payout Verification
Verify a payout:
```python
transaction_id = "1234567890"
verify_payout_response = verify_payout_response = sdk.flickVerifyPayoutSdk(transaction_id)
print(verify_payout_response)
```
Identity Verification
Perform various identity verifications:
```python
# BVN Verification
bvn_payload = BvnRequest(
data_type = "basic",
data = "012"
)
response = sdk.flickIdentityBvnSdk(bvn_payload)
print(response)
bvn = "0000222211"
response = sdk.flickIdentityBvnSdk({"bvn": "12345678901"})
print(response)
# NIN Verification
response = sdk.flickIdentityNinSdk({"nin": "12345678901"})
print(response)
# CAC Verification (Basic)
response = sdk.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 support@getflick.app or join our Slack channel.
License
This project is licensed under the MIT License.
```
Raw data
{
"_id": null,
"home_page": "https://merchant.getflick.co/",
"name": "flickpaysdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "flickpaysdk, card, bank, transfer, payout, inflow, outflow",
"author": "Qraba inc",
"author_email": "kingsley@getflick.app",
"download_url": "https://files.pythonhosted.org/packages/77/a0/bb9f4f6cf6dca4a8d9611b12e3c0c5bda4e86d37ec0e016db6b421505b16/flickpaysdk-1.1.1.tar.gz",
"platform": null,
"description": "# Flick SDK For PYTHON\n\nflick_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.\n\n## Features\n\n- **Checkout:** Collect payments easily with various options.\n- **Banking:** Retrieve bank lists, perform name inquiries, and manage payouts.\n- **Identity Verification:** Verify BVN, NIN, CAC, and more.\n- **Secure SDK:** Handles multi_factor authentication, credential validation, and error handling.\n\n---\n\n## Getting Started\n\n1. **Register on Flick:**\n Sign up at [Flick](https://merchant.getflick.co/) to obtain your API keys (`secret_key` and `public_key`).\n\n2. **Installation:**\n Install the package via `pip`:\n\n ```bash\n pip install flickpaysdk\n pip install dataclasses \n pip install requests\n ```\n## How to Use the Class\n1. ### Initialize the SDK with your secret key:\nCreate an instance of the flick_payment class using your secret_key.\n\nUsage\nInitialize the SDK\n\n```python\nimport requests\nfrom flickpaysdk.flick import FlickpaySDK, checkOutRequest\n\n# Replace with your actual secret key\nsdk = FlickpaySDK(secret_key=\"your_secret_key\")\n```\n\n2. ### For Checkout charge request\nInitiate a checkout process:\n\n```python\n\ncheckout_payload = checkOutRequest(\n amount = \"1000\",\n Phoneno = \"1234567890\",\n currency_collected = \"NGN\",\n currency_settled = \"USD\",\n email = \"example@example.com\",\n redirectUrl = \"https://example.com/redirect\",\n webhookUrl = \"https://example.com/webhook\",\n)\ncharge_response = sdk.flickCheckOut(checkout_payload) \nprint(charge_response)\n```\n\n3. ### Bank List Retrieval\nRetrieve a list of supported banks:\n\n```python\n\nbank_list = sdk.flickBankListSdk()\nprint(bank_list)\n```\n\n4. ### Bank Name Inquiry\nPerform a bank name inquiry:\n\n\n```python\n\nbank_name_payload = BankNameRequest(\n account_number = \"1234567890\",\n bank_code = \"001\"\n)\nresponse = sdk.flickBankNameInquiry(bank_name_payload)\nprint(response)\n```\n\n5. ### Payout Initialization\nInitiate a payout:\n\n```python\n\npayout_payload = PayoutRequest(\n bank_name = \"Example Bank\",\n bank_code = \"012\",\n account_number = \"1234567890\",\n amount = \"1000\",\n narration = \"Payment for services\",\n currency = \"NGN\",\n beneficiary_name = \"John Doe\",\n)\nresponse = sdk.flickInitiatePayoutSdk(payout_payload)\nprint(response)\n```\n\nPayout Verification\nVerify a payout:\n\n```python\n\ntransaction_id = \"1234567890\"\nverify_payout_response = verify_payout_response = sdk.flickVerifyPayoutSdk(transaction_id)\nprint(verify_payout_response)\n```\n\nIdentity Verification\nPerform various identity verifications:\n\n```python\n\n# BVN Verification\n\nbvn_payload = BvnRequest(\n data_type = \"basic\",\n data = \"012\"\n)\nresponse = sdk.flickIdentityBvnSdk(bvn_payload)\nprint(response)\nbvn = \"0000222211\"\nresponse = sdk.flickIdentityBvnSdk({\"bvn\": \"12345678901\"})\nprint(response)\n\n# NIN Verification\nresponse = sdk.flickIdentityNinSdk({\"nin\": \"12345678901\"})\nprint(response)\n\n# CAC Verification (Basic)\nresponse = sdk.flickIdentityCacBasicSdk({\"rc_number\": \"123456\"})\nprint(response)\n\n# Best Practices\nAlways handle exceptions raised by API calls.\nStore your secret_key securely to prevent unauthorized access.\n# Support\nIf you need help with flick_paymentSDK or your Flick integration, reach out to support@getflick.app or join our Slack channel.\n\nLicense\nThis project is licensed under the MIT License.\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flick Python SDKs contains FlickPay inflow and outflow solutions",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://merchant.getflick.co/"
},
"split_keywords": [
"flickpaysdk",
" card",
" bank",
" transfer",
" payout",
" inflow",
" outflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2770695976ff9198b8dd6d58551a571d4728073b4f1b015ee2e46ae0f66dad74",
"md5": "37fe6d58f073501d66768a26a1448129",
"sha256": "3553e57f3de05c7a26e9594b64015b93745dcd3eb6c191a777c56dea3cd758a1"
},
"downloads": -1,
"filename": "flickpaysdk-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37fe6d58f073501d66768a26a1448129",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5956,
"upload_time": "2024-12-18T08:28:56",
"upload_time_iso_8601": "2024-12-18T08:28:56.271224Z",
"url": "https://files.pythonhosted.org/packages/27/70/695976ff9198b8dd6d58551a571d4728073b4f1b015ee2e46ae0f66dad74/flickpaysdk-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77a0bb9f4f6cf6dca4a8d9611b12e3c0c5bda4e86d37ec0e016db6b421505b16",
"md5": "27659de818f579ceb7588cb41868cbe2",
"sha256": "9203abf139ed18987867d8cadc58be8e43ea9d73844002292aa55872234bfb66"
},
"downloads": -1,
"filename": "flickpaysdk-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "27659de818f579ceb7588cb41868cbe2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5784,
"upload_time": "2024-12-18T08:29:00",
"upload_time_iso_8601": "2024-12-18T08:29:00.709329Z",
"url": "https://files.pythonhosted.org/packages/77/a0/bb9f4f6cf6dca4a8d9611b12e3c0c5bda4e86d37ec0e016db6b421505b16/flickpaysdk-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 08:29:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "flickpaysdk"
}
JSON