/python-sdk

An SDK implementation in Python for the v3 REST APIs.

Primary LanguagePythonMIT LicenseMIT

https://travis-ci.org/hyperwallet/python-sdk.svg?branch=master

target:https://travis-ci.org/hyperwallet/python-sdk/builds

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 (Beta)

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

Prerequisites

Hyperwallet's Python server SDK requires at minimum Python 2.7 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"
}

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