paymentrequest

Documentation

Index

• Variables
• type Fee
  • func (f *Fee) Clone() Fee
  • func (f *Fee) CopyTo(dst *Fee)
  • func (f *Fee) Validate() error
• type Record
  • func (r *Record) Clone() Record
  • func (r *Record) CopyTo(dst *Record)
  • func (r *Record) HasLogin() bool
  • func (r *Record) RequiresPayment() bool
  • func (r *Record) Validate() error
• type Store

Variables

var (
	ErrPaymentRequestAlreadyExists = errors.New("payment request record already exists")
	ErrPaymentRequestNotFound      = errors.New("no payment request records could be found")
	ErrInvalidPaymentRequest       = errors.New("payment request is invalid")
)

Types

type Fee

type Fee struct {
	DestinationTokenAccount string
	BasisPoints             uint16
}

func (*Fee) Clone

func (f *Fee) Clone() Fee

func (*Fee) CopyTo

func (f *Fee) CopyTo(dst *Fee)

func (*Fee) Validate

func (f *Fee) Validate() error

type Record

type Record struct {
	Id uint64

	Intent string

	// Payment fields
	DestinationTokenAccount *string
	ExchangeCurrency        *string
	NativeAmount            *float64
	ExchangeRate            *float64
	Quantity                *uint64
	Fees                    []*Fee

	// Login fields
	Domain     *string
	IsVerified bool

	CreatedAt time.Time
}

Currently, the model supports payment, login, or both.

todo: Refactor to a structure similar to intent as we add more request use cases.

func (*Record) Clone

func (r *Record) Clone() Record

func (*Record) CopyTo

func (r *Record) CopyTo(dst *Record)

func (*Record) HasLogin

func (r *Record) HasLogin() bool

func (*Record) RequiresPayment

func (r *Record) RequiresPayment() bool

func (*Record) Validate

func (r *Record) Validate() error

type Store

type Store interface {
	// Put creates a new payment request record
	Put(ctx context.Context, record *Record) error

	// Get gets a paymen request record by its intent ID
	Get(ctx context.Context, intentId string) (*Record, error)
}