Class PaymentTransaction
The PaymentTransaction class represents a payment transaction.
Constant Summary
| Constant | Description |
|---|
| 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. |
Property Summary
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
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
Constant Details
TYPE_AUTH
- TYPE_AUTH: String = "AUTH"
Constant representing the authorization type of payment transaction.
TYPE_AUTH_REVERSAL
- TYPE_AUTH_REVERSAL: String = "AUTH_REVERSAL"
Constant representing the authorization reversal type of payment transaction.
TYPE_CAPTURE
- TYPE_CAPTURE: String = "CAPTURE"
Constant representing the capture type of payment transaction.
TYPE_CREDIT
- TYPE_CREDIT: String = "CREDIT"
Constant representing the credit type of payment transaction.
Property Details
accountID
- accountID: String
Returns the payment service-specific account id.
accountType
- accountType: String
Returns the payment service-specific account type.
amount
- amount: Money
Returns the amount of the transaction.
paymentInstrument
- paymentInstrument: OrderPaymentInstrument
(read-only)
Returns the payment instrument related to this payment transaction.
paymentProcessor
- paymentProcessor: PaymentProcessor
Returns the payment processor related to this payment transaction.
transactionID
- transactionID: String
Returns the payment service-specific transaction id.
type
- type: EnumValue
Returns the value of the transaction type where the
value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE
or TYPE_CREDIT.
Method Details
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(String)
- setAccountID(accountID: String): void
Sets the payment service-specific account id.
Parameters:
- accountID - the payment service-specific account id.
setAccountType(String)
- setAccountType(accountType: String): void
Sets the payment service-specific account type.
Parameters:
- accountType - the payment service-specific account type.
setAmount(Money)
- setAmount(amount: Money): void
Sets the amount of the transaction.
Parameters:
- amount - the amount of the transaction.
setPaymentProcessor(PaymentProcessor)
- setPaymentProcessor(paymentProcessor: PaymentProcessor): void
Sets the payment processor related to this payment transaction.
Parameters:
- paymentProcessor - the payment processor related to this payment transaction.
setTransactionID(String)
- setTransactionID(transactionID: String): void
Sets the payment service-specific transaction id.
Parameters:
- transactionID - the payment service-specific transaction id.
setType(String)
- 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.
j