Namespace: payments

payments

Classes

AdditionalChargeAmount
AssociatedPayment
AssociatedPayments
Authorization
Batch
BatchCardTotal
BatchDetail
BatchRequest
BatchTotalStats
BatchTotalType
BatchTransactions
CardlessPaymentData
CardTransaction
CashAdvanceCustomerIdentification
CashAdvanceExtra
Credit
CreditRefund
CreditRefundResponse
CreditRequest
CreditResponse
DCCInfo
DeviceTotalStats
DiscountApprover
ECommTransactionInfo
EndpointTotalStats
FailedBatchSettlement
FraudResponseReason
GatewayTxs
GermanInfo
GiftCard
GiftCardResponse
GiftCardTransaction
IncrementalAuthorization
LineItemPayment
Payment
PaymentAttribute
PaymentResponse
PaymentResponseFraudSetting
PaymentTaxRate
PromotionalMessage
Refund
RefundRequest
RefundResponse
RegionalExtras
ServerTotalStats
ServiceChargeAmount
ServiceFeeRefundRequest
ServiceFeeRequest
SignatureDisclaimer
Tag
TaxableAmountRate
TerminalConfig
TerminalManagementComponent
TerminalManagementErrorAction
TerminalManagementEvent
TerminalManagementPlan
TerminalManagementPlanAction
TerminalManagementRequest
TerminalManagementTimeCondition
TerminalParam
TerminalParameter
TokenRequest
Transaction
TransactionInfo
TransactionSettings
VasConfig
VasDataType
VasPayload
VasPayloadElement
VasPayloadResponse
VasServiceProvider
VasSettings
VaultedCard

Members

(static) AccountType :string

Type:
  • string
Properties:
Name Type Description
CREDIT string
DEBIT string
CHECKING string
SAVINGS string
Source:

(static) AdditionalChargeType :string

Type of additional charge. INTERAC is deprecated, use INTERAC_V2
Type:
  • string
Properties:
Name Type Description
INTERAC string
CREDIT_SURCHARGE string
CONVENIENCE_FEE string
INTERAC_V2 string
Source:

(static) AssociationType :string

Type:
  • string
Properties:
Name Type Description
GOVT_ED_SERVICE_FEE string
Source:

(static) AVSResult :string

Type:
  • string
Properties:
Name Type Description
SUCCESS string
ZIP_CODE_MATCH string
ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED string
ADDRESS_MATCH string
ADDRESS_MATCH_ZIP_NOT_CHECKED string
NEITHER_MATCH string
SERVICE_FAILURE string
SERVICE_UNAVAILABLE string
NOT_CHECKED string
ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED string
ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED string
Source:

(static) BatchState :string

Type:
  • string
Properties:
Name Type Description
OPEN string
QUEUED_FOR_PROCESSING string
PROCESSING string
CLOSED string
FAILED string
Source:

(static) BatchType :string

Type:
  • string
Properties:
Name Type Description
MANUAL_CLOSE string
AUTO_CLOSE string
Source:

(static) CardEntryType :string

Type:
  • string
Properties:
Name Type Description
SWIPED string
KEYED string
VOICE string
VAULTED string
OFFLINE_SWIPED string
OFFLINE_KEYED string
EMV_CONTACT string
EMV_CONTACTLESS string
MSD_CONTACTLESS string
PINPAD_MANUAL_ENTRY string
QR_CODE string
SCANNED string
Source:

(static) CardlessPaymentDataType :string

Type:
  • string
Properties:
Name Type Description
QR_CODE string
BARCODE string
Source:

(static) CardlessPaymentNetwork :string

Type:
  • string
Properties:
Name Type Description
ALIPAY string
WECHAT string
Source:

(static) CardTransactionState :string

Type:
  • string
Properties:
Name Type Description
PENDING string
CLOSED string
Source:

(static) CardTransactionType :string

Type:
  • string
Properties:
Name Type Description
AUTH string
PREAUTH string
PREAUTHCAPTURE string
ADJUST string
VOID string
VOIDRETURN string
RETURN string
REFUND string
NAKEDREFUND string
GETBALANCE string
BATCHCLOSE string
ACTIVATE string
BALANCE_LOCK string
LOAD string
CASHOUT string
CASHOUT_ACTIVE_STATUS string
REDEMPTION string
REDEMPTION_UNLOCK string
RELOAD string
CASH_ADVANCE string
VOID_CREDIT string
REFUND_CREDIT string
INTERNET_ACTIVATE string
TOKEN_REQUEST string
VERIFICATION string
Source:

(static) CardType :string

Type:
  • string
