modulepackage
0.0.0-20200915172025-2ac5c5135d16
Repository: https://github.com/kthomas/uphold-sdk-golang.git
Documentation: pkg.go.dev
# README
Uphold Golang SDK
This repository contains a Golang implementation of the Uphold API (see https://uphold.com/en/developer/api/documentation).
The package is not yet feature complete. A list of supported APIs will be documented here.
Installation
go get github.com/kthomas/uphold-sdk-golang
Ideally, you should use a package manager such as glide, in which case you can run glide get github.com/kthomas/uphold-sdk-golang.
Supported APIs
The following Uphold APIs are currently supported by this package:
Applications
Not yet supported.
Authentication
Webapp Authorization
Documentation forthcoming.
Client Credentials
Documentation forthcoming.
One-Time Password
Not yet supported.
Currencies
Not yet supported.
Tickers
Not yet supported.
Entities
Not yet supported.
Accounts
Not yet supported.
Cards
Not yet supported.
Transactions
Not yet supported.
Contacts
Not yet supported.
Users
Not yet supported.
Transparency
Not yet supported.
# Functions
AddPhone adds a phone to an uphold account.
AuthorizeBearerToken synchronously authorizes a managed uphold API user using the environment-configured client id/secret and the given authorization code; note that it is the responsibility of the calling package to verify the provided state parameter, which should be a cryptographically secure random string used to protect against cross-site request forgery attacks.
AuthorizeClientCredentials synchronously authorizes an uphold API user using the environment-configured client id and secret.
CommitTransaction commits a previously quoted transaction.
CreateDocument upserts a document on behalf of an uphold account holder.
CreateTransaction submits a transaction to the Uphold platform but does not commit it for settlement.
CreateUser creates a new Uphold user.
GetUser fetches the user for the given bearer token.
NewUnauthorizedAPIClient initializes an APIClient without API credentials.
NewUpholdAPIClient initializes an APIClient using the environment-configured client id and secret to construct an HTTP basic authorization header, unless a non-nil bearer access token is provided.
WebAuthorizationAllScopesURL returns the webapp authorization URL requesting all supported scopes.
WebAuthorizationURL returns the webapp authorization URL for the given scope.
# Structs
APIClient is a generic base class for calling the uphold API.
Denomination describes the value being transacted, in terms of a specific currency.
Destination contains properites regarding how the transaction affects the destination of the funds.
Fee describes an applied transaction fee.
Normalized tx property contains the normalized amount and commission values in USD.
OAuthResponse is the API response returned when an authorization code has been successfully upgraded to an access token.
Origin contains properties regarding how the transaction affects the origin of the funds.
Transaction represents an uphold card transaction.
User represents an uphold user.