{
    "info": {
        "author": "FraudLabs Pro",
        "author_email": "support@fraudlabspro.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "# FraudLabs Pro Python SDK\n\nThis Python module enables user to easily implement fraud detection feature into their solution using the API from https://www.fraudlabspro.com.\n\n\n\nBelow are the features of this Python module:\n\n* Fraud analysis and scoring\n* Credit card issuing bank validation\n* SMS verification and validation\n\nThis module requires API key to function. You may subscribe a free API key at https://www.fraudlabspro.com\n\n\n\n\n\n## Usage Example\n\n### Validate Order\n\n#### Object Properties\n\n\n\n| Property Name        | Property Type | Description                                                  |\n| -------------------- | ------------- | ------------------------------------------------------------ |\n| ip                   | string        | IP address of online transaction. It supports both IPv4 and IPv6 address format. |\n| billing->firstName   | string        | User's first name.                                           |\n| billing->lastName    | string        | User's last name.                                            |\n| billing->username    | string        | User's username.                                             |\n| billing->password    | string        | User's password.                                             |\n| billing->email       | string        | User's email address.                                        |\n| billing->phone       | string        | User's phone number.                                         |\n| billing->address     | string        | Street address of billing address.                           |\n| billing->city        | string        | City of billing address.                                     |\n| billing->state       | string        | State of billing address. It supports state codes, e.g. NY (New York), for state or province of United States or Canada. Please refer to [State & Province Codes](https://www.fraudlabspro.com/developer/reference/state-and-province-codes) for complete list. |\n| billing->postcode    | string        | Postal or ZIP code of billing address.                       |\n| billing->country     | string        | Country of billing address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to [Country Codes](https://www.fraudlabspro.com/developer/reference/country-codes) for complete list. |\n| order->orderId       | string        | Merchant identifier to uniquely identify a transaction. It supports maximum of 15 characters user order id input. |\n| order->note          | string        | Merchant description of an order transaction. It supports maximum of 200 characters. |\n| order->amount        | float         | Amount of the transaction.                                   |\n| order->quantity      | integer       | Total quantity of the transaction.                           |\n| order->currency      | string        | Currency code used in the transaction. It requires the input of ISO-4217 (3 characters) currency code, e.g. USD for US Dollar. Please refer to [Currency Codes](https://www.fraudlabspro.com/developer/reference/currency-codes) for complete list. |\n| order->department    | string        | Merchant identifier to uniquely identify a product or service department. |\n| order->paymentMethod | string        | Payment mode of transaction. Please see references section.  |\n| card->number         | string        | Billing credit card number or BIN number.                    |\n| card->avs            | string        | The single character AVS result returned by the credit card processor. Please refer to [AVS & CVV2 Response Codes](https://www.fraudlabspro.com/developer/reference/avs-and-cvv2-response-codes) for details. |\n| card->cvv            | string        | The single character CVV2 result returned by the credit card processor. Please refer to [AVS & CVV2 Response Codes](https://www.fraudlabspro.com/developer/reference/avs-and-cvv2-response-codes) for details. |\n| shipping->address    | string        | Street address of shipping address.                          |\n| shipping->city       | string        | City of shipping address.                                    |\n| shipping->state      | string        | State of shipping address. It supports state codes, e.g. NY - New York, for state or province of United States or Canada. Please refer to [State & Province Codes](https://www.fraudlabspro.com/developer/reference/state-and-province-codes) for complete list. |\n| shipping->postcode   | string        | Postal or ZIP code of shipping address.                      |\n| shipping->country    | string        | Country of shipping address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to [Country Codes](https://www.fraudlabspro.com/developer/reference/country-codes) for complete list. |\n\n\n\n```python\n # import SDK to use the function\nfrom libs.order import Order\n\n # Configure your API key\napi_key = 'YOUR_API_KEY'\n\n # Order Details\ndict1 = {\n\t'key': api_key,\n\t'ip': '146.112.62.105',\n\t'order': {\n\t\t'order_id': '67398', \n\t\t'currency': 'USD',\n\t\t'amount': '42',\n\t\t'quantity': 1, \n\t\t'paymentMethod': 'creditcard'\n\t},\n\t'card': {\n\t\t'number': '4556553172971283'\n\t},\n\t'billing': {\n\t\t'firstName': 'Hector',\n\t\t'lastName': 'Henderson',\n\t\t'email': 'hh5566@gmail.com',\n\t\t'phone': '561-628-8674',\n\t\t'address': '1766 Powder House Road',\n\t\t'city': 'West Palm Beach',\n\t\t'state': 'FL',\n\t\t'postcode': '33401',\n\t\t'country': 'US',\n\t},\n\t'shipping': {\n\t\t'address': '4469 Chestnut Street',\n\t\t'city'   : 'Tampa',\n\t\t'state'  : 'FL',\n\t\t'postcode': '33602',\n\t\t'country': 'US',\n\t}\n}\n\n # Sends the order details to FraudLabs Pro\nresult = Order.validate(dict1)\n```\n\n\n\n### Get Transaction\n\n#### Parameter Properties\n\n| Parameter Name | Parameter Type | Description                                                  |\n| -------------- | -------------- | ------------------------------------------------------------ |\n| $id            | string         | FraudLabs Pro transaction ID or Order ID.                    |\n| $type          | string         | ID type. Either: **FraudLabsPrp::FLP_ID** or **FraudLabsPro::ORDER_ID** |\n\n```python\n # import SDK to use the function\nfrom libs.order import Order\n\n # Configure your API key\napi_key = 'YOUR_API_KEY'\n\n # Values to get transaction details\nget_transaction_variables = {\n\t'key': api_key,\n\t'id': '20180705-WISXW2',\n\t'id_type': 'FraudLabsPro::FLP_ID'\n}\n\n # Send the values to FraudLabs Pro\nresult = Order.get_transaction(get_transaction_variables)\n```\n\n\n\n### Feedback\n\n#### Object Properties\n\n| Property Name | Property Type | Description                                                  |\n| ------------- | ------------- | ------------------------------------------------------------ |\n| id            | string        | Unique transaction ID generated from **Validate** function.  |\n| status        | string        | Perform APPROVE, REJECT, or REJECT_BLACKLIST action to transaction.\tRefer to [reference section](#feedback-status) for status code. |\n| note          | string        | Notes for the feedback request.                              |\n\n```python\n # import SDK to use the function\nfrom libs.order import Order\n\n # Configure your API key\napi_key = 'YOUR_API_KEY'\n\n # Set feedback of the particular order\nfeedback_variables = {\n\t'key': api_key,\n\t'id': '20180705-WISXW2',\n\t# Three actions available: APPROVE, REJECT, REJECT_BLACKLIST\n\t'action': 'APPROVE',\n\t'notes': 'This is for testing purpose.',\n}\n\nOrder.feedback(feedback_variables)\n```\n\n\n\n## SMS Verification\n\n### Send SMS Verification\n\n#### Object Properties\n\n| Property Name | Property Type | Description                                                  |\n| ------------- | :-----------: | ------------------------------------------------------------ |\n| tel           |    string     | The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses. |\n| mesg          |    string     | The message template for the SMS. Add <otp> as placeholder for the actual OTP to be generated. Max length is 140 characters. |\n| country_code  |    string     | ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done. |\n\n```python\n # import SDK to use the function\nfrom libs.smsverification import SMSVerification\n\n # Configure your API key\napi_key = 'YOUR_API_KEY'\n\n # Send SMS verification\nsms_verification_variables = {\n\t'key': api_key,\n\t'tel': '+15616288674',\n\t'country_code': 'US',\n\t'mesg': 'Your OTP for the transaction is <otp>.',\n}\nresult = SMSVerification.send_sms(sms_verification_variables)\n```\n\n\n\n### Get SMS Verification Result\n\n#### Object Properties\n\n| Property Name | Property Type | Description                                                  |\n| ------------- | :-----------: | ------------------------------------------------------------ |\n| tran_id       |    string     | The unique ID that was returned by the Send SMS Verification that triggered the OTP sms. |\n| otp           |    string     | The OTP that was sent to the recipient\u00e2\u20ac\u2122s phone.              |\n\n```python\n # import SDK to use the function\nfrom libs.smsverification import SMSVerification\n\n # Configure your API key\napi_key = 'YOUR_API_KEY'\n\n # Get SMS verification result\nverify_sms_variables = {\n\t'key': api_key,\n\t'tran_id': 'UNIQUE_TRANS_ID',\n\t'otp': 'OTP_RECEIVED',\n}\nresult = SMSVerification.verify_sms(verify_sms_variables)\n```\n\n\n\n# Reference\n\n#### Payment Method\n\n| Payment Method |\n| -------------- |\n| creditcard     |\n| paypal         |\n| googlecheckout |\n| bitcoin        |\n| cod            |\n| moneyorder     |\n| wired          |\n| bankdeposit    |\n| others         |\n\n\n\nLICENCE\n=====================\nSee the LICENSE file.\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://www.fraudlabspro.com",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "fraudlabspro-python",
        "package_url": "https://pypi.org/project/fraudlabspro-python/",
        "platform": "",
        "project_url": "https://pypi.org/project/fraudlabspro-python/",
        "project_urls": {
            "Homepage": "https://www.fraudlabspro.com"
        },
        "release_url": "https://pypi.org/project/fraudlabspro-python/1.0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A Python module enables user to easily implement fraud detection feature into their solution using the API from https://www.fraudlabspro.com.",
        "version": "1.0.1"
    },
    "last_serial": 4042792,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "46b88118b0f8726f009405dcb91ad07e",
                    "sha256": "b2efc92ab51542e6544c84dac0552cc558a8d85ae64860f215e26446e5504c66"
                },
                "downloads": -1,
                "filename": "fraudlabspro_python-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "46b88118b0f8726f009405dcb91ad07e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 7642,
                "upload_time": "2018-07-09T01:46:04",
                "url": "https://files.pythonhosted.org/packages/31/b2/f3358a164c68e08f81f6230f0f56afa3ab96e03b68fa69e5b7f030d62abd/fraudlabspro_python-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "24a6b7a4d5e5da91ffd39339c9eb8958",
                    "sha256": "48f998194e735a8b6140de5a40aeed5326b98508943729b7f3cabc98e940c272"
                },
                "downloads": -1,
                "filename": "fraudlabspro-python-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "24a6b7a4d5e5da91ffd39339c9eb8958",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6431,
                "upload_time": "2018-07-09T01:46:05",
                "url": "https://files.pythonhosted.org/packages/ca/52/473c18e9f5417f2975f72eb8551c753d8e9016d41a8a3ee0c6da1631736b/fraudlabspro-python-1.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2c3d77e853847b5842a5cb24eef9e9d0",
                    "sha256": "eccbb7c91a4e35451e10820e15297931a82b0880baa4465a62649ffb7d145618"
                },
                "downloads": -1,
                "filename": "fraudlabspro_python-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2c3d77e853847b5842a5cb24eef9e9d0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 7627,
                "upload_time": "2018-07-09T08:09:17",
                "url": "https://files.pythonhosted.org/packages/da/9f/907e9e679536f65212fa6539e130c91e90a780ede281523afc68e645ff7a/fraudlabspro_python-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d47386a817e09a3fb26fe0c907bf0712",
                    "sha256": "28f1e5256e9a8fe787ba8eb92168d84c155c91cc0eecf1352c0b90a81e7ed777"
                },
                "downloads": -1,
                "filename": "fraudlabspro-python-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d47386a817e09a3fb26fe0c907bf0712",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6408,
                "upload_time": "2018-07-09T08:09:18",
                "url": "https://files.pythonhosted.org/packages/25/58/e5b4d742a140ef79c1352c54327b51313af83985c3e8e10875503c0fa1e5/fraudlabspro-python-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2c3d77e853847b5842a5cb24eef9e9d0",
                "sha256": "eccbb7c91a4e35451e10820e15297931a82b0880baa4465a62649ffb7d145618"
            },
            "downloads": -1,
            "filename": "fraudlabspro_python-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2c3d77e853847b5842a5cb24eef9e9d0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7627,
            "upload_time": "2018-07-09T08:09:17",
            "url": "https://files.pythonhosted.org/packages/da/9f/907e9e679536f65212fa6539e130c91e90a780ede281523afc68e645ff7a/fraudlabspro_python-1.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d47386a817e09a3fb26fe0c907bf0712",
                "sha256": "28f1e5256e9a8fe787ba8eb92168d84c155c91cc0eecf1352c0b90a81e7ed777"
            },
            "downloads": -1,
            "filename": "fraudlabspro-python-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d47386a817e09a3fb26fe0c907bf0712",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6408,
            "upload_time": "2018-07-09T08:09:18",
            "url": "https://files.pythonhosted.org/packages/25/58/e5b4d742a140ef79c1352c54327b51313af83985c3e8e10875503c0fa1e5/fraudlabspro-python-1.0.1.tar.gz"
        }
    ]
}