grmeyer-hw-dev / python-sdk Goto Github PK

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 http://hyperwallet.github.io/python-sdk

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: "[email protected]",
    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

MIT