Skip to main content

A Python wrapper around the Hyperwallet API

Project description

Hyperwallet REST SDK (Beta)

A library to manage users, transfer methods and payments through the Hyperwallet Rest V3 API


Hyperwallet’s Python server SDK requires at minimum Python 3.5 and above.


$ pip install hyperwallet-sdk


Documentation is available at

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.

  • Import the Hyperwallet module

import hyperwallet
  • Create an instance of the Hyperwallet Client (with username, password and program token)

api = hyperwallet.Api(
  • Start making API calls (e.g. create a user)

data = {
    clientUserId: "test-client-id-1",
    profileType: "INDIVIDUAL",
    firstName: "Daffy",
    lastName: "Duck",
    email: "",
    addressLine1: "123 Main Street",
    city: "Austin",
    stateProvince: "TX",
    country: "US",
    postalCode: "78701",
    programToken: "[PROGRAM TOKEN]"

response = api.createUser(data)


Set up a virtual environment:

$ virtualenv venv
$ source venv/bin/activate

Install development dependencies:

$ make dev

Run the tests:

$ make test

Compile the documentation:

$ make docs


The Hyperwallet API uses TLS 1.2. Please ensure that your SSL library supports TLS 1.2.


REST API Reference





  • Added missing webhook groups

  • Added webhooks for Transfers

  • Added taxVerificationStatus to User

  • Added Document and RejectReason models

  • Updated filters for list endpoints


  • Added custom headers

  • Added filters

  • Added status transitions for Transfers, TransferRefunds


  • Added field ‘processingTime’ to BankCards

  • Added field ‘expiresOn’ to Payments


  • Added Venmo accounts

  • Added User status transitions

  • Added Transfer refunds

  • Added upload multipart documents feature


  • 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hyperwallet-sdk-1.7.0.tar.gz (31.3 kB view hashes)

Uploaded source

Built Distribution

hyperwallet_sdk-1.7.0-py3-none-any.whl (32.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page