accountclient

README

account-client

Documentation

Index

• type Account
• type AccountAttributes
• type AccountResult
• type AccountsResult
• type Client
  • func (cl *Client) Create(newAccountResult AccountResult) (AccountResult, error)
  • func (cl *Client) Delete(accountId string, version int) (string, error)
  • func (cl *Client) Fetch(accountId string) (AccountResult, error)
  • func (cl *Client) FetchAll() (AccountsResult, error)
• type HTTPError
• type Links

Types

type Account

type Account struct {
	Attributes     AccountAttributes `json:"attributes,omitempty"`
	ID             string            `json:"id,omitempty"`
	OrganisationID string            `json:"organisation_id,omitempty"`
	Type           string            `json:"type,omitempty"`
	Version        int               `json:"version,omitempty" validate:"numeric"`
}

type AccountAttributes

type AccountAttributes struct {
	AccountClassification   string   `json:"account_classification,omitempty" validate:"omitempty,oneof=Personal Business"`
	AccountMatchingOptOut   bool     `json:"account_matching_opt_out,omitempty"`
	AccountNumber           string   `json:"account_number,omitempty"`
	AlternativeNames        []string `json:"alternative_names,omitempty"`
	BankID                  string   `json:"bank_id,omitempty" validate:"max=11"`
	BankIDCode              string   `json:"bank_id_code,omitempty"`
	BaseCurrency            string   `json:"base_currency,omitempty" validate:"len=3"`
	Bic                     string   `json:"bic,omitempty" validate:"min=8,max=11"`
	Country                 string   `json:"country,omitempty" validate:"len=2"`
	Iban                    string   `json:"iban,omitempty"`
	JointAccount            bool     `json:"joint_account,omitempty"`
	Name                    []string `json:"name,omitempty"`
	SecondaryIdentification string   `json:"secondary_identification,omitempty"  validate:"max=140"`
	Status                  string   `json:"status,omitempty" validate:"omitempty,oneof=pending confirmed closed failed"`
	StatusReason            string   `json:"status_reason,omitempty"`
	Switched                bool     `json:"switched,omitempty"`
}

type AccountResult

type AccountResult struct {
	Data  Account `json:"data,omitempty"`
	Links Links   `json:"links,omitempty"`
}

type AccountsResult

type AccountsResult struct {
	Data  []Account `json:"data,omitempty"`
	Links Links     `json:"links,omitempty"`
}

type Client

type Client struct {
	Host string
}

func (*Client) Create

func (cl *Client) Create(newAccountResult AccountResult) (AccountResult, error)

func (*Client) Delete

func (cl *Client) Delete(accountId string, version int) (string, error)

func (*Client) Fetch

func (cl *Client) Fetch(accountId string) (AccountResult, error)

func (*Client) FetchAll

func (cl *Client) FetchAll() (AccountsResult, error)

type HTTPError

type HTTPError struct {
	ErrorMessage string `json:"error_message"`
	Message      string `json:"message"`
}

type Links

type Links struct {
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
	Self  string `json:"self,omitempty"`
}