balancetransaction

Documentation

Overview

Package balancetransaction provides the /balance_transactions APIs

Index

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

Functions

func Get

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

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /balance_transactions APIs.

func (Client) Get

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

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

func (Client) List

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

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for balance transactions.

func List

func List(params *stripe.BalanceTransactionListParams) *Iter

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

func (*Iter) BalanceTransaction

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

BalanceTransaction returns the balance transaction which the iterator is currently pointing to.

func (*Iter) BalanceTransactionList

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

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