API Documentation

Classes

Namespace: CardknoxApi

• AvsResponseType: enum - Indicates AVS operation response
• Cardknox: Primary operation class, all operations are member methods of this object
• CardknoxRequest: Passed into Cardknox instantiation, contains authentication credentials
• CardknoxResponse: Returned from all operational methods
• CardType: Indicates card type (Visa, MasterCard, etc)
• Customer: contains customer-specific fields, such as billing/shipping address, fax, email, etc
• OrderType: enum - Internet/Phone, used in fraud:submit
• ResultType: enum - Single character indicating result (A, D, or E)
• StatusType: enum - Indicates the status of the transaction (Approved, Declined, or Error)

Namespace: CardknoxApi.Operations

Except where noted, operation classes inherit from OperationBase

Base Classes

• OperationBase: inherits from CardknoxApi.Customer, contains Token, CardNum, Exp, and other payment-related properties
• Sale: inherits from OperationBase, special sale-only fields

Credit Card

• CCAdjust - cc:adjust
  • Special Field: RefNum, REQUIRED
• CCAuthOnly - cc:authonly inherits from: Sale
• CCCapture - cc:capture inherits from: Sale
  • Special Field: RefNum, REQUIRED
• CCCredit - cc:credit inherits from: Sale
• CCPostAuth - cc:postauth inherits from: Sale
  • Special Field: AuthCode, REQUIRED
• CCRefund - cc:refund
  • Special Field: RefNum, REQUIRED
• CCSale - cc:sale inherits from: Sale
• CCSave - cc:save
• CCVoid - cc:void
  • Special Field: RefNum, REQUIRED
• CCVoidRefund - cc:voidrefund
  • Special Field: RefNum, REQUIRED
• CCVoidRelease - cc:voidrelease
  • Special Field: RefNum, REQUIRED