reader

Documentation

Overview

Package reader provides the /terminal/readers APIs

Index

• func CancelAction(id string, params *stripe.TerminalReaderCancelActionParams) (*stripe.TerminalReader, error)
• func Del(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
• func Get(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
• func New(params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
• func ProcessPaymentIntent(id string, params *stripe.TerminalReaderProcessPaymentIntentParams) (*stripe.TerminalReader, error)
• func ProcessSetupIntent(id string, params *stripe.TerminalReaderProcessSetupIntentParams) (*stripe.TerminalReader, error)
• func RefundPayment(id string, params *stripe.TerminalReaderRefundPaymentParams) (*stripe.TerminalReader, error)
• func SetReaderDisplay(id string, params *stripe.TerminalReaderSetReaderDisplayParams) (*stripe.TerminalReader, error)
• func Update(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
• type Client
  • func (c Client) CancelAction(id string, params *stripe.TerminalReaderCancelActionParams) (*stripe.TerminalReader, error)
  • func (c Client) Del(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
  • func (c Client) Get(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
  • func (c Client) List(listParams *stripe.TerminalReaderListParams) *Iter
  • func (c Client) New(params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
  • func (c Client) ProcessPaymentIntent(id string, params *stripe.TerminalReaderProcessPaymentIntentParams) (*stripe.TerminalReader, error)
  • func (c Client) ProcessSetupIntent(id string, params *stripe.TerminalReaderProcessSetupIntentParams) (*stripe.TerminalReader, error)
  • func (c Client) RefundPayment(id string, params *stripe.TerminalReaderRefundPaymentParams) (*stripe.TerminalReader, error)
  • func (c Client) SetReaderDisplay(id string, params *stripe.TerminalReaderSetReaderDisplayParams) (*stripe.TerminalReader, error)
  • func (c Client) Update(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)
• type Iter
  • func List(params *stripe.TerminalReaderListParams) *Iter
  • func (i *Iter) TerminalReader() *stripe.TerminalReader
  • func (i *Iter) TerminalReaderList() *stripe.TerminalReaderList

Functions

func CancelAction

func CancelAction(id string, params *stripe.TerminalReaderCancelActionParams) (*stripe.TerminalReader, error)

Cancels the current reader action.

func Del

func Del(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Deletes a Reader object.

func Get

func Get(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Retrieves a Reader object.

func New

func New(params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Creates a new Reader object.

func ProcessPaymentIntent

func ProcessPaymentIntent(id string, params *stripe.TerminalReaderProcessPaymentIntentParams) (*stripe.TerminalReader, error)

Initiates a payment flow on a Reader.

func ProcessSetupIntent

func ProcessSetupIntent(id string, params *stripe.TerminalReaderProcessSetupIntentParams) (*stripe.TerminalReader, error)

Initiates a setup intent flow on a Reader.

func RefundPayment

func RefundPayment(id string, params *stripe.TerminalReaderRefundPaymentParams) (*stripe.TerminalReader, error)

Initiates a refund on a Reader

func SetReaderDisplay

func SetReaderDisplay(id string, params *stripe.TerminalReaderSetReaderDisplayParams) (*stripe.TerminalReader, error)

Sets reader display to show cart details.

func Update

func Update(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /terminal/readers APIs.

func (Client) CancelAction

func (c Client) CancelAction(id string, params *stripe.TerminalReaderCancelActionParams) (*stripe.TerminalReader, error)

Cancels the current reader action.

func (Client) Del

func (c Client) Del(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Deletes a Reader object.

func (Client) Get

func (c Client) Get(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Retrieves a Reader object.

func (Client) List

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

Returns a list of Reader objects.

func (Client) New

func (c Client) New(params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Creates a new Reader object.

func (Client) ProcessPaymentIntent

func (c Client) ProcessPaymentIntent(id string, params *stripe.TerminalReaderProcessPaymentIntentParams) (*stripe.TerminalReader, error)

Initiates a payment flow on a Reader.

func (Client) ProcessSetupIntent

func (c Client) ProcessSetupIntent(id string, params *stripe.TerminalReaderProcessSetupIntentParams) (*stripe.TerminalReader, error)

Initiates a setup intent flow on a Reader.

func (Client) RefundPayment

func (c Client) RefundPayment(id string, params *stripe.TerminalReaderRefundPaymentParams) (*stripe.TerminalReader, error)

Initiates a refund on a Reader

func (Client) SetReaderDisplay

func (c Client) SetReaderDisplay(id string, params *stripe.TerminalReaderSetReaderDisplayParams) (*stripe.TerminalReader, error)

Sets reader display to show cart details.

func (Client) Update

func (c Client) Update(id string, params *stripe.TerminalReaderParams) (*stripe.TerminalReader, error)

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for terminal readers.

func List

func List(params *stripe.TerminalReaderListParams) *Iter

Returns a list of Reader objects.

func (*Iter) TerminalReader

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

TerminalReader returns the terminal reader which the iterator is currently pointing to.

func (*Iter) TerminalReaderList

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

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