checkout

Documentation

Overview

Package checkout implements all checkout related logic and includes all checkout related models.

Models included in this package:

PDT: Payment Data Transfer
IPN: Instant Payment Notification
Checkout: YenePay's Payment Order

Index

• type CartCheckoutItem
  • func NewCartCheckoutItem(params CartParams) *CartCheckoutItem
• type CartParams
• type ExpressCheckoutItem
  • func NewExpressCheckoutItem(params ExpressParams) *ExpressCheckoutItem
• type ExpressParams
• type Option
  • func NewOption(params OptionsParams) *Option
  • func (option *Option) GetExpressFields() interface{}
  • func (option *Option) SetOrderFees(totalItemsDeliveryFee float64, totalItemsDiscount float64, ...)
• type OptionsParams
• type PdtParams
• type PdtRequest
  • func NewPdtRequest(params PdtParams) *PdtRequest
• type PdtResponse
• type Type
• type YenePayCheckOut
  • func NewYenePayCheckOut() *YenePayCheckOut
  • func (checkout *YenePayCheckOut) CartCheckoutURL(checkoutOptions *Option, cartItems []CartCheckoutItem) string
  • func (checkout *YenePayCheckOut) ExpressCheckoutURL(checkoutOptions *Option, checkoutItem *ExpressCheckoutItem) string
  • func (checkout *YenePayCheckOut) IsIPNAuthentic(ipnModel interface{}, useSandbox bool) (bool, error)
  • func (checkout *YenePayCheckOut) RequestPDT(pdtReq PdtRequest) (interface{}, error)

Types

type CartCheckoutItem

type CartCheckoutItem struct {
	ItemID    string
	ItemName  string
	UnitPrice float64
	Quantity  int
}

CartCheckoutItem - model

func NewCartCheckoutItem

func NewCartCheckoutItem(params CartParams) *CartCheckoutItem

NewCartCheckoutItem - CartCheckoutItem Constructor

type CartParams

type CartParams CartCheckoutItem

CartParams - argument for constructor

type ExpressCheckoutItem

type ExpressCheckoutItem struct {
	ItemID      string  `validate:"required,min=1"`
	ItemName    string  `validate:"required,min=1"`
	UnitPrice   float64 `validate:"min=0.1"`
	Quantity    int     `validate:"min=1"`
	Discount    float64 `validate:"min=0.0"`
	HandlingFee float64 `validate:"min=0.0"`
	DeliveryFee float64 `validate:"min=0.0"`
	Tax1        float64 `validate:"min=0.0"`
	Tax2        float64 `validate:"min=0.0"`
}

ExpressCheckoutItem - model

func NewExpressCheckoutItem

func NewExpressCheckoutItem(
	params ExpressParams,
) *ExpressCheckoutItem

NewExpressCheckoutItem - ExpressCheckoutItem Constructor

type ExpressParams

type ExpressParams ExpressCheckoutItem

ExpressParams - argument type for constructor

type Option

type Option struct {
	UseSandbox            bool
	Process               Type
	MerchantID            string `validate:"required"`
	SuccessURL            string
	CancelURL             string
	IPNURL                string
	FailureURL            string
	ExpiresAfter          int
	MerchantOrderID       string
	TotalItemsDeliveryFee float64
	TotalItemsTax1        float64
	TotalItemsTax2        float64
	TotalItemsDiscount    float64
	TotalItemsHandlingFee float64
}

Option - checkout option model

func NewOption

func NewOption(
	params OptionsParams,
) *Option

NewOption - Option Constructor

func (*Option) GetExpressFields

func (option *Option) GetExpressFields() interface{}

GetExpressFields - Return Only Required Fields for Express Checkout I.e. Exclude all Fields that start with 'Total'

func (*Option) SetOrderFees

func (option *Option) SetOrderFees(totalItemsDeliveryFee float64, totalItemsDiscount float64, totalItemsHandlingFee float64, totalItemsTax1, totalItemsTax2 float64)

SetOrderFees - Set Order Total Fees I.e. Set Fields that start with 'Total'

type OptionsParams

type OptionsParams Option

OptionsParams - arugment for constructor

type PdtParams

type PdtParams PdtRequest

PdtParams - arguments for PDT request constructor.

type PdtRequest

type PdtRequest struct {
	PdtToken        string `validate:"required,min=1"`
	TransactionID   string
	MerchantOrderID string
	UseSandbox      bool `json:"-"`
	RequestType     string
}

PdtRequest - request model for transaction verification

func NewPdtRequest

func NewPdtRequest(
	params PdtParams,
) *PdtRequest

NewPdtRequest - PDT Constructor

type PdtResponse

type PdtResponse struct {
	PdtToken        string `validate:"required,min=1"`
	TransactionID   string
	MerchantOrderID string
	UseSandbox      bool `json:"-"`
	RequestType     string
}

PdtResponse - result of transaction verificaiton(pdt request)

type Type

type Type string

Type - model

const CartCheckout Type = "Cart"

CartCheckout - Cart Checkout Type

const ExpressCheckout Type = "Express"

ExpressCheckout - Express Checkout Type

type YenePayCheckOut

type YenePayCheckOut struct {
}

YenePayCheckOut - main checkout model

func NewYenePayCheckOut

func NewYenePayCheckOut() *YenePayCheckOut

NewYenePayCheckOut - YenePayCheckOut Constructor

func (*YenePayCheckOut) CartCheckoutURL

func (checkout *YenePayCheckOut) CartCheckoutURL(checkoutOptions *Option, cartItems []CartCheckoutItem) string

CartCheckoutURL - Generate Checkout URL for Cart Checkout

func (*YenePayCheckOut) ExpressCheckoutURL

func (checkout *YenePayCheckOut) ExpressCheckoutURL(checkoutOptions *Option, checkoutItem *ExpressCheckoutItem) string

ExpressCheckoutURL - Generate Checkout URL for Express Checkout

func (*YenePayCheckOut) IsIPNAuthentic

func (checkout *YenePayCheckOut) IsIPNAuthentic(ipnModel interface{}, useSandbox bool) (bool, error)

IsIPNAuthentic - check IPN authenticity (WIP)

func (*YenePayCheckOut) RequestPDT

func (checkout *YenePayCheckOut) RequestPDT(pdtReq PdtRequest) (interface{}, error)

RequestPDT - Request PDT model (WIP)