balance

Documentation

Overview

Package balance provides the /balance APIs

Index

• Constants
• func Get(params *stripe.BalanceParams) (*stripe.Balance, error)
• func GetTx(id string, params *stripe.TxParams) (*stripe.Transaction, error)
• type Client
  • func (c Client) Get(params *stripe.BalanceParams) (*stripe.Balance, error)
  • func (c Client) GetTx(id string, params *stripe.TxParams) (*stripe.Transaction, error)
  • func (c Client) List(params *stripe.TxListParams) *Iter
• type Iter
  • func List(params *stripe.TxListParams) *Iter
  • func (i *Iter) Transaction() *stripe.Transaction

Constants

const (
	TxAvailable stripe.TransactionStatus = "available"
	TxPending   stripe.TransactionStatus = "pending"

	TxCharge                  stripe.TransactionType = "charge"
	TxRefund                  stripe.TransactionType = "refund"
	TxAdjust                  stripe.TransactionType = "adjustment"
	TxAppFee                  stripe.TransactionType = "application_fee"
	TxFeeRefund               stripe.TransactionType = "application_fee_refund"
	TxRecipientTransfer       stripe.TransactionType = "recipient_transfer"
	TxRecipientTransferCancel stripe.TransactionType = "recipient_transfer_cancel"
	TxRecipientTransferFail   stripe.TransactionType = "recipient_transfer_failure"
	TxPayout                  stripe.TransactionType = "payout"
	TxPayoutCancel            stripe.TransactionType = "payout_cancel"
	TxPayoutFail              stripe.TransactionType = "payout_failure"
	TxTransfer                stripe.TransactionType = "transfer"
	TxTransferCancel          stripe.TransactionType = "transfer_refund"
)

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 GetTx

func GetTx(id string, params *stripe.TxParams) (*stripe.Transaction, error)

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

func (c Client) GetTx(id string, params *stripe.TxParams) (*stripe.Transaction, error)

func (Client) List

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

type Iter

type Iter struct {
	*stripe.Iter
}

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

func List

func List(params *stripe.TxListParams) *Iter

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

func (*Iter) Transaction

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

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