paymentrecord

Documentation

Overview

Package paymentrecord provides the /payment_records APIs

Index

• func Get(id string, params *stripe.PaymentRecordParams) (*stripe.PaymentRecord, error)
• func ReportPayment(params *stripe.PaymentRecordReportPaymentParams) (*stripe.PaymentRecord, error)
• func ReportPaymentAttempt(id string, params *stripe.PaymentRecordReportPaymentAttemptParams) (*stripe.PaymentRecord, error)
• func ReportPaymentAttemptCanceled(id string, params *stripe.PaymentRecordReportPaymentAttemptCanceledParams) (*stripe.PaymentRecord, error)
• func ReportPaymentAttemptFailed(id string, params *stripe.PaymentRecordReportPaymentAttemptFailedParams) (*stripe.PaymentRecord, error)
• func ReportPaymentAttemptGuaranteed(id string, params *stripe.PaymentRecordReportPaymentAttemptGuaranteedParams) (*stripe.PaymentRecord, error)
• type Client
  • func (c Client) Get(id string, params *stripe.PaymentRecordParams) (*stripe.PaymentRecord, error)
  • func (c Client) ReportPayment(params *stripe.PaymentRecordReportPaymentParams) (*stripe.PaymentRecord, error)
  • func (c Client) ReportPaymentAttempt(id string, params *stripe.PaymentRecordReportPaymentAttemptParams) (*stripe.PaymentRecord, error)
  • func (c Client) ReportPaymentAttemptCanceled(id string, params *stripe.PaymentRecordReportPaymentAttemptCanceledParams) (*stripe.PaymentRecord, error)
  • func (c Client) ReportPaymentAttemptFailed(id string, params *stripe.PaymentRecordReportPaymentAttemptFailedParams) (*stripe.PaymentRecord, error)
  • func (c Client) ReportPaymentAttemptGuaranteed(id string, params *stripe.PaymentRecordReportPaymentAttemptGuaranteedParams) (*stripe.PaymentRecord, error)

Functions

func Get

func Get(id string, params *stripe.PaymentRecordParams) (*stripe.PaymentRecord, error)

Retrieves a Payment Record with the given ID

func ReportPayment

func ReportPayment(params *stripe.PaymentRecordReportPaymentParams) (*stripe.PaymentRecord, error)

Report a new Payment Record. You may report a Payment Record as it is

initialized and later report updates through the other report_* methods, or report Payment
Records in a terminal state directly, through this method.

func ReportPaymentAttempt

func ReportPaymentAttempt(id string, params *stripe.PaymentRecordReportPaymentAttemptParams) (*stripe.PaymentRecord, error)

Report a new payment attempt on the specified Payment Record. A new payment

attempt can only be specified if all other payment attempts are canceled or failed.

func ReportPaymentAttemptCanceled

func ReportPaymentAttemptCanceled(id string, params *stripe.PaymentRecordReportPaymentAttemptCanceledParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

was canceled.

func ReportPaymentAttemptFailed

func ReportPaymentAttemptFailed(id string, params *stripe.PaymentRecordReportPaymentAttemptFailedParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

failed or errored.

func ReportPaymentAttemptGuaranteed

func ReportPaymentAttemptGuaranteed(id string, params *stripe.PaymentRecordReportPaymentAttemptGuaranteedParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

was guaranteed.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /payment_records APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.PaymentRecordParams) (*stripe.PaymentRecord, error)

Retrieves a Payment Record with the given ID

func (Client) ReportPayment

func (c Client) ReportPayment(params *stripe.PaymentRecordReportPaymentParams) (*stripe.PaymentRecord, error)

Report a new Payment Record. You may report a Payment Record as it is

initialized and later report updates through the other report_* methods, or report Payment
Records in a terminal state directly, through this method.

func (Client) ReportPaymentAttempt

func (c Client) ReportPaymentAttempt(id string, params *stripe.PaymentRecordReportPaymentAttemptParams) (*stripe.PaymentRecord, error)

Report a new payment attempt on the specified Payment Record. A new payment

attempt can only be specified if all other payment attempts are canceled or failed.

func (Client) ReportPaymentAttemptCanceled

func (c Client) ReportPaymentAttemptCanceled(id string, params *stripe.PaymentRecordReportPaymentAttemptCanceledParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

was canceled.

func (Client) ReportPaymentAttemptFailed

func (c Client) ReportPaymentAttemptFailed(id string, params *stripe.PaymentRecordReportPaymentAttemptFailedParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

failed or errored.

func (Client) ReportPaymentAttemptGuaranteed

func (c Client) ReportPaymentAttemptGuaranteed(id string, params *stripe.PaymentRecordReportPaymentAttemptGuaranteedParams) (*stripe.PaymentRecord, error)

Report that the most recent payment attempt on the specified Payment Record

was guaranteed.