orbital

Documentation

Index

• Constants
• type AVSResponseCode
• type ApprovalStatus
• type BIN
• type CVVResponseCode
• type CardSecValInd
• type Credentials
• type CurrencyCode
• type CurrencyExponent
• type IndustryType
• type MessageType
• type OrbitalClient
  • func NewClient(env common.Environment, credentials Credentials) *OrbitalClient
  • func NewWithHttpClient(env common.Environment, credentials Credentials, httpClient *http.Client) *OrbitalClient
  • func (client *OrbitalClient) Authorize(request *sleet.AuthorizationRequest) (*sleet.AuthorizationResponse, error)
  • func (client *OrbitalClient) Capture(request *sleet.CaptureRequest) (*sleet.CaptureResponse, error)
  • func (client *OrbitalClient) Refund(request *sleet.RefundRequest) (*sleet.RefundResponse, error)
  • func (client *OrbitalClient) Void(request *sleet.VoidRequest) (*sleet.VoidResponse, error)
• type Request
• type RequestBody
• type RequestType
• type Response
• type ResponseBody

Constants

const (
	RequestTypeNewOrder = "NewOrder"
	RequestTypeCapture  = "MarkForCapture"
	RequestTypeVoid     = "Reversal"
)

const (
	MIMEVersion             = "1.1"
	ContentType             = "application/PTI80"
	ContentTransferEncoding = "text"
	RequestNumber           = "1"
	DocumentType            = "Request"
)

Request header constants

const (
	ProcStatusSuccess  = 0
	RespCodeApproved   = "00"
	RespCodeNotPresent = "zz" // returned in place of RespCode when none is returned by the api
)

Response constants

const TerminalIDStratus string = "001"

Types

type AVSResponseCode

type AVSResponseCode string

const (
	AVSResponseNotChecked             AVSResponseCode = "3"
	AVSResponseSkipped4               AVSResponseCode = "4"
	AVSResponseSkippedR               AVSResponseCode = "R"
	AVSResponseMatch                  AVSResponseCode = "H"
	AVSResponseNoMatch                AVSResponseCode = "G"
	AVSResponseZipMatchAddressNoMatch AVSResponseCode = "A"
	AVSResponseZipNoMatchAddressMatch AVSResponseCode = "F"
)

type ApprovalStatus

type ApprovalStatus int

const (
	ApprovalStatusDeclined ApprovalStatus = 0
	ApprovalStatusApproved ApprovalStatus = 1
	ApprovalStatusError    ApprovalStatus = 2
)

type BIN

type BIN string

const (
	BINStratus BIN = "000001"
	BINPNS     BIN = "000002"
)

type CVVResponseCode

type CVVResponseCode string

const (
	CVVResponseMatched      CVVResponseCode = "M"
	CVVResponseNotMatched   CVVResponseCode = "N"
	CVVResponseNotProcessed CVVResponseCode = "P"
	CVVResponseNotPresent   CVVResponseCode = "S"
	CVVResponseUnsupported  CVVResponseCode = "U"
	CVVResponseNotValidI    CVVResponseCode = "I"
	CVVResponseNotValidY    CVVResponseCode = "Y"
)

type CardSecValInd

type CardSecValInd int // Card Security Presence Indicator for for a Visa or Discover transaction

const (
	CardSecPresent      CardSecValInd = 1 // Value is Present
	CardSecIllegible    CardSecValInd = 2 // Value on card but illegiable
	CardSecNotAvailable CardSecValInd = 9 // Cardholder states data not available
)

type Credentials

type Credentials struct {
	Username   string
	Password   string
	MerchantID int
}

type CurrencyCode

type CurrencyCode string

const (
	CurrencyCodeUSD CurrencyCode = "840"
	CurrencyCodeCAD CurrencyCode = "124"
	CurrencyCodeGBP CurrencyCode = "826"
	CurrencyCodeEUR CurrencyCode = "978"
)

type CurrencyExponent

type CurrencyExponent string

const CurrencyExponentDefault CurrencyExponent = "2"

type IndustryType

type IndustryType string

const (
	IndustryTypeEcomm       IndustryType = "EC"
	IndustryTypeInstallment IndustryType = "IN"
	IndustryTypeIVR         IndustryType = "IV"
	IndustryTypeMailOrder   IndustryType = "MO"
	IndustryTypeRecurring   IndustryType = "RC"
)

type MessageType

type MessageType string

const (
	MessageTypeAuth            MessageType = "A"
	MessageTypeAuthAndCapture  MessageType = "AC"
	MessageTypeForceAndCapture MessageType = "FC"
	MessageTypeRefund          MessageType = "R"
)

type OrbitalClient

type OrbitalClient struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(env common.Environment, credentials Credentials) *OrbitalClient

