Skip to main content

rightfoot

Rightfoot’s API generates student debt beneficiary accounts and transfers funds to their loans.

API Documentation

This repository provides Python bindings for Rightfoot’s API.

Installation

Install Rightfoot from PyPi with pip

pip install rightfoot

Getting Started

First create a client at the desired endpoint along with your credentials.

import rightfoot

configuration = rightfoot.Configuration()
# Defaults to sandbox, but can be explicitly set to sandbox/production.
configuration.host="https://sandbox.api.rightfoot.com/v1"
configuration.api_key['Authorization'] = os.env['RIGHTFOOT_API_KEY']
configuration.api_key_prefix['Authorization'] = 'Bearer'
rightfoot_client = rightfoot.RightfootApi(rightfoot.ApiClient(configuration))

Then a request to create a beneficiary can be made.

import rightfoot
from rightfoot.rest import ApiException

mailing_address = rightfoot.models.MailingAddress(
    line1="123 Easy Street", city="Palo Alto", state="CA", zip_code="12345-0123")
request = rightfoot.CreateBeneficiaryRequest(
    first_name="John", last_name="Doe", date_of_birth="1970-01-01",
    phone_number="+1 650 555 5555", mailing_address=mailing_address)

try:
    response = rightfoot_client.create_beneficiary(request)
    print(response)
except ApiException as e:
    print("Exception when calling RightfootApi->create_beneficiary: %s\n" % e)

Notes on API Client Source

Rightfoot uses swagger-codegen to create and maintain its SDKs whenever possible. Requests for modifications are accepted but required departing from the Swagger/OpenAPI templates for SDKs, which we try to avoid as much as possible in the interest of stability and ability to leverage improvements and security patches from those base templates as much as possible.

License

The MIT License (MIT)

Copyright (c) 2020 Charitize, Inc (“Rightfoot”)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for rightfoot 1.3.4

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

Built distribution (wheel)

Table of built distributions (wheels) for rightfoot 1.3.4
File Interpreter ABI Platform Actions
rightfoot-1.3.4-py3-none-any.whl Python 3 none any Details for rightfoot-1.3.4-py3-none-any.whl

Release files / rightfoot-1.3.4-py3-none-any.whl

Download URL rightfoot-1.3.4-py3-none-any.whl
Size 709.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ae3632b568f601ed6b1694b53efd5b4476c5bc1823eb6399fbb08d2f6e281b3
BLAKE2b-256 checksum
How to use checksums
7d5dcd38ffd223024722dac79fcfe509de11ed32486a64cd68cf034542e53fa0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.8.3 requests/2.27.1 setuptools/65.5.0 requests-toolbelt/0.10.0 tqdm/4.64.1 CPython/3.9.7

Security for rightfoot 1.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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