RizeFinance / rize-go-sdk

Go SDK for consuming the Rize Platform API's

Rize Go SDK

Rize makes financial services simple and accessible by enabling fintechs, financial institutions and brands to build across multiple account types with one API. The Rize Go SDK enables access to all platform services in our sandbox, integration and production environments.

When you're ready to build, open a sandbox environment. If you have questions, feedback, or a use case you want to discuss with us, contact us at [e-mail].

For more information, check out our Platform API Documentation.

See the Examples ReadMe for a full walk-through of Customer Onboarding.

Supported Go Versions

The Rize Go SDK is compatible with the two most recent, major Go releases.

We currently support Go v1.18 and higher.

Getting Started

Installation

To install the latest Rize Go SDK, add the module as a dependency using go mod:

go get github.com/rizefinance/rize-go-sdk@latest

To install a specific release version:

go get github.com/rizefinance/rize-go-sdk@v1.0.0

Configuration

The SDK requires program configuration credentials in order to interact with the API.

You can find these in the Rize Admin Portal.

Parameter	Description	Default
HMACKey	HMAC key for the target environment	""
ProgramUID	Program UID for the target environment	""
Environment	The Rize environment to be used: "sandbox", "integration" or "production"	"sandbox"
Debug	Enable debug logging	false

Import the SDK

Import the SDK module into your code:

import "github.com/rizefinance/rize-go-sdk"

Start Making API Calls

import "github.com/rizefinance/rize-go-sdk"

func main() {
	config := rize.Config{
		HMACKey:     hmac,
		ProgramUID:  programUID,
		Environment: environment,
		Debug:       false,
	}
	rc, err := rize.NewClient(&config)
	if err != nil {
		log.Fatal("Error building RizeClient\n", err)
	}
	
	// Create a new Compliance Workflow
	wcp := rize.WorkflowCreateParams{
		CustomerUID:              "h9MzupcjtA3LPW2e",
		ProductCompliancePlanUID: "25NQX3GGXpAtpUmP",
	}
	c, err := rc.ComplianceWorkflows.Create(context.Background(), &wcp)
	if err != nil {
		log.Fatal("Error creating new Compliance Workflow\n", err)
	}
}

Configure http.Client

You have the option to supply your own http.Client. By default, the SDK uses DefaultClient with a 30s timeout.

To set a proxy for all requests, configure the Transport for the http.Client:

config := rize.Config{
	HMACKey:     hmac,
	ProgramUID:  programUID,
	Environment: environment,
	HTTPClient: &http.Client{
		Transport: &http.Transport{
			Proxy: http.ProxyURL(proxyUrl),
		},
	},
	Debug:       false,
}

Similarly, to configure the timeout, set it on the http.Client:

config := rize.Config{
	HMACKey:     hmac,
	ProgramUID:  programUID,
	Environment: environment,
	HTTPClient: &http.Client{
		Timeout: time.Minute,
	},
	Debug:       false,
}

Rize Message Queue

The SDK provides a package to connect to the Rize Message Queue using the STOMP protocol. The mq package wraps go-stomp with configuration settings necessary for connecting and subscribing to events from the RMQ.

Invoking MessageQueue.Subscribe will return a *stomp.Subscription type containing a channel from which to receive event messages.

import "github.com/rizefinance/rize-go-sdk/mq"

func main() {
	config := mq.Config{
		Username:    "mq_username",
		Password:    "mq_password",
		ClientID:    "mq_client_id",
		Environment: "environment",
		Debug:       true,
	}

	// Create new Rize MQ client
	mc, err := mq.NewClient(&config)
	if err != nil {
		log.Fatal("Error building MQ client\n", err)
	}

	// Create MQ connection
	if err := mc.MessageQueue.Connect(); err != nil {
		log.Fatal("Error creation MQ connection:\n", err)
	}

	// Subscribe to customer MQ topics
	sub, err := mc.MessageQueue.Subscribe("customer", "customerSubscription")
	if err != nil {
		log.Printf("Subscribe failed: %s\n", err)
	}

	// Unsubscribe from a subscription
	if err := mc.MessageQueue.Unsubscribe(sub); err != nil {
		log.Printf("Unsubscribe failed: %s\n", err)
	}
}

Examples

The examples directory provides basic implementation examples for each API endpoint that can be executed via the command line. Running the examples will require configuration credentials to be set as environment variables.

Use the provided dotenv file to set environment variables for local testing.

# Generate a local configuration file
$ cp .env-example .env

# Run an example Platform API method <SERVICE_NAME> <METHOD_NAME>
$ go run cmd/platform/main.go -s CustomerService -m List

# Open help menu
$ go run cmd/platform/main.go -h

# Connect to the Rize Message Queue and subscribe to the Customer topic
$ go run cmd/mq/main.go

See the Examples ReadMe for a full walk-through of Customer Onboarding.

Unit Tests

Test files for the platform SDK can be found in the test directory.

# Install Task
$ brew install go-task/tap/go-task

# Run all unit tests
$ task test

Documentation

• Platform API Documentation
• Message Queue Documentation
• Rize Postman
• Rize GitHub
• Rize JS SDK
• Rize Website

License

MIT License. Copyright 2021-Present Rize Money, Inc. All rights reserved.

See LICENSE