account

Documentation

Overview

Package account provides the /financial_connections/accounts APIs

Index

• func Disconnect(id string, params *stripe.FinancialConnectionsAccountDisconnectParams) (*stripe.FinancialConnectionsAccount, error)
• func GetByID(id string, params *stripe.FinancialConnectionsAccountParams) (*stripe.FinancialConnectionsAccount, error)
• func Refresh(id string, params *stripe.FinancialConnectionsAccountRefreshParams) (*stripe.FinancialConnectionsAccount, error)
• func Subscribe(id string, params *stripe.FinancialConnectionsAccountSubscribeParams) (*stripe.FinancialConnectionsAccount, error)
• func Unsubscribe(id string, params *stripe.FinancialConnectionsAccountUnsubscribeParams) (*stripe.FinancialConnectionsAccount, error)
• type Client
  • func (c Client) Disconnect(id string, params *stripe.FinancialConnectionsAccountDisconnectParams) (*stripe.FinancialConnectionsAccount, error)
  • func (c Client) GetByID(id string, params *stripe.FinancialConnectionsAccountParams) (*stripe.FinancialConnectionsAccount, error)
  • func (c Client) List(listParams *stripe.FinancialConnectionsAccountListParams) *Iter
  • func (c Client) ListOwners(listParams *stripe.FinancialConnectionsAccountListOwnersParams) *OwnerIter
  • func (c Client) Refresh(id string, params *stripe.FinancialConnectionsAccountRefreshParams) (*stripe.FinancialConnectionsAccount, error)
  • func (c Client) Subscribe(id string, params *stripe.FinancialConnectionsAccountSubscribeParams) (*stripe.FinancialConnectionsAccount, error)
  • func (c Client) Unsubscribe(id string, params *stripe.FinancialConnectionsAccountUnsubscribeParams) (*stripe.FinancialConnectionsAccount, error)
• type Iter
  • func List(params *stripe.FinancialConnectionsAccountListParams) *Iter
  • func (i *Iter) FinancialConnectionsAccount() *stripe.FinancialConnectionsAccount
  • func (i *Iter) FinancialConnectionsAccountList() *stripe.FinancialConnectionsAccountList
• type OwnerIter
  • func ListOwners(params *stripe.FinancialConnectionsAccountListOwnersParams) *OwnerIter
  • func (i *OwnerIter) FinancialConnectionsAccountOwner() *stripe.FinancialConnectionsAccountOwner
  • func (i *OwnerIter) FinancialConnectionsAccountOwnerList() *stripe.FinancialConnectionsAccountOwnerList

Functions

func Disconnect

func Disconnect(id string, params *stripe.FinancialConnectionsAccountDisconnectParams) (*stripe.FinancialConnectionsAccount, error)

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

func GetByID

func GetByID(id string, params *stripe.FinancialConnectionsAccountParams) (*stripe.FinancialConnectionsAccount, error)

Retrieves the details of an Financial Connections Account.

func Refresh

func Refresh(id string, params *stripe.FinancialConnectionsAccountRefreshParams) (*stripe.FinancialConnectionsAccount, error)

Refreshes the data associated with a Financial Connections Account.

func Subscribe

func Subscribe(id string, params *stripe.FinancialConnectionsAccountSubscribeParams) (*stripe.FinancialConnectionsAccount, error)

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

func Unsubscribe

func Unsubscribe(id string, params *stripe.FinancialConnectionsAccountUnsubscribeParams) (*stripe.FinancialConnectionsAccount, error)

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /financial_connections/accounts APIs.

func (Client) Disconnect

func (c Client) Disconnect(id string, params *stripe.FinancialConnectionsAccountDisconnectParams) (*stripe.FinancialConnectionsAccount, error)

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

func (Client) GetByID

func (c Client) GetByID(id string, params *stripe.FinancialConnectionsAccountParams) (*stripe.FinancialConnectionsAccount, error)

Retrieves the details of an Financial Connections Account.

func (Client) List

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

Returns a list of Financial Connections Account objects.

func (Client) ListOwners

func (c Client) ListOwners(listParams *stripe.FinancialConnectionsAccountListOwnersParams) *OwnerIter

Lists all owners for a given Account

func (Client) Refresh

func (c Client) Refresh(id string, params *stripe.FinancialConnectionsAccountRefreshParams) (*stripe.FinancialConnectionsAccount, error)

Refreshes the data associated with a Financial Connections Account.

func (Client) Subscribe

func (c Client) Subscribe(id string, params *stripe.FinancialConnectionsAccountSubscribeParams) (*stripe.FinancialConnectionsAccount, error)

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

func (Client) Unsubscribe

func (c Client) Unsubscribe(id string, params *stripe.FinancialConnectionsAccountUnsubscribeParams) (*stripe.FinancialConnectionsAccount, error)

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for financial connections accounts.

func List

func List(params *stripe.FinancialConnectionsAccountListParams) *Iter

Returns a list of Financial Connections Account objects.

func (*Iter) FinancialConnectionsAccount

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

FinancialConnectionsAccount returns the financial connections account which the iterator is currently pointing to.

func (*Iter) FinancialConnectionsAccountList

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

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

type OwnerIter

type OwnerIter struct {
	*stripe.Iter
}

OwnerIter is an iterator for financial connections account owners.

func ListOwners

func ListOwners(params *stripe.FinancialConnectionsAccountListOwnersParams) *OwnerIter

Lists all owners for a given Account

func (*OwnerIter) FinancialConnectionsAccountOwner

func (i *OwnerIter) FinancialConnectionsAccountOwner() *stripe.FinancialConnectionsAccountOwner

FinancialConnectionsAccountOwner returns the financial connections account owner which the iterator is currently pointing to.

func (*OwnerIter) FinancialConnectionsAccountOwnerList

func (i *OwnerIter) FinancialConnectionsAccountOwnerList() *stripe.FinancialConnectionsAccountOwnerList

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