paymentintent

Documentation

Overview

Package paymentintent provides the /payment_intents APIs

Index

• func ApplyCustomerBalance(id string, params *stripe.PaymentIntentApplyCustomerBalanceParams) (*stripe.PaymentIntent, error)
• func Cancel(id string, params *stripe.PaymentIntentCancelParams) (*stripe.PaymentIntent, error)
• func Capture(id string, params *stripe.PaymentIntentCaptureParams) (*stripe.PaymentIntent, error)
• func Confirm(id string, params *stripe.PaymentIntentConfirmParams) (*stripe.PaymentIntent, error)
• func Get(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
• func IncrementAuthorization(id string, params *stripe.PaymentIntentIncrementAuthorizationParams) (*stripe.PaymentIntent, error)
• func New(params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
• func Update(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
• func VerifyMicrodeposits(id string, params *stripe.PaymentIntentVerifyMicrodepositsParams) (*stripe.PaymentIntent, error)
• type Client
  • func (c Client) ApplyCustomerBalance(id string, params *stripe.PaymentIntentApplyCustomerBalanceParams) (*stripe.PaymentIntent, error)
  • func (c Client) Cancel(id string, params *stripe.PaymentIntentCancelParams) (*stripe.PaymentIntent, error)
  • func (c Client) Capture(id string, params *stripe.PaymentIntentCaptureParams) (*stripe.PaymentIntent, error)
  • func (c Client) Confirm(id string, params *stripe.PaymentIntentConfirmParams) (*stripe.PaymentIntent, error)
  • func (c Client) Get(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
  • func (c Client) IncrementAuthorization(id string, params *stripe.PaymentIntentIncrementAuthorizationParams) (*stripe.PaymentIntent, error)
  • func (c Client) List(listParams *stripe.PaymentIntentListParams) *Iter
  • func (c Client) New(params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
  • func (c Client) Search(params *stripe.PaymentIntentSearchParams) *SearchIter
  • func (c Client) Update(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)
  • func (c Client) VerifyMicrodeposits(id string, params *stripe.PaymentIntentVerifyMicrodepositsParams) (*stripe.PaymentIntent, error)
• type Iter
  • func List(params *stripe.PaymentIntentListParams) *Iter
  • func (i *Iter) PaymentIntent() *stripe.PaymentIntent
  • func (i *Iter) PaymentIntentList() *stripe.PaymentIntentList
• type SearchIter
  • func Search(params *stripe.PaymentIntentSearchParams) *SearchIter
  • func (i *SearchIter) PaymentIntent() *stripe.PaymentIntent
  • func (i *SearchIter) PaymentIntentSearchResult() *stripe.PaymentIntentSearchResult

Functions

func ApplyCustomerBalance

func ApplyCustomerBalance(id string, params *stripe.PaymentIntentApplyCustomerBalanceParams) (*stripe.PaymentIntent, error)

ApplyCustomerBalance is the method for the `POST /v1/payment_intents/{intent}/apply_customer_balance` API.

func Cancel

func Cancel(id string, params *stripe.PaymentIntentCancelParams) (*stripe.PaymentIntent, error)

Cancel is the method for the `POST /v1/payment_intents/{intent}/cancel` API.

func Capture

func Capture(id string, params *stripe.PaymentIntentCaptureParams) (*stripe.PaymentIntent, error)

Capture is the method for the `POST /v1/payment_intents/{intent}/capture` API.

func Confirm

func Confirm(id string, params *stripe.PaymentIntentConfirmParams) (*stripe.PaymentIntent, error)

Confirm is the method for the `POST /v1/payment_intents/{intent}/confirm` API.

func Get

func Get(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

Get returns the details of a payment intent.

func IncrementAuthorization

func IncrementAuthorization(id string, params *stripe.PaymentIntentIncrementAuthorizationParams) (*stripe.PaymentIntent, error)

IncrementAuthorization is the method for the `POST /v1/payment_intents/{intent}/increment_authorization` API.

func New

func New(params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

New creates a new payment intent.

func Update

func Update(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

Update updates a payment intent's properties.

func VerifyMicrodeposits

func VerifyMicrodeposits(id string, params *stripe.PaymentIntentVerifyMicrodepositsParams) (*stripe.PaymentIntent, error)

VerifyMicrodeposits is the method for the `POST /v1/payment_intents/{intent}/verify_microdeposits` API.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /payment_intents APIs.

func (Client) ApplyCustomerBalance

func (c Client) ApplyCustomerBalance(id string, params *stripe.PaymentIntentApplyCustomerBalanceParams) (*stripe.PaymentIntent, error)

ApplyCustomerBalance is the method for the `POST /v1/payment_intents/{intent}/apply_customer_balance` API.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.PaymentIntentCancelParams) (*stripe.PaymentIntent, error)

Cancel is the method for the `POST /v1/payment_intents/{intent}/cancel` API.

func (Client) Capture

func (c Client) Capture(id string, params *stripe.PaymentIntentCaptureParams) (*stripe.PaymentIntent, error)

Capture is the method for the `POST /v1/payment_intents/{intent}/capture` API.

func (Client) Confirm

func (c Client) Confirm(id string, params *stripe.PaymentIntentConfirmParams) (*stripe.PaymentIntent, error)

Confirm is the method for the `POST /v1/payment_intents/{intent}/confirm` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

Get returns the details of a payment intent.

func (Client) IncrementAuthorization

func (c Client) IncrementAuthorization(id string, params *stripe.PaymentIntentIncrementAuthorizationParams) (*stripe.PaymentIntent, error)

IncrementAuthorization is the method for the `POST /v1/payment_intents/{intent}/increment_authorization` API.

func (Client) List

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

List returns a list of payment intents.

func (Client) New

func (c Client) New(params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

New creates a new payment intent.

func (Client) Search

func (c Client) Search(params *stripe.PaymentIntentSearchParams) *SearchIter

Search returns a search result containing payment intents.

func (Client) Update

func (c Client) Update(id string, params *stripe.PaymentIntentParams) (*stripe.PaymentIntent, error)

Update updates a payment intent's properties.

func (Client) VerifyMicrodeposits

func (c Client) VerifyMicrodeposits(id string, params *stripe.PaymentIntentVerifyMicrodepositsParams) (*stripe.PaymentIntent, error)

VerifyMicrodeposits is the method for the `POST /v1/payment_intents/{intent}/verify_microdeposits` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for payment intents.

func List

func List(params *stripe.PaymentIntentListParams) *Iter

List returns a list of payment intents.

func (*Iter) PaymentIntent

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

PaymentIntent returns the payment intent which the iterator is currently pointing to.

func (*Iter) PaymentIntentList

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

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

type SearchIter

type SearchIter struct {
	*stripe.SearchIter
}

SearchIter is an iterator for payment intents.

func Search

func Search(params *stripe.PaymentIntentSearchParams) *SearchIter

Search returns a search result containing payment intents.

func (*SearchIter) PaymentIntent

func (i *SearchIter) PaymentIntent() *stripe.PaymentIntent

PaymentIntent returns the payment intent which the iterator is currently pointing to.

func (*SearchIter) PaymentIntentSearchResult

func (i *SearchIter) PaymentIntentSearchResult() *stripe.PaymentIntentSearchResult

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