financialaccount

Documentation

Overview

Package financialaccount provides the /treasury/financial_accounts APIs

Index

• func Get(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
• func New(params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
• func RetrieveFeatures(id string, params *stripe.TreasuryFinancialAccountRetrieveFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)
• func Update(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
• func UpdateFeatures(id string, params *stripe.TreasuryFinancialAccountUpdateFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
  • func (c Client) List(listParams *stripe.TreasuryFinancialAccountListParams) *Iter
  • func (c Client) New(params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
  • func (c Client) RetrieveFeatures(id string, params *stripe.TreasuryFinancialAccountRetrieveFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)
  • func (c Client) Update(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)
  • func (c Client) UpdateFeatures(id string, params *stripe.TreasuryFinancialAccountUpdateFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)
• type Iter
  • func List(params *stripe.TreasuryFinancialAccountListParams) *Iter
  • func (i *Iter) TreasuryFinancialAccount() *stripe.TreasuryFinancialAccount
  • func (i *Iter) TreasuryFinancialAccountList() *stripe.TreasuryFinancialAccountList

Functions

func Get

func Get(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

Get returns the details of a treasury financial account.

func New

func New(params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

New creates a new treasury financial account.

func RetrieveFeatures

func RetrieveFeatures(id string, params *stripe.TreasuryFinancialAccountRetrieveFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)

RetrieveFeatures is the method for the `GET /v1/treasury/financial_accounts/{financial_account}/features` API.

func Update

func Update(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

Update updates a treasury financial account's properties.

func UpdateFeatures

func UpdateFeatures(id string, params *stripe.TreasuryFinancialAccountUpdateFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)

UpdateFeatures is the method for the `POST /v1/treasury/financial_accounts/{financial_account}/features` API.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/financial_accounts APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

Get returns the details of a treasury financial account.

func (Client) List

func (c Client) List(listParams *stripe.TreasuryFinancialAccountListParams) *Iter

List returns a list of treasury financial accounts.

func (Client) New

func (c Client) New(params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

New creates a new treasury financial account.

func (Client) RetrieveFeatures

func (c Client) RetrieveFeatures(id string, params *stripe.TreasuryFinancialAccountRetrieveFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)

RetrieveFeatures is the method for the `GET /v1/treasury/financial_accounts/{financial_account}/features` API.

func (Client) Update

func (c Client) Update(id string, params *stripe.TreasuryFinancialAccountParams) (*stripe.TreasuryFinancialAccount, error)

Update updates a treasury financial account's properties.

func (Client) UpdateFeatures

func (c Client) UpdateFeatures(id string, params *stripe.TreasuryFinancialAccountUpdateFeaturesParams) (*stripe.TreasuryFinancialAccountFeatures, error)

UpdateFeatures is the method for the `POST /v1/treasury/financial_accounts/{financial_account}/features` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury financial accounts.

func List

func List(params *stripe.TreasuryFinancialAccountListParams) *Iter

List returns a list of treasury financial accounts.

func (*Iter) TreasuryFinancialAccount

func (i *Iter) TreasuryFinancialAccount() *stripe.TreasuryFinancialAccount

TreasuryFinancialAccount returns the treasury financial account which the iterator is currently pointing to.

func (*Iter) TreasuryFinancialAccountList

func (i *Iter) TreasuryFinancialAccountList() *stripe.TreasuryFinancialAccountList

TreasuryFinancialAccountList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.