balance

Documentation

Overview

Package balance provides the /balance APIs

Index

• func Get(params *stripe.BalanceParams) (*stripe.Balance, error)
• func GetBalanceTransaction(id string, params *stripe.BalanceTransactionParams) (*stripe.BalanceTransaction, error)
• type Client
  • func (c Client) Get(params *stripe.BalanceParams) (*stripe.Balance, error)
  • func (c Client) GetBalanceTransaction(id string, params *stripe.BalanceTransactionParams) (*stripe.BalanceTransaction, error)
  • func (c Client) List(params *stripe.BalanceTransactionListParams) *Iter
• type Iter
  • func List(params *stripe.BalanceTransactionListParams) *Iter
  • func (i *Iter) BalanceTransaction() *stripe.BalanceTransaction

Functions

func Get

func Get(params *stripe.BalanceParams) (*stripe.Balance, error)

Get returns the details of your balance. For more details see https://stripe.com/docs/api#retrieve_balance.

func GetBalanceTransaction

func GetBalanceTransaction(id string, params *stripe.BalanceTransactionParams) (*stripe.BalanceTransaction, error)

GetBalanceTransaction returns the details of a balance transaction. For more details see https://stripe.com/docs/api#retrieve_balance_transaction.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /balance and transaction-related APIs.

func (Client) Get

func (c Client) Get(params *stripe.BalanceParams) (*stripe.Balance, error)

func (Client) GetBalanceTransaction

func (c Client) GetBalanceTransaction(id string, params *stripe.BalanceTransactionParams) (*stripe.BalanceTransaction, error)

func (Client) List

func (c Client) List(params *stripe.BalanceTransactionListParams) *Iter

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for lists of BalanceTransactions. The embedded Iter carries methods with it; see its documentation for details.

func List

func List(params *stripe.BalanceTransactionListParams) *Iter

List returns a list of balance transactions. For more details see https://stripe.com/docs/api#balance_history.

func (*Iter) BalanceTransaction

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

Charge returns the most recent BalanceTransaction visited by a call to Next.