coinpayments

Documentation

Index

• func GetCheckoutURL(key string, id TransactionID) string
• type Status
  • func (s Status) Int() int
  • func (s Status) String() string
• type TransactionID
  • func (id TransactionID) String() string
• type TransactionIDList
  • func (list TransactionIDList) Encode() string

Functions

func GetCheckoutURL

func GetCheckoutURL(key string, id TransactionID) string

GetCheckoutURL constructs checkout url from auth key and transaction id.

Types

type Status

type Status int

Status is a type wrapper for transaction statuses.

const (
	// StatusCancelled defines cancelled or timeout transaction.
	StatusCancelled Status = -1
	// StatusPending defines pending transaction which is waiting for buyer funds.
	StatusPending Status = 0
	// StatusReceived defines transaction which successfully received required amount of funds.
	StatusReceived Status = 1
	// StatusCompleted defines transaction which is fully completed.
	StatusCompleted Status = 100
)

func (Status) Int

func (s Status) Int() int

Int returns int representation of status.

func (Status) String

func (s Status) String() string

String returns string representation of status.

type TransactionID

type TransactionID string

TransactionID is type wrapper for transaction id.

func (TransactionID) String

func (id TransactionID) String() string

String returns string representation of transaction id.

type TransactionIDList

type TransactionIDList []TransactionID

TransactionIDList is a type wrapper for list of transactions.

func (TransactionIDList) Encode

func (list TransactionIDList) Encode() string

Encode returns encoded string representation of transaction id list.