Skip to main content
https://travis-ci.org/hyperwallet/python-sdk.svg?branch=master https://coveralls.io/repos/github/hyperwallet/python-sdk/badge.svg?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

$ 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.

  • Import the Hyperwallet module

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

api = hyperwallet.Api(
    "test-user",
    "test-pass",
    "prg-12345"
)
  • Start making API calls (e.g. create a user)

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:

$ virtualenv venv
$ source venv/bin/activate

Install development dependencies:

$ make dev

Run the tests:

$ make test

Compile the documentation:

$ make docs

Requirements

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

Reference

REST API Reference

License

MIT

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

Release files for hyperwallet-sdk 1.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hyperwallet-sdk 1.7.2
File Size Uploaded
hyperwallet-sdk-1.7.2.tar.gz 31.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hyperwallet-sdk 1.7.2
File Interpreter ABI Platform
hyperwallet_sdk-1.7.2-py3-none-any.whl Python 3 none any Details

Total release size: 64.4 kB

Release files / hyperwallet-sdk-1.7.2.tar.gz

Download URL hyperwallet-sdk-1.7.2.tar.gz
Size 31.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5ef3dbb7ddea7edc819a8ca599f6b8d71225dd1584bd4eda7a1a187e88e528da
BLAKE2b-256 checksum
How to use checksums
ec0cbd863b957869f0bc0e3e1966e9e0eea08d7a4641f4bc45b85bed75356e0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Release files / hyperwallet_sdk-1.7.2-py3-none-any.whl

Download URL hyperwallet_sdk-1.7.2-py3-none-any.whl
Size 32.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ada73d2e7b4a2728e2e26ca550a0fdeb27fa525bc528803a04e36e9199fc5e0c
BLAKE2b-256 checksum
How to use checksums
a41c46fd500b4732e1c7b11cb1e503fb1799881868f55e41be0362b8f9d033ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Release history Release notifications | RSS feed

This release

1.7.2 This release

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.1

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

1 release file

1.1.4

1 release file

1.1.1

1 release file

1.0.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page