bankaccount

Documentation

Overview

Package bankaccount provides the bankaccount related APIs

Index

• func Del(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
• func Get(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
• func New(params *stripe.BankAccountParams) (*stripe.BankAccount, error)
• func Update(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
• type Client
  • func (c Client) Del(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
  • func (c Client) Get(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
  • func (c Client) List(listParams *stripe.BankAccountListParams) *Iter
  • func (c Client) New(params *stripe.BankAccountParams) (*stripe.BankAccount, error)
  • func (c Client) Update(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)
• type Iter
  • func List(params *stripe.BankAccountListParams) *Iter
  • func (i *Iter) BankAccount() *stripe.BankAccount
  • func (i *Iter) BankAccountList() *stripe.BankAccountList

Functions

func Del

func Del(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Delete a specified external account for a given account.

func Get

func Get(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Get returns the details of a bank account.

func New

func New(params *stripe.BankAccountParams) (*stripe.BankAccount, error)

New creates a new bank account

func Update

func Update(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection).

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke bankaccount related APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Delete a specified external account for a given account.

func (Client) Get

func (c Client) Get(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Get returns the details of a bank account.

func (Client) List

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

func (Client) New

func (c Client) New(params *stripe.BankAccountParams) (*stripe.BankAccount, error)

New creates a new bank account

func (Client) Update

func (c Client) Update(id string, params *stripe.BankAccountParams) (*stripe.BankAccount, error)

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection).

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for bank accounts.

func List

func List(params *stripe.BankAccountListParams) *Iter

func (*Iter) BankAccount

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

BankAccount returns the bank account which the iterator is currently pointing to.

func (*Iter) BankAccountList

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

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