# 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](https://login.merchant.getflick.co/getstarted) to obtain your API keys (`secret_key` and `public_key`).
2. **Installation:**
Install the package via `pip`:
```bash
pip install flick_paymentsdk
```
Initialization: Create an instance of the flick_payment class using your secret_key.
Usage
Initialize the SDK
```python
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:
```
```python
checkout_payload = {
"amount": "1000",
"Phoneno": "1234567890",
"currency_collected": "NGN",
"currency_settled": "USD",
"email": "example@example.com",
"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:
```
```python
response = flick_payment.flickBankListSdk()
print(response)
Bank Name Inquiry
Perform a bank name inquiry:
```
```python
bank_name_payload = {
"account_number": "1234567890",
"bank_code": "001"
}
response = flick_payment.flickBankNameInquirySdk(bank_name_payload)
print(response)
```
Payout Initialization
Initiate a payout:
```python
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:
```python
transaction_id = "1234567890"
response = flick_payment.flickVerifyPayoutSdk(transaction_id)
print(response)
```
Identity Verification
Perform various identity verifications:
```python
# 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 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": "testing-sdk",
"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/ad/a3/c7f1015da6e59bbecea681daa6357ba38dc2d08abb134dd6e97ef747dd9b/testing_sdk-0.0.4.tar.gz",
"platform": null,
"description": "# flick_paymentSDK 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://login.merchant.getflick.co/getstarted) 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 flick_paymentsdk\n ```\n\nInitialization: Create an instance of the flick_payment class using your secret_key.\n\nUsage\nInitialize the SDK\n\n```python\n\nfrom flick_paymentsdk.sdk import flick_payment\n\n# Replace with your actual secret key\nsecret_key = \"your_secret_key\"\nflick_payment = flick_payment(secret_key)\nCheckout\nInitiate a checkout process:\n```\n\n```python\n\ncheckout_payload = {\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}\nresponse = flick_payment.flickCheckOut(checkout_payload)\nprint(response)\nBank List Retrieval\nRetrieve a list of supported banks:\n```\n\n```python\n\nresponse = flick_payment.flickBankListSdk()\nprint(response)\nBank Name Inquiry\nPerform a bank name inquiry:\n```\n\n```python\n\nbank_name_payload = {\n \"account_number\": \"1234567890\",\n \"bank_code\": \"001\"\n}\nresponse = flick_payment.flickBankNameInquirySdk(bank_name_payload)\nprint(response)\n```\n\nPayout Initialization\nInitiate a payout:\n\n```python\n\npayout_payload = {\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 = flick_payment.flickInitiatePayoutSdk(payout_payload)\nprint(response)\n```\n\nPayout Verification\nVerify a payout:\n\n```python\n\ntransaction_id = \"1234567890\"\nresponse = flick_payment.flickVerifyPayoutSdk(transaction_id)\nprint(response)\n```\n\nIdentity Verification\nPerform various identity verifications:\n\n```python\n\n# BVN Verification\nresponse = flick_payment.flickIdentityBvnSdk({\"bvn\": \"12345678901\"})\nprint(response)\n\n# NIN Verification\nresponse = flick_payment.flickIdentityNinSdk({\"nin\": \"12345678901\"})\nprint(response)\n\n# CAC Verification (Basic)\nresponse = flick_payment.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": "0.0.4",
"project_urls": {
"Homepage": "https://merchant.getflick.co/"
},
"split_keywords": [
"flickpaysdk",
" card",
" bank",
" transfer",
" payout",
" inflow",
" outflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20a62c7dbd94cde3d1eec24914354bc71f97148f63098ab7d00377fa99da5a3e",
"md5": "e9fccf522065fb16bb2b1955d7c26830",
"sha256": "3e6017a481f7d0115b95341a06f47cf258911fecaff76fab9ea6b74c2923346e"
},
"downloads": -1,
"filename": "testing_sdk-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9fccf522065fb16bb2b1955d7c26830",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4202,
"upload_time": "2024-11-28T08:59:38",
"upload_time_iso_8601": "2024-11-28T08:59:38.665680Z",
"url": "https://files.pythonhosted.org/packages/20/a6/2c7dbd94cde3d1eec24914354bc71f97148f63098ab7d00377fa99da5a3e/testing_sdk-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ada3c7f1015da6e59bbecea681daa6357ba38dc2d08abb134dd6e97ef747dd9b",
"md5": "028df7ee79b94fa33040383d67d59857",
"sha256": "7d442fd028b621bcb950e5c8fa891ba92607d634925e6c45fb4b5b895f050ae9"
},
"downloads": -1,
"filename": "testing_sdk-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "028df7ee79b94fa33040383d67d59857",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3911,
"upload_time": "2024-11-28T08:59:41",
"upload_time_iso_8601": "2024-11-28T08:59:41.338096Z",
"url": "https://files.pythonhosted.org/packages/ad/a3/c7f1015da6e59bbecea681daa6357ba38dc2d08abb134dd6e97ef747dd9b/testing_sdk-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-28 08:59:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "testing-sdk"
}
JSON