Script: Class dw.order.PaymentTransaction
Class PaymentTransaction
- Object
- dw.object.PersistentObject
- dw.object.ExtensibleObject
- dw.order.PaymentTransaction
- dw.object.ExtensibleObject
- dw.object.PersistentObject
The PaymentTransaction class represents a payment transaction.
Constants
TYPE_AUTH : String = "AUTH"
Constant representing the authorization type of payment transaction.
TYPE_AUTH_REVERSAL : String = "AUTH_REVERSAL"
Constant representing the authorization reversal type of payment transaction.
TYPE_CAPTURE : String = "CAPTURE"
Constant representing the capture type of payment transaction.
TYPE_CREDIT : String = "CREDIT"
Constant representing the credit type of payment transaction.
Properties
accountID : String
The payment service-specific account id.
accountType : String
The payment service-specific account type.
amount : Money
The amount of the transaction.
paymentInstrument : OrderPaymentInstrument Read Only
The payment instrument related to this payment transaction.
paymentProcessor : PaymentProcessor
The payment processor related to this payment transaction.
transactionID : String
The payment service-specific transaction id.
type : EnumValue
The value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAccountID() : String
Returns the payment service-specific account id.
getAccountType() : String
Returns the payment service-specific account type.
Returns the amount of the transaction.
getPaymentInstrument() : OrderPaymentInstrument
Returns the payment instrument related to this payment transaction.
getPaymentProcessor() : PaymentProcessor
Returns the payment processor related to this payment transaction.
Returns the payment service-specific transaction id.
Returns the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
setAccountID(accountID : String) : void
Sets the payment service-specific account id.
setAccountType(accountType : String) : void
Sets the payment service-specific account type.
setAmount(amount : Money) : void
Sets the amount of the transaction.
setPaymentProcessor(paymentProcessor : PaymentProcessor) : void
Sets the payment processor related to this payment transaction.
setTransactionID(transactionID : String) : void
Sets the payment service-specific transaction id.
Sets the value of the transaction type where permissible values are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
Methods inherited from class ExtensibleObject
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getAccountID
getAccountID() : String
Returns the payment service-specific account id.
Returns:
the payment service-specific account id.
getAccountType
getAccountType() : String
Returns the payment service-specific account type.
Returns:
the payment service-specific account type.
getAmount
getAmount() : Money
Returns the amount of the transaction.
Returns:
the amount of the transaction.
getPaymentInstrument
getPaymentInstrument() : OrderPaymentInstrument
Returns the payment instrument related to this payment transaction.
Returns:
the order payment instrument related to this payment transaction.
getPaymentProcessor
getPaymentProcessor() : PaymentProcessor
Returns the payment processor related to this payment transaction.
Returns:
the payment processor related to this payment transaction.
getTransactionID
getTransactionID() : String
Returns the payment service-specific transaction id.
Returns:
the payment service-specific transaction id.
getType
getType() : EnumValue
Returns the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
Returns:
the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
setAccountID
setAccountID(accountID : String) : void
Sets the payment service-specific account id.
Parameters:
accountID - the payment service-specific account id.
setAccountType
setAccountType(accountType : String) : void
Sets the payment service-specific account type.
Parameters:
accountType - the payment service-specific account type.
setAmount
setAmount(amount : Money) : void
Sets the amount of the transaction.
Parameters:
amount - the amount of the transaction.
setPaymentProcessor
setPaymentProcessor(paymentProcessor : PaymentProcessor) : void
Sets the payment processor related to this payment transaction.
Parameters:
paymentProcessor - the payment processor related to this payment transaction.
setTransactionID
setTransactionID(transactionID : String) : void
Sets the payment service-specific transaction id.
Parameters:
transactionID - the payment service-specific transaction id.
setType
setType(type : String) : void
Sets the value of the transaction type where permissible values are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
Parameters:
type - the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.