outboundpayment

Documentation

Overview

Package outboundpayment provides the /treasury/outbound_payments APIs

Index

• func Cancel(id string, params *stripe.TreasuryOutboundPaymentCancelParams) (*stripe.TreasuryOutboundPayment, error)
• func Get(id string, params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)
• func New(params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.TreasuryOutboundPaymentCancelParams) (*stripe.TreasuryOutboundPayment, error)
  • func (c Client) Get(id string, params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)
  • func (c Client) List(listParams *stripe.TreasuryOutboundPaymentListParams) *Iter
  • func (c Client) New(params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)
• type Iter
  • func List(params *stripe.TreasuryOutboundPaymentListParams) *Iter
  • func (i *Iter) TreasuryOutboundPayment() *stripe.TreasuryOutboundPayment
  • func (i *Iter) TreasuryOutboundPaymentList() *stripe.TreasuryOutboundPaymentList

Functions

func Cancel

func Cancel(id string, params *stripe.TreasuryOutboundPaymentCancelParams) (*stripe.TreasuryOutboundPayment, error)

Cancel an OutboundPayment.

func Get

func Get(id string, params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

func New

func New(params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Creates an OutboundPayment.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/outbound_payments APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.TreasuryOutboundPaymentCancelParams) (*stripe.TreasuryOutboundPayment, error)

Cancel an OutboundPayment.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

func (Client) List

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

Returns a list of OutboundPayments sent from the specified FinancialAccount.

func (Client) New

func (c Client) New(params *stripe.TreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Creates an OutboundPayment.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury outbound payments.

func List

func List(params *stripe.TreasuryOutboundPaymentListParams) *Iter

Returns a list of OutboundPayments sent from the specified FinancialAccount.

func (*Iter) TreasuryOutboundPayment

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

TreasuryOutboundPayment returns the treasury outbound payment which the iterator is currently pointing to.

func (*Iter) TreasuryOutboundPaymentList

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

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