func NewWithHttpClient

func NewWithHttpClient(env common.Environment, credentials Credentials, httpClient *http.Client) *OrbitalClient

func (*OrbitalClient) Authorize

func (client *OrbitalClient) Authorize(request *sleet.AuthorizationRequest) (*sleet.AuthorizationResponse, error)

func (*OrbitalClient) Capture

func (client *OrbitalClient) Capture(request *sleet.CaptureRequest) (*sleet.CaptureResponse, error)

func (*OrbitalClient) Refund

func (client *OrbitalClient) Refund(request *sleet.RefundRequest) (*sleet.RefundResponse, error)

func (*OrbitalClient) Void

func (client *OrbitalClient) Void(request *sleet.VoidRequest) (*sleet.VoidResponse, error)

type Request

type Request struct {
	XMLName xml.Name `xml:"Request"`
	Body    RequestBody
}

type RequestBody

type RequestBody struct {
	XMLName                   xml.Name
	OrbitalConnectionUsername string           `xml:"OrbitalConnectionUsername"`
	OrbitalConnectionPassword string           `xml:"OrbitalConnectionPassword"`
	IndustryType              IndustryType     `xml:"IndustryType,omitempty"`
	MessageType               MessageType      `xml:"MessageType,omitempty"`
	BIN                       BIN              `xml:"BIN"`
	MerchantID                int              `xml:"MerchantID,omitempty"`
	TerminalID                string           `xml:"TerminalID"` // usually 001, for PNS can be 001 - 999 but usually 001
	AccountNum                string           `xml:"AccountNum,omitempty"`
	Exp                       string           `xml:"Exp,omitempty"` //Format: MMYY or YYYYMM
	CurrencyCode              CurrencyCode     `xml:"CurrencyCode,omitempty"`
	CurrencyExponent          CurrencyExponent `xml:"CurrencyExponent,omitempty"`
	CardSecValInd             CardSecValInd    `xml:"CardSecValInd,omitempty"`
	CardSecVal                string           `xml:"CardSecVal,omitempty"`
	AdjustedAmt               int64            `xml:"AdjustedAmt,omitempty"` //int with the last 2 digits being implied decimals ie 100.25 is sent as 10025, 90 is sent as 9000
	TxRefNum                  string           `xml:"TxRefNum,omitempty"`
	AVSzip                    string           `xml:"AVSzip,omitempty"`
	AVSaddress1               string           `xml:"AVSaddress1,omitempty"`
	AVSaddress2               *string          `xml:"AVSaddress2,omitempty"`
	AVScity                   string           `xml:"AVScity,omitempty"`
	AVSstate                  string           `xml:"AVSstate,omitempty"`
	AVSname                   string           `xml:"AVSname,omitempty"`
	AVScountryCode            string           `xml:"AVScountryCode,omitempty"`
	AVSphoneNum               string           `xml:"AVSphoneNum,omitempty"`
	OrderID                   string           `xml:"OrderID,omitempty"`                // generated id, max 22 chars
	Amount                    int64            `xml:"Amount,omitempty"`                 //int with the last 2 digits being implied decimals ie 100.25 is sent as 10025, 90 is sent as 9000
	DPANInd                   string           `xml:"DPANInd,omitempty"`                // does this token represent a device based Primary Account Number (DPAN). Y if yes, omit if not. Pan goes in AccountNum
	DigitalTokenCryptogram    string           `xml:"DigitalTokenCryptogram,omitempty"` // cryptogram for network tokenized cards (i.e. ApplePay)
}

type RequestType

type RequestType string

type Response

type Response struct {
	XMLName xml.Name     `xml:"Response"`
	Body    ResponseBody `xml:",any"`
}

type ResponseBody

type ResponseBody struct {
	XMLName        xml.Name
	IndustryType   string          `xml:"IndustryType"`
	MessageType    string          `xml:"MessageType"`
	MerchantID     int             `xml:"MerchantID"`
	TerminalID     int             `xml:"TerminalID"`
	AccountNum     string          `xml:"AccountNum"`
	OrderID        string          `xml:"OrderID"`
	TxRefNum       string          `xml:"TxRefNum"`
	TxRefIdx       int             `xml:"TxRefIdx"`
	RespCode       string          `xml:"RespCode"`
	StatusMsg      string          `xml:"StatusMsg"`
	ProcStatus     int             `xml:"ProcStatus"`
	AVSRespCode    AVSResponseCode `xml:"AVSRespCode"`
	CVV2RespCode   CVVResponseCode `xml:"CVV2RespCode"`
	ApprovalStatus ApprovalStatus  `xml:"ApprovalStatus"`
	RedeemedAmount int             `xml:"RedeemedAmount"`
}