.. image:: https://travis-ci.org/hyperwallet/python-sdk.svg?branch=master
:target: https://travis-ci.org/hyperwallet/python-sdk/builds
.. image:: https://coveralls.io/repos/github/hyperwallet/python-sdk/badge.svg?branch=master
:target: https://coveralls.io/github/hyperwallet/python-sdk?branch=master
====================
Hyperwallet REST SDK
====================
A library to manage users, transfer methods and payments through the Hyperwallet Rest V3 API
Prerequisites
-------------
Hyperwallet's Python server SDK requires at minimum Python 3.5 and above.
Installation
------------
.. code::
$ pip install hyperwallet-sdk
Documentation
-------------
Documentation is available at http://hyperwallet.github.io/python-sdk
API Overview
------------
To write an app using the SDK
* Register for a sandbox account and get your username, password and program
token at the `Hyperwallet Program Portal <https://portal.hyperwallet.com>`_.
* Import the Hyperwallet module
.. code::
import hyperwallet
* Create an instance of the Hyperwallet Client (with username, password and
program token)
.. code::
api = hyperwallet.Api(
"test-user",
"test-pass",
"prg-12345"
)
* Start making API calls (e.g. create a user)
.. code::
data = {
clientUserId: "test-client-id-1",
profileType: "INDIVIDUAL",
firstName: "Daffy",
lastName: "Duck",
email: "testmail-1@hyperwallet.com",
addressLine1: "123 Main Street",
city: "Austin",
stateProvince: "TX",
country: "US",
postalCode: "78701",
programToken: "[PROGRAM TOKEN]"
}
response = api.createUser(data)
Development
-----------
Set up a virtual environment:
.. code::
$ virtualenv venv
$ source venv/bin/activate
Install development dependencies:
.. code::
$ make dev
Run the tests:
.. code::
$ make test
Compile the documentation:
.. code::
$ make docs
Requirements
------------
The Hyperwallet API uses TLS 1.2. Please ensure that your SSL library
supports TLS 1.2.
Reference
---------
`REST API Reference <https://portal.hyperwallet.com/docs>`_
License
-------
`MIT <https://raw.githubusercontent.com/hyperwallet/python-sdk/master/LICENSE>`_
Changelog
=========
1.7.2
-------------------
- Added field 'accountId' to PayPal.
- PayPal account creation allowed using field 'accountId' which accepts Email, Phone Number, PayPal PayerID.
- Venmo account creation allowed using field 'accountId' which accepts Email, Phone Number, Venmo Handle, Venmo External ID.
1.7.1
-------------------
- Added attribute 'isDefaultTransferMethod' to identify default accounts.
1.7.0
-------------------
- Added missing webhook groups
- Added webhooks for Transfers
- Added taxVerificationStatus to User
- Added Document and RejectReason models
- Updated filters for list endpoints
1.6.0
-------------------
- Added custom headers
- Added filters
- Added status transitions for Transfers, TransferRefunds
1.5.1
-------------------
- Added field 'processingTime' to BankCards
- Added field 'expiresOn' to Payments
1.5.0
-------------------
- Added Venmo accounts
- Added User status transitions
- Added Transfer refunds
- Added upload multipart documents feature
1.4.0
-------------------
- Fix TypeError thrown when response status is 204 No content
- Fix tests for python 3
- Add updatePayPalAccount()
- Python uses os path join url causing issues on windows
- Add CVV field to the sdk
- Remove Relationship field from Server SDK
- Add Business Operating Name Field to User
- Add PayPal account status transitions
1.3.0 (2019-01-28)
-------------------
- Added field "VerificationStatus" to User
- Client-token endpoint renamed to authentication-token
1.2.1 (2019-01-17)
------------------
- FIX: Resolved issue with restricted "Accept" & "Content-Type" headers to support only "application/json" or "application/jose+json"
1.2.0 (2018-12-20)
------------------
- Restricted “Accept” & “Content-Type” headers to support only “application/json” or “application/jose+json”
- Related resources “relatedResources” in error representation is added
- Added Authentication token endpoint
1.1.4 (2018-12-04)
------------------
- Added PayPal account endpoint
1.1.3 (2018-07-05)
------------------
- Added transfer endpoint
1.1.2 (2018-03-20)
------------------
- Added bank card endpoint
1.1.1 (2017-10-11)
------------------
- Bumped version and first public release!
1.1.0 (2017-09-29)
------------------
- Completed coverage of all endpoints
- 100% code coverage
- Audited available attributes for each model
1.0.0 (2017-08-04)
------------------
- Added support for resource types as models
0.2.0 (2016-12-22)
------------------
- Added support for all API endpoints
- Created package structure for distribution on PyPi
- Added tests
0.1.0 (2016-09-06)
------------------
- Repository creation
- Added license
- Added readme
Raw data
{
"_id": null,
"home_page": "https://github.com/hyperwallet/python-sdk",
"name": "hyperwallet-sdk",
"maintainer": "The Hyperwallet Developers",
"docs_url": null,
"requires_python": "",
"maintainer_email": "devsupport@hyperwallet.com",
"keywords": "hyperwallet api",
"author": "The Hyperwallet Developers",
"author_email": "devsupport@hyperwallet.com",
"download_url": "https://files.pythonhosted.org/packages/ec/0c/bd863b957869f0bc0e3e1966e9e0eea08d7a4641f4bc45b85bed75356e0c/hyperwallet-sdk-1.7.2.tar.gz",
"platform": null,
"description": ".. image:: https://travis-ci.org/hyperwallet/python-sdk.svg?branch=master\n :target: https://travis-ci.org/hyperwallet/python-sdk/builds\n.. image:: https://coveralls.io/repos/github/hyperwallet/python-sdk/badge.svg?branch=master\n :target: https://coveralls.io/github/hyperwallet/python-sdk?branch=master\n\n====================\nHyperwallet REST SDK \n====================\n\nA library to manage users, transfer methods and payments through the Hyperwallet Rest V3 API\n\nPrerequisites\n-------------\n\nHyperwallet's Python server SDK requires at minimum Python 3.5 and above.\n\nInstallation\n------------\n\n.. code::\n\n $ pip install hyperwallet-sdk\n\nDocumentation\n-------------\n\nDocumentation is available at http://hyperwallet.github.io/python-sdk\n\nAPI Overview\n------------\n\nTo write an app using the SDK\n\n* Register for a sandbox account and get your username, password and program\n token at the `Hyperwallet Program Portal <https://portal.hyperwallet.com>`_.\n* Import the Hyperwallet module\n\n.. code::\n\n import hyperwallet\n\n* Create an instance of the Hyperwallet Client (with username, password and\n program token)\n\n.. code::\n\n api = hyperwallet.Api(\n \"test-user\",\n \"test-pass\",\n \"prg-12345\"\n )\n\n* Start making API calls (e.g. create a user)\n\n.. code::\n\n data = {\n clientUserId: \"test-client-id-1\",\n profileType: \"INDIVIDUAL\",\n firstName: \"Daffy\",\n lastName: \"Duck\",\n email: \"testmail-1@hyperwallet.com\",\n addressLine1: \"123 Main Street\",\n city: \"Austin\",\n stateProvince: \"TX\",\n country: \"US\",\n postalCode: \"78701\",\n programToken: \"[PROGRAM TOKEN]\"\n }\n\n response = api.createUser(data)\n\nDevelopment\n-----------\n\nSet up a virtual environment:\n\n.. code::\n\n $ virtualenv venv\n $ source venv/bin/activate\n\nInstall development dependencies:\n\n.. code::\n\n $ make dev\n\nRun the tests:\n\n.. code::\n\n $ make test\n\nCompile the documentation:\n\n.. code::\n\n $ make docs\n\nRequirements\n------------\n\nThe Hyperwallet API uses TLS 1.2. Please ensure that your SSL library\nsupports TLS 1.2.\n\nReference\n---------\n\n`REST API Reference <https://portal.hyperwallet.com/docs>`_\n\nLicense\n-------\n\n`MIT <https://raw.githubusercontent.com/hyperwallet/python-sdk/master/LICENSE>`_\n\n\nChangelog\n=========\n1.7.2\n-------------------\n- Added field 'accountId' to PayPal.\n- PayPal account creation allowed using field 'accountId' which accepts Email, Phone Number, PayPal PayerID.\n- Venmo account creation allowed using field 'accountId' which accepts Email, Phone Number, Venmo Handle, Venmo External ID.\n\n1.7.1\n-------------------\n- Added attribute 'isDefaultTransferMethod' to identify default accounts.\n\n1.7.0\n-------------------\n- Added missing webhook groups\n- Added webhooks for Transfers\n- Added taxVerificationStatus to User\n- Added Document and RejectReason models\n- Updated filters for list endpoints\n\n1.6.0\n-------------------\n- Added custom headers\n- Added filters\n- Added status transitions for Transfers, TransferRefunds\n\n1.5.1\n-------------------\n- Added field 'processingTime' to BankCards\n- Added field 'expiresOn' to Payments\n\n1.5.0\n-------------------\n- Added Venmo accounts\n- Added User status transitions\n- Added Transfer refunds\n- Added upload multipart documents feature\n\n1.4.0\n-------------------\n- Fix TypeError thrown when response status is 204 No content\n- Fix tests for python 3\n- Add updatePayPalAccount()\n- Python uses os path join url causing issues on windows\n- Add CVV field to the sdk\n- Remove Relationship field from Server SDK\n- Add Business Operating Name Field to User\n- Add PayPal account status transitions\n\n1.3.0 (2019-01-28)\n-------------------\n- Added field \"VerificationStatus\" to User\n- Client-token endpoint renamed to authentication-token\n\n1.2.1 (2019-01-17)\n------------------\n\n- FIX: Resolved issue with restricted \"Accept\" & \"Content-Type\" headers to support only \"application/json\" or \"application/jose+json\"\n\n1.2.0 (2018-12-20)\n------------------\n\n- Restricted \u201cAccept\u201d & \u201cContent-Type\u201d headers to support only \u201capplication/json\u201d or \u201capplication/jose+json\u201d\n- Related resources \u201crelatedResources\u201d in error representation is added\n- Added Authentication token endpoint\n\n1.1.4 (2018-12-04)\n------------------\n\n- Added PayPal account endpoint\n\n1.1.3 (2018-07-05)\n------------------\n\n- Added transfer endpoint\n\n1.1.2 (2018-03-20)\n------------------\n\n- Added bank card endpoint\n\n1.1.1 (2017-10-11)\n------------------\n\n- Bumped version and first public release!\n\n1.1.0 (2017-09-29)\n------------------\n\n- Completed coverage of all endpoints\n- 100% code coverage\n- Audited available attributes for each model\n\n1.0.0 (2017-08-04)\n------------------\n\n- Added support for resource types as models\n\n0.2.0 (2016-12-22)\n------------------\n\n- Added support for all API endpoints\n- Created package structure for distribution on PyPi\n- Added tests\n\n0.1.0 (2016-09-06)\n------------------\n\n- Repository creation\n- Added license\n- Added readme\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper around the Hyperwallet API",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://github.com/hyperwallet/python-sdk"
},
"split_keywords": [
"hyperwallet",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a41c46fd500b4732e1c7b11cb1e503fb1799881868f55e41be0362b8f9d033ee",
"md5": "fc251541cde8b2a1abbe9cd2f2639649",
"sha256": "ada73d2e7b4a2728e2e26ca550a0fdeb27fa525bc528803a04e36e9199fc5e0c"
},
"downloads": -1,
"filename": "hyperwallet_sdk-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc251541cde8b2a1abbe9cd2f2639649",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 32678,
"upload_time": "2023-08-09T23:53:25",
"upload_time_iso_8601": "2023-08-09T23:53:25.248373Z",
"url": "https://files.pythonhosted.org/packages/a4/1c/46fd500b4732e1c7b11cb1e503fb1799881868f55e41be0362b8f9d033ee/hyperwallet_sdk-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec0cbd863b957869f0bc0e3e1966e9e0eea08d7a4641f4bc45b85bed75356e0c",
"md5": "6682099d534976a967164f1f4f3219b6",
"sha256": "5ef3dbb7ddea7edc819a8ca599f6b8d71225dd1584bd4eda7a1a187e88e528da"
},
"downloads": -1,
"filename": "hyperwallet-sdk-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "6682099d534976a967164f1f4f3219b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31744,
"upload_time": "2023-08-09T23:53:28",
"upload_time_iso_8601": "2023-08-09T23:53:28.047726Z",
"url": "https://files.pythonhosted.org/packages/ec/0c/bd863b957869f0bc0e3e1966e9e0eea08d7a4641f4bc45b85bed75356e0c/hyperwallet-sdk-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-09 23:53:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hyperwallet",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "hyperwallet-sdk"
}
JSON
