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)
• 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)
• 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)

Disconnect is the method for the `POST /v1/financial_connections/accounts/{account}/disconnect` API.

func GetByID

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

GetByID returns the details of a financial connections account.

func Refresh

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

Refresh is the method for the `POST /v1/financial_connections/accounts/{account}/refresh` API.

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)

Disconnect is the method for the `POST /v1/financial_connections/accounts/{account}/disconnect` API.

func (Client) GetByID

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

GetByID returns the details of a financial connections account.

func (Client) List

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

List returns a list of financial connections accounts.

func (Client) ListOwners

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

ListOwners is the method for the `GET /v1/financial_connections/accounts/{account}/owners` API.

func (Client) Refresh

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

Refresh is the method for the `POST /v1/financial_connections/accounts/{account}/refresh` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for financial connections accounts.

func List

func List(params *stripe.FinancialConnectionsAccountListParams) *Iter

List returns a list of financial connections accounts.

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

ListOwners is the method for the `GET /v1/financial_connections/accounts/{account}/owners` API.

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.