Class PaymentTransaction

dw.order

Object

dw.object.PersistentObject

dw.object.ExtensibleObject

dw.order.PaymentTransaction

The PaymentTransaction class represents a payment transaction.

POST_AUTH_FRAUD_DECISION_GUARANTEED : String = "GUARANTEED"

Constant indicating a fraud provider post-authorization decision to guarantee a payment transaction.

POST_AUTH_FRAUD_DECISION_NOT_GUARANTEED : String = "NOT_GUARANTEED"

Constant indicating a fraud provider post-authorization decision to not guarantee a payment transaction.

POST_AUTH_FRAUD_DECISION_NOT_REVIEWED : String = "NOT_REVIEWED"

Constant indicating a fraud provider did not review a payment transaction post-authorization.

POST_AUTH_FRAUD_DECISION_PENDING : String = "PENDING"

Constant representing a pending asynchronous post-authorization fraud decision.

PRE_AUTH_FRAUD_DECISION_APPROVED : String = "APPROVED"

Constant indicating a fraud provider pre-authorization decision to approve a payment transaction.

PRE_AUTH_FRAUD_DECISION_CHALLENGE : String = "CHALLENGE"

Constant indicating a fraud provider pre-authorization decision to challenge a payment transaction.

PRE_AUTH_FRAUD_DECISION_DECLINED : String = "DECLINED"

Constant representing a fraud provider pre-authorization decision to decline a payment transaction.

PRE_AUTH_FRAUD_DECISION_NOT_REVIEWED : String = "NOT_REVIEWED"

Constant indicating a fraud provider did not review a payment transaction pre-authorization.

STATUS_AUTHORIZATIONVOIDED : Number = 4

Status constant: authorization voided or canceled.

STATUS_AUTHORIZED : Number = 1

Status constant: authorization successful.

STATUS_CAPTURED : Number = 3

Status constant: wholly captured.

STATUS_CAPTUREVOIDED : Number = 5

Status constant: capture voided.

STATUS_CREATED : Number = 0

Status constant: newly created, not yet processed.

STATUS_MARKED : Number = 6

Status constant: marked for batch settlement.

STATUS_PARTCAPTURED : Number = 2

Status constant: partly but not wholly captured.

STATUS_SETTLED : Number = 7

Status constant: batch settlement confirmed.

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.

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.

postAuthFraudDecision : String

The post-authorization fraud decision, or null if not set.

preAuthFraudDecision : String

The pre-authorization fraud decision, or null if not set.

status : Number

The status of this payment transaction.

transactionDetails : SalesforceTransactionDetails

The transaction details for this payment transaction, or null if none have been set.

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.

This class does not have a constructor, so you cannot create it directly.

getAccountID() : String

Returns the payment service-specific account id.

getAccountType() : String

Returns the payment service-specific account type.

getAmount() : Money

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.

getPostAuthFraudDecision() : String

Returns the post-authorization fraud decision, or null if not set.

getPreAuthFraudDecision() : String

Returns the pre-authorization fraud decision, or null if not set.

getStatus() : Number

Returns the status of this payment transaction.

getTransactionDetails() : SalesforceTransactionDetails

Returns the transaction details for this payment transaction, or null if none have been set.

getTransactionID() : String

Returns the payment service-specific transaction id.

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.

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.

setPostAuthFraudDecision(postAuthFraudDecision : String) : void

Sets the post-authorization fraud decision.

setPreAuthFraudDecision(preAuthFraudDecision : String) : void

Sets the pre-authorization fraud decision.

setStatus(status : Number) : void

Sets the status of this payment transaction.

setTransactionDetails(transactionDetails : SalesforceTransactionDetails) : void

Sets the transaction details on this payment transaction.

setTransactionID(transactionID : String) : void

Sets the payment service-specific transaction id.

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.

Methods inherited from class ExtensibleObject

describe, getCustom

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

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.

getPostAuthFraudDecision

getPostAuthFraudDecision() : String

Returns the post-authorization fraud decision, or null if not set.

Returns:

the post-auth fraud decision

See Also:

POST_AUTH_FRAUD_DECISION_NOT_REVIEWED

POST_AUTH_FRAUD_DECISION_GUARANTEED

POST_AUTH_FRAUD_DECISION_NOT_GUARANTEED

POST_AUTH_FRAUD_DECISION_PENDING

getPreAuthFraudDecision

getPreAuthFraudDecision() : String

Returns the pre-authorization fraud decision, or null if not set.

Returns:

the pre-auth fraud decision

See Also:

PRE_AUTH_FRAUD_DECISION_NOT_REVIEWED

PRE_AUTH_FRAUD_DECISION_APPROVED

PRE_AUTH_FRAUD_DECISION_CHALLENGE

PRE_AUTH_FRAUD_DECISION_DECLINED

getStatus

getStatus() : Number

Returns the status of this payment transaction.

Returns:

the status of this payment transaction.

See Also:

STATUS_CREATED

STATUS_AUTHORIZED

STATUS_PARTCAPTURED

STATUS_CAPTURED

STATUS_AUTHORIZATIONVOIDED

STATUS_CAPTUREVOIDED

STATUS_MARKED

STATUS_SETTLED

getTransactionDetails

getTransactionDetails() : SalesforceTransactionDetails

Returns the transaction details for this payment transaction, or null if none have been set.

Returns:

transaction details, or null if none have been set

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.

setPostAuthFraudDecision

setPostAuthFraudDecision(postAuthFraudDecision : String) : void

Sets the post-authorization fraud decision.

Parameters:

postAuthFraudDecision - the post-auth fraud decision

See Also:

POST_AUTH_FRAUD_DECISION_NOT_REVIEWED

POST_AUTH_FRAUD_DECISION_GUARANTEED

POST_AUTH_FRAUD_DECISION_NOT_GUARANTEED

POST_AUTH_FRAUD_DECISION_PENDING

setPreAuthFraudDecision

setPreAuthFraudDecision(preAuthFraudDecision : String) : void

Sets the pre-authorization fraud decision.

Parameters:

preAuthFraudDecision - the pre-auth fraud decision

See Also:

PRE_AUTH_FRAUD_DECISION_NOT_REVIEWED

PRE_AUTH_FRAUD_DECISION_APPROVED

PRE_AUTH_FRAUD_DECISION_CHALLENGE

PRE_AUTH_FRAUD_DECISION_DECLINED

setStatus

setStatus(status : Number) : void

Sets the status of this payment transaction.

Parameters:

status - the status to set

See Also:

STATUS_CREATED

STATUS_AUTHORIZED

STATUS_PARTCAPTURED

STATUS_CAPTURED

STATUS_AUTHORIZATIONVOIDED

STATUS_CAPTUREVOIDED

STATUS_MARKED

STATUS_SETTLED

Throws:

Exception - if the value is not one of the constants

setTransactionDetails

setTransactionDetails(transactionDetails : SalesforceTransactionDetails) : void

Sets the transaction details on this payment transaction.

Parameters:

transactionDetails - the transaction details to set, or null to clear

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.