gl

README

moov-io/gl

project is under active development and is not production ready

Reading

Accounting for Developers Part 1, Part 2, Part 3.

Configuration

TODO

Environmental Variable	Description	Default
DEFAULT_ROUTING_NUMBER	ABA routing number used when accounts are created.	Required
SQLITE_DB_PATH	Local filepath location for the paygate SQLite database.	ofac.db
ACCOUNT_STORAGE_TYPE	Storage engine for account and transaction data.	Default: qledger
QLEDGER_ENDPOINT	HTTP endpoint to access QLedger (if storage type is qledger)	Required
QLEDGER_AUTH_TOKEN	Auth token to access QLedger (if storage type is qledger)	Required

Documentation

Index

• Constants
• type Account
• type Address
• type Customer
• type Phone

Constants

const Version = "v0.2.2"

Types

type Account

type Account struct {
	ID         string `json:"accountId"`
	CustomerID string `json:"customerId"`

	Name string `json:"name"`

	AccountNumber       string `json:"accountNumber"`
	AccountNumberMasked string `json:"accountNumberMasked"`
	RoutingNumber       string `json:"routingNumber"`

	// Status represents the Account status: Open, Closed
	Status string `json:"status"`
	// Type is the account type: Checking, Savings, FBO
	Type string `json:"type"`

	CreatedAt    time.Time `json:"createdAt"`
	ClosedAt     time.Time `json:"closedAt"`
	LastModified time.Time `json:"lastModified"`

	Balance          int64 `json:"balance"`
	BalanceAvailable int64 `json:"balanceAvailable"`
	BalancePending   int64 `json:"balancePending"`
}

type Address

type Address struct {
	// Type represents if the address is a Primary residence or Secondary
	Type string `json:"type"`

	Address1   string `json:"address1"`
	Address2   string `json:"address2"`
	City       string `json:"city"`
	State      string `json:"state"`
	PostalCode string `json:"postalCode"`
	Country    string `json:"country"`

	Validated bool `json:"validated"`
	Active    bool `json:"active"`
}

type Customer

type Customer struct {
	ID string `json:"customerId"`

	FirstName  string `json:"firstName"`
	MiddleName string `json:"middleName"`
	LastName   string `json:"lastName"`

	NickName string `json:"nickName"`
	Suffix   string `json:"suffix"`

	BirthDate time.Time `json:"birthDate"`
	Gender    string    `json:"gender"`
	Culture   string    `json:"culture"`

	// Status holds the Customer's status: Applied, Verified, Denied, Archieved, Deceased
	Status string `json:"status"`

	Email     string    `json:"email"`
	Phones    []Phone   `json:"phones"`
	Addresses []Address `json:"address"`

	CreatedAt    time.Time `json:"createdAt"`
	LastModified time.Time `json:"lastModified"`
}

type Phone

type Phone struct {
	Number string `json:"number"`
	Valid  bool   `json:"valid"`
	// Type represents the number's usage: Home, Mobile, Work
	Type string `json:"type"`
}