JSDoc: Namespace: payments

Source:

payments/index.js, line 3

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:

payments/AccountType.js, line 12

(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:

payments/AdditionalChargeType.js, line 13

(static) AssociationType :string

Type:

string

Properties:

Name	Type	Description
`GOVT_ED_SERVICE_FEE`	string

Source:

payments/AssociationType.js, line 12

(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:

payments/AVSResult.js, line 12

(static) BatchState :string

Type:

string

Properties:

Name	Type	Description
`OPEN`	string
`QUEUED_FOR_PROCESSING`	string
`PROCESSING`	string
`CLOSED`	string
`FAILED`	string

Source:

payments/BatchState.js, line 12

(static) BatchType :string

Type:

string

Properties:

Name	Type	Description
`MANUAL_CLOSE`	string
`AUTO_CLOSE`	string

Source:

payments/BatchType.js, line 12

(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:

payments/CardEntryType.js, line 12

(static) CardlessPaymentDataType :string

Type:

string

Properties:

Name	Type	Description
`QR_CODE`	string
`BARCODE`	string

Source:

payments/CardlessPaymentDataType.js, line 12

(static) CardlessPaymentNetwork :string

Type:

string

Properties:

Name	Type	Description
`ALIPAY`	string
`WECHAT`	string

Source:

payments/CardlessPaymentNetwork.js, line 12

(static) CardTransactionState :string

Type:

string

Properties:

Name	Type	Description
`PENDING`	string
`CLOSED`	string

Source:

payments/CardTransactionState.js, line 12

(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:

payments/CardTransactionType.js, line 12

(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:

payments/CardType.js, line 12

(static) Currency :string

Type:

string

Properties:

Name	Type	Description
`USD`	string
`GBP`	string
`EUR`	string

Source:

payments/Currency.js, line 12

(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:

payments/CvmResult.js, line 12

(static) CVVResult :string

Type:

string

Properties:

Name	Type	Description
`SUCCESS`	string
`FAILURE`	string
`NOT_PROCESSED`	string
`NOT_PRESENT`	string

Source:

payments/CVVResult.js, line 12

(static) DataEntryLocation :string

Type:

string

Properties:

Name	Type	Description
`ON_SCREEN`	string
`ON_PAPER`	string
`NONE`	string

Source:

payments/DataEntryLocation.js, line 12

(static) FraudResponseAction :string

Type:

string

Properties:

Name	Type	Description
`VOID`	string
`PROMPT`	string
`IGNORE`	string
`DECLINE`	string

Source:

payments/FraudResponseAction.js, line 12

(static) FraudResponseCodeType :string

Type:

string

Properties:

Name	Type	Description
`AVS`	string
`CVV`	string

Source:

payments/FraudResponseCodeType.js, line 12

(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:

payments/GatewayTxState.js, line 12

(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:

payments/GatewayTxType.js, line 12

(static) GiftCardState :string

Type:

string

Properties:

Name	Type	Description
`INVALID`	string
`ACTIVATED`	string
`INACTIVE`	string

Source:

payments/GiftCardState.js, line 12

(static) IdType :string

Identification type

Type:

string

Properties:

Name	Type	Description
`DRIVERS_LICENSE`	string
`PASSPORT`	string

Source:

payments/IdType.js, line 13

(static) ManagementPlanActionAdditionalProcess :string

Type:

string

Properties:

Name	Type	Description
`RECONCILIATION`	string
`MANUAL_CONFIRMATION`	string
`RESTART`	string

Source:

payments/ManagementPlanActionAdditionalProcess.js, line 12

(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:

payments/ManagementPlanActionTriggerType.js, line 13

(static) ManagementPlanActionType :string

Type of action to take

Type:

string

Properties:

Name	Type	Description
`DELETE`	string
`RESTART`	string
`DOWNLOAD`	string
`UPLOAD`	string

Source:

payments/ManagementPlanActionType.js, line 13

(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:

payments/ManagementPlanDataType.js, line 13

(static) OverrideType :string

Type:

string

Properties:

Name	Type	Description
`RESELLER`	string
`MERCHANT_GROUP`	string

Source:

payments/OverrideType.js, line 12

(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:

payments/ParamType.js, line 12

(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:

payments/Result.js, line 13

(static) ReversalReason :string

Type:

string

Properties:

Name	Type	Description
`CHIP_DECLINE`	string
`CARDHOLDER_CANCELLATION`	string
`COMMUNICATION_ERROR`	string
`OTHER_REASON`	string

Source:

payments/ReversalReason.js, line 12

(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:

payments/SelectedService.js, line 12

(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:

payments/TerminalManagementActionResult.js, line 12

(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:

payments/TerminalManagementComponentType.js, line 12

(static) TerminalManagementErrorActionType :string

Type:

string

Properties:

Name	Type	Description
`STATUS_REPORT`	string
`STOP`	string

Source:

payments/TerminalManagementErrorActionType.js, line 12

(static) TimeConditionType :string

Type:

string

Properties:

Name	Type	Description
`WAITING_TIME`	string
`START_TIME`	string
`END_TIME`	string
`PERIODIC`	string

Source:

payments/TimeConditionType.js, line 12

(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:

payments/TipMode.js, line 12

(static) TokenRequestType :string

Type:

string

Properties:

Name	Type	Description
`VERIFICATION`	string
`TOKEN_REQUEST`	string

Source:

payments/TokenRequestType.js, line 12

(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:

payments/TransactionResult.js, line 12

(static) TxFormat :string

Type:

string

Properties:

Name	Type	Description
`DEFAULT`	string
`NEXO`	string

Source:

payments/TxFormat.js, line 12

(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