# 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": "flickpay",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "flickpaysdk, card, bank, transfer, payout, inflow, outflow",
"author": "Quraba inc",
"author_email": "kingsley@getflick.app",
"download_url": "https://files.pythonhosted.org/packages/e4/9d/5f4b62699de9d2dc838270b7cef29ba9a9c58a5834748db1128caa1cd329/flickpay-0.0.3.tar.gz",
"platform": null,
"description": "# flick_paymentSDK PYTHON\r\n\r\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.\r\n\r\n## Features\r\n\r\n- **Checkout:** Collect payments easily with various options.\r\n- **Banking:** Retrieve bank lists, perform name inquiries, and manage payouts.\r\n- **Identity Verification:** Verify BVN, NIN, CAC, and more.\r\n- **Secure SDK:** Handles multi-factor authentication, credential validation, and error handling.\r\n\r\n---\r\n\r\n## Getting Started\r\n\r\n1. **Register on Flick:**\r\n Sign up at [Flick](https://login.merchant.getflick.co/getstarted) to obtain your API keys (`secret_key` and `public_key`).\r\n\r\n2. **Installation:**\r\n Install the package via `pip`:\r\n\r\n ```bash\r\n pip install flick_paymentsdk\r\n ```\r\n\r\nInitialization: Create an instance of the flick_payment class using your secret_key.\r\n\r\nUsage\r\nInitialize the SDK\r\n\r\n```python\r\n\r\nfrom flick_paymentsdk.sdk import flick_payment\r\n\r\n# Replace with your actual secret key\r\nsecret_key = \"your_secret_key\"\r\nflick_payment = flick_payment(secret_key)\r\nCheckout\r\nInitiate a checkout process:\r\n```\r\n\r\n```python\r\n\r\ncheckout_payload = {\r\n \"amount\": \"1000\",\r\n \"Phoneno\": \"1234567890\",\r\n \"currency_collected\": \"NGN\",\r\n \"currency_settled\": \"USD\",\r\n \"email\": \"example@example.com\",\r\n \"redirectUrl\": \"https://example.com/redirect\",\r\n \"webhookUrl\": \"https://example.com/webhook\",\r\n}\r\nresponse = flick_payment.flickCheckOut(checkout_payload)\r\nprint(response)\r\nBank List Retrieval\r\nRetrieve a list of supported banks:\r\n```\r\n\r\n```python\r\n\r\nresponse = flick_payment.flickBankListSdk()\r\nprint(response)\r\nBank Name Inquiry\r\nPerform a bank name inquiry:\r\n```\r\n\r\n```python\r\n\r\nbank_name_payload = {\r\n \"account_number\": \"1234567890\",\r\n \"bank_code\": \"001\"\r\n}\r\nresponse = flick_payment.flickBankNameInquirySdk(bank_name_payload)\r\nprint(response)\r\n```\r\n\r\nPayout Initialization\r\nInitiate a payout:\r\n\r\n```python\r\n\r\npayout_payload = {\r\n \"bank_name\": \"Example Bank\",\r\n \"bank_code\": \"012\",\r\n \"account_number\": \"1234567890\",\r\n \"amount\": \"1000\",\r\n \"narration\": \"Payment for services\",\r\n \"currency\": \"NGN\",\r\n \"beneficiary_name\": \"John Doe\",\r\n}\r\nresponse = flick_payment.flickInitiatePayoutSdk(payout_payload)\r\nprint(response)\r\n```\r\n\r\nPayout Verification\r\nVerify a payout:\r\n\r\n```python\r\n\r\ntransaction_id = \"1234567890\"\r\nresponse = flick_payment.flickVerifyPayoutSdk(transaction_id)\r\nprint(response)\r\n```\r\n\r\nIdentity Verification\r\nPerform various identity verifications:\r\n\r\n```python\r\n\r\n# BVN Verification\r\nresponse = flick_payment.flickIdentityBvnSdk({\"bvn\": \"12345678901\"})\r\nprint(response)\r\n\r\n# NIN Verification\r\nresponse = flick_payment.flickIdentityNinSdk({\"nin\": \"12345678901\"})\r\nprint(response)\r\n\r\n# CAC Verification (Basic)\r\nresponse = flick_payment.flickIdentityCacBasicSdk({\"rc_number\": \"123456\"})\r\nprint(response)\r\n\r\n# Best Practices\r\nAlways handle exceptions raised by API calls.\r\nStore your secret_key securely to prevent unauthorized access.\r\n# Support\r\nIf you need help with flick_paymentSDK or your Flick integration, reach out to support@getflick.app or join our Slack channel.\r\n\r\nLicense\r\nThis project is licensed under the MIT License.\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flick Python SDKs contains FlickPay inflow and outflow solutions",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://merchant.getflick.co/"
},
"split_keywords": [
"flickpaysdk",
" card",
" bank",
" transfer",
" payout",
" inflow",
" outflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb9fc49c241d6c6728fb4e323588b52beb9244094a15b170392eeeb830bf8933",
"md5": "9fde1fc69301c4c413025ef1bb45ade1",
"sha256": "d0260122d5dcfd42012d3efc8ed231c0e6a528c324581da5b2292812817b9cb2"
},
"downloads": -1,
"filename": "flickpay-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fde1fc69301c4c413025ef1bb45ade1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3232,
"upload_time": "2024-11-25T12:17:40",
"upload_time_iso_8601": "2024-11-25T12:17:40.358282Z",
"url": "https://files.pythonhosted.org/packages/bb/9f/c49c241d6c6728fb4e323588b52beb9244094a15b170392eeeb830bf8933/flickpay-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e49d5f4b62699de9d2dc838270b7cef29ba9a9c58a5834748db1128caa1cd329",
"md5": "4ddbfe6c4289ba55e213d4df453afd2b",
"sha256": "36eb33c7816cdfe23de21a13c4402eb3966bbc0c86769eb8c64e66f66ea7b6a7"
},
"downloads": -1,
"filename": "flickpay-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "4ddbfe6c4289ba55e213d4df453afd2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6840,
"upload_time": "2024-11-25T12:17:41",
"upload_time_iso_8601": "2024-11-25T12:17:41.400363Z",
"url": "https://files.pythonhosted.org/packages/e4/9d/5f4b62699de9d2dc838270b7cef29ba9a9c58a5834748db1128caa1cd329/flickpay-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 12:17:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "flickpay"
}
JSON