Properties:
Name Type Description
VISA string
MC string
AMEX string
DISCOVER string
DINERS_CLUB string
JCB string
MAESTRO string
SOLO string
LASER string
CHINA_UNION_PAY string
CARTE_BLANCHE string
UNKNOWN string
GIFT_CARD string
EBT string
GIROCARD string
INTERAC string
OTHER string
Source:

(static) Currency :string

Type:
  • string
Properties:
Name Type Description
USD string
GBP string
EUR string
Source:

(static) CvmResult :string

Type:
  • string
Properties:
Name Type Description
NO_CVM_REQUIRED string
SIGNATURE string
SIGNATURE_VERIFIED string
SIGNATURE_ON_PAPER string
SIGNATURE_REJECTED string
PIN string
ONLINE_PIN string
SIGNATURE_AND_PIN string
CVM_FAILED string
DEVICE string
Source:

(static) CVVResult :string

Type:
  • string
Properties:
Name Type Description
SUCCESS string
FAILURE string
NOT_PROCESSED string
NOT_PRESENT string
Source:

(static) DataEntryLocation :string

Type:
  • string
Properties:
Name Type Description
ON_SCREEN string
ON_PAPER string
NONE string
Source:

(static) FraudResponseAction :string

Type:
  • string
Properties:
Name Type Description
VOID string
PROMPT string
IGNORE string
DECLINE string
Source:

(static) FraudResponseCodeType :string

Type:
  • string
Properties:
Name Type Description
AVS string
CVV string
Source:

(static) GatewayTxState :string

Type:
  • string
Properties:
Name Type Description
INITIATED string
INITIATED_ON_AUTH string
ACKNOWLEDGED string
CONNECT_FAILED string
TIMEOUT string
FAILED string
REVERSE_INITIATED string
REVERSE_INITIATED_ON_AUTH string
REVERSED string
REVERSAL_FAILED string
EXTERNAL string
Source:

(static) GatewayTxType :string

Type:
  • string
Properties:
Name Type Description
AUTH string
PREAUTH string
PREAUTHCAPTURE string
ADJUST string
VOID string
VOIDRETURN string
RETURN string
REFUND string
NAKEDREFUND string
GETBALANCE string
BATCHCLOSE string
ACTIVATE string
BALANCE_LOCK string
LOAD string
CASHOUT string
CASHOUT_ACTIVE_STATUS string
REDEMPTION string
REDEMPTION_UNLOCK string
RELOAD string
CASH_ADVANCE string
INTERNET_ACTIVATE string
TOKEN_REQUEST string
VERIFICATION string
Source:

(static) GiftCardState :string

Type:
  • string
Properties:
Name Type Description
INVALID string
ACTIVATED string
INACTIVE string
Source:

(static) IdType :string

Identification type
Type:
  • string
Properties:
Name Type Description
DRIVERS_LICENSE string
PASSPORT string
Source:

(static) ManagementPlanActionAdditionalProcess :string

Type:
  • string
Properties:
Name Type Description
RECONCILIATION string
MANUAL_CONFIRMATION string
RESTART string
Source:

(static) ManagementPlanActionTriggerType :string

Type of event to trigger the action
Type:
  • string
Properties:
Name Type Description
DATE_TIME string
HOST string
MANUAL string
SALE_EVENT string
Source:

(static) ManagementPlanActionType :string

Type of action to take
Type:
  • string
Properties:
Name Type Description
DELETE string
RESTART string
DOWNLOAD string
UPLOAD string
Source:

(static) ManagementPlanDataType :string

Type of data to act on during the action execution
Type:
  • string
Properties:
Name Type Description
ACQUIRER_PARAMETERS string
APPLICATION_PARAMETERS string
MANAGEMENT_PLAN string
MERCHANT_PARAMETERS string
PARAMETERS string
SECURITY_PARAMETERS string
SOFTWARE_MODULE string
STATUS_REPORT string
TERMINAL_PARAMETERS string
VENDOR_PARAMETERS string
Source:

(static) OverrideType :string

Type:
  • string
Properties:
Name Type Description
RESELLER string
MERCHANT_GROUP string
Source:

(static) ParamType :string

Type:
  • string
Properties:
Name Type Description
TAG_32_16 string
TAG_16_8 string
DECIMAL string
STRING string
BOOLEAN string
DELIMITED_HEX_BINARY string
HEX_BINARY string
Source:

(static) Result :string

The expected values of the payment.result and credit.result fields
Type:
  • string
Properties:
Name Type Description
SUCCESS string
FAIL string
INITIATED string
VOIDED string
VOIDING string
VOID_FAILED string
AUTH string
AUTH_COMPLETED string
DISCOUNT string
Source:

(static) ReversalReason :string

Type:
  • string
Properties:
Name Type Description
CHIP_DECLINE string
CARDHOLDER_CANCELLATION string
COMMUNICATION_ERROR string
OTHER_REASON string
Source:

(static) SelectedService :string

Type:
  • string
Properties:
Name Type Description
NONE string
PAYMENT string
REFUND string
CANCELLATION string
PRE_AUTH string
UPDATE_PRE_AUTH string
PAYMENT_COMPLETION string
CASH_ADVANCE string
DEFERRED_PAYMENT string
DEFERRED_PAYMENT_COMPLETION string
VOICE_AUTHORISATION string
CARDHOLDER_DETECTION string
TOKEN_REQUEST string
VERIFICATION string
Source:

(static) TerminalManagementActionResult :string

Type:
  • string
Properties:
Name Type Description
ACCESS_DENIED string
CONNECTION_ERROR string
FORMAT_ERROR string
INVALID_CONTENT string
LENGTH_ERROR string
MEMORY_OVERFLOW string
MISSING_FILE string
NOT_SUPPORTED string
SIGNATURE_ERROR string
SUCCESS string
SYNTAX_ERROR string
TIMEOUT string
UNKNOWN_DATA string
UNKNOWN_KEY_REF string
INVALID_DELEGATION_PROOF string
INVALID_DELEGATION_MGMT_PLAN string
DELEGATION_PARAMS_UNAUTHORIZED string
Source:

(static) TerminalManagementComponentType :string

Type:
  • string
Properties:
Name Type Description
ACQUIRER_PROTOCOL_PARAMS string
APPLICATION_PARAMS string
TERMINAL_PARAMS string
SECURITY_PARAMS string
SERVER string
TERMINAL string
DEVICE string
SECURE_MODULE string
PAYMENT_APPLICATION string
EMV_KERNEL string
EMV_LEVEL1 string
MIDDLEWARE string
DRIVER string
OPERATING_SYSTEM string
MERCHANT_PARAMS string
CERTIFICATE_PARAMS string
TMS_PROTOCOL_PARAMS string
Source:

(static) TerminalManagementErrorActionType :string

Type:
  • string
Properties:
Name Type Description
STATUS_REPORT string
STOP string
Source:

(static) TimeConditionType :string

Type:
  • string
Properties:
Name Type Description
WAITING_TIME string
START_TIME string
END_TIME string
PERIODIC string
Source:

(static) TipMode :string

Type:
  • string
Properties:
Name Type Description
TIP_PROVIDED string
ON_SCREEN_BEFORE_PAYMENT string
ON_SCREEN_AFTER_PAYMENT string
ON_PAPER string
NO_TIP string
Source:

(static) TokenRequestType :string

Type:
  • string
Properties:
Name Type Description
VERIFICATION string
TOKEN_REQUEST string
Source:

(static) TransactionResult :string

Type:
  • string
Properties:
Name Type Description
APPROVED string
DECLINED string
ABORTED string
VOICE_AUTHORISATION string
PAYMENT_PART_ONLY string
PARTIALLY_APPROVED string
NONE string
Source:

(static) TxFormat :string

Type:
  • string
Properties:
Name Type Description
DEFAULT string
NEXO string
Source:

(static) TxType :string

Type:
  • string
Properties:
Name Type Description
AUTH string
PREAUTH string
PREAUTHCAPTURE string
ADJUST string
VOID string
VOIDRETURN string
RETURN string
REFUND string
NAKEDREFUND string
GETBALANCE string
BATCHCLOSE string
ACTIVATE string
BALANCE_LOCK string
LOAD string
CASHOUT string
CASHOUT_ACTIVE_STATUS string
REDEMPTION string
REDEMPTION_UNLOCK string
RELOAD string
INTERNET_ACTIVATE string
Source:

(static) Type :string

Type:
  • string
Properties:
Name Type Description
TAB string
AUTH string
Source:

(static) VasDataTypeType :string

Type:
  • string
Properties:
Name Type Description
ALL string
LOYALTY string
OFFER string
GIFT_CARD string
PRIVATE_LABEL_CARD string
CUSTOMER string
VAS_DATA string
Source:

(static) VasMode :string

Type:
  • string
Properties:
Name Type Description
PAY_ONLY string
VAS_ONLY string
VAS_OR_PAYMENT string
VAS_AND_PAYMENT string
Source:

(static) VasPayloadResponseType :string

Type:
  • string
Properties:
Name Type Description
ACCEPTED string
PENDING string
Source:

(static) VasProtocol :string

Protocol identifier
Type:
  • string
Properties:
Name Type Description
ST string
PK string
Source:

(static) VasPushMode :string

Type:
  • string
Properties:
Name Type Description
PUSH_NONE string
PUSH_ONLY string
PUSH_AND_GET string
Source:

(static) VasResponseFormat :string

Type:
  • string
Properties:
Name Type Description
NDEF string
STRING string
ENCRYPTED string
Source: