plaid-go

plaid-go

A Go client library for the Plaid API.

Table of Contents

• plaid-go
  • Install
  • Versioning
  • Documentation
  • Getting Started
  • Contributing
  • License

Install

$ go get github.com/plaid/plaid-go

Versioning

Each major version of plaid-go targets a specific version of the Plaid API:

For information about what has changed between versions and how to update your integration, head to the version changelog.

Documentation

The module supports all Plaid API endpoints.

GoDoc:

Getting Started

Calling Endpoints

To call an endpoint you must create a Client object.

import (
    "net/http"
    "os"

    "github.com/plaid/plaid-go/plaid"
)

clientOptions := plaid.ClientOptions{
    os.Getenv("PLAID_CLIENT_ID"),
    os.Getenv("PLAID_SECRET"),
    os.Getenv("PLAID_PUBLIC_KEY"),
    plaid.Sandbox, // Available environments are Sandbox, Development, and Production
    &http.Client{}, // This parameter is optional
}
client, err := plaid.NewClient(clientOptions)

Each endpoint returns an object which contains the parsed JSON from the HTTP response.

Errors

All non-200 responses will return a plaid.Error instance.

For more information on Plaid response codes, head to the docs.

Support

Open an issue!

License

MIT