Skip to content

GoCardless Pro Go Client [Unofficial]. This library provides a simple wrapper around the GoCardless API.

License

Notifications You must be signed in to change notification settings

saopayne/gocardless-pro-go

Repository files navigation

Build Status PRs Welcome

GO Client for GoCardless Pro API

[Work In Progress]

Go library to access GoCardless API. This library provides a simple wrapper around the GoCardless API.

Getting started

go get github.com/saopayne/gocardless-pro-go

Initializing the client

Usage

import "https://github.com/saopayne/gocardless-pro-go"

apiKey := "sandbox_o55p5OowBX59Rd8aDR7c_25LQdBTHRaACeVnqj0o"

client := NewClient(apiKey, nil)

cust := &Customer{
    FamilyName:   "Oyewale",
    GivenName:    "Ademola",
    Email:        "[email protected]",
    PostalCode:   "E2 8DP",
    CountryCode:  "GB",
    City:         "Lagos",
    AddressLine1: "Just somewhere on Earth",
    AddressLine2: "Another place on Earth",
    AddressLine3: "Just the third address to justify things",
    Language:     "en",
}

// create the customer
client.LoggingEnabled = true
customer, err := client.Customer.Create(cust)
if err != nil {
    // do something with error
    fmt.Sprintf("The error while creating a customer is :%s", err.Error())
}
fmt.Sprintf("The customer created is: %s ", string(customer.Email))

// Get customer by ID
customer, err = client.Customer.Get(customer.ID)
if err != nil {
    fmt.Sprintf("The error while getting a customer is :%s", err.Error())
}

fmt.Sprintf("The customer retrieved with ID: %d is : %s", customer.ID, customer.Email)

// Creating a redirect flow
rFlowCreateReq := &RedirectFlowCreateRequest{
    Description: "Wine vines",
    SessionToken: "SESS_wSs0uGYMISxzqOBq",
    PrefilledCustomer: PrefilledCustomer{
        GivenName: "Ademola",
        FamilyName: "Oyewale",
    },
    SuccessRedirectUrl: "https://wewee.ngrok.io/",
}
// create a redirecflow
client.LoggingEnabled = true
redirectFlow, err := client.RedirectFlow.Create(rFlowCreateReq)
if err != nil {
    // do something with error
    fmt.Sprintf("The error while creating a redirect flow pdf is :%s", err.Error())
}
fmt.Sprintf("The redirect flow created has the description: %s ", redirectFlow.Description)

For a more descriptive usage Click Here

See the test files for more examples.

TODO

  • Complete All Api calls
  • Documentation
  • Write Unit tests
  • Better handling of API call errors

CONTRIBUTING

  • Fork the repository, make necessary changes and send the PR.

About

GoCardless Pro Go Client [Unofficial]. This library provides a simple wrapper around the GoCardless API.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages