outboundpayment

Documentation

Overview

Package outboundpayment provides the /treasury/outbound_payments APIs

Index

• func Fail(id string, params *stripe.TestHelpersTreasuryOutboundPaymentFailParams) (*stripe.TreasuryOutboundPayment, error)
• func Post(id string, params *stripe.TestHelpersTreasuryOutboundPaymentPostParams) (*stripe.TreasuryOutboundPayment, error)
• func ReturnOutboundPayment(id string, ...) (*stripe.TreasuryOutboundPayment, error)
• func Update(id string, params *stripe.TestHelpersTreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)
• type Client
  • func (c Client) Fail(id string, params *stripe.TestHelpersTreasuryOutboundPaymentFailParams) (*stripe.TreasuryOutboundPayment, error)
  • func (c Client) Post(id string, params *stripe.TestHelpersTreasuryOutboundPaymentPostParams) (*stripe.TreasuryOutboundPayment, error)
  • func (c Client) ReturnOutboundPayment(id string, ...) (*stripe.TreasuryOutboundPayment, error)
  • func (c Client) Update(id string, params *stripe.TestHelpersTreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Functions

func Fail

func Fail(id string, params *stripe.TestHelpersTreasuryOutboundPaymentFailParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

func Post

func Post(id string, params *stripe.TestHelpersTreasuryOutboundPaymentPostParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

func ReturnOutboundPayment

func ReturnOutboundPayment(id string, params *stripe.TestHelpersTreasuryOutboundPaymentReturnOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

func Update

func Update(id string, params *stripe.TestHelpersTreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/outbound_payments APIs.

func (Client) Fail

func (c Client) Fail(id string, params *stripe.TestHelpersTreasuryOutboundPaymentFailParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

func (Client) Post

func (c Client) Post(id string, params *stripe.TestHelpersTreasuryOutboundPaymentPostParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

func (Client) ReturnOutboundPayment

func (c Client) ReturnOutboundPayment(id string, params *stripe.TestHelpersTreasuryOutboundPaymentReturnOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

func (Client) Update

func (c Client) Update(id string, params *stripe.TestHelpersTreasuryOutboundPaymentParams) (*stripe.TreasuryOutboundPayment, error)

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.