Class PaymentTransaction
The PaymentTransaction class represents a payment transaction.
| 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 | Description |
|---|---|
| accountID: String | Returns the payment service-specific account id. |
| accountType: String | Returns the payment service-specific account type. |
| amount: Money | Returns the amount of the transaction. |
paymentInstrument: OrderPaymentInstrument (read-only) | Returns the payment instrument related to this payment transaction. |
| paymentProcessor: PaymentProcessor | Returns the payment processor related to this payment transaction. |
| transactionID: String | Returns the payment service-specific transaction id. |
| 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. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAccountID() | Returns the payment service-specific account id. |
| getAccountType() | Returns the payment service-specific account type. |
| getAmount() | Returns the amount of the transaction. |
| getPaymentInstrument() | Returns the payment instrument related to this payment transaction. |
| getPaymentProcessor() | Returns the payment processor related to this payment transaction. |
| getTransactionID() | Returns the payment service-specific transaction id. |
| getType() | 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) | Sets the payment service-specific account id. |
| setAccountType(String) | Sets the payment service-specific account type. |
| setAmount(Money) | Sets the amount of the transaction. |
| setPaymentProcessor(PaymentProcessor) | Sets the payment processor related to this payment transaction. |
| setTransactionID(String) | Sets the payment service-specific transaction id. |
| setType(String) | Sets the value of the transaction type where permissible values are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT. |
getCreationDate, getLastModified, getUUID
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
- 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
Returns the payment service-specific account id.
- accountType: String
Returns the payment service-specific account type.
- amount: Money
Returns the amount of the transaction.
- paymentInstrument: OrderPaymentInstrument
(read-only) Returns the payment instrument related to this payment transaction.
- paymentProcessor: PaymentProcessor
Returns the payment processor related to this payment transaction.
- transactionID: String
Returns the payment service-specific transaction id.
- 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.
- getAccountID(): String
Returns the payment service-specific account id.
Returns:
- the payment service-specific account id.
- getAccountType(): String
Returns the payment service-specific account type.
Returns:
- the payment service-specific account type.
- getAmount(): Money
Returns the amount of the transaction.
Returns:
- the amount of the transaction.
- getPaymentInstrument(): OrderPaymentInstrument
Returns the payment instrument related to this payment transaction.
Returns:
- the order payment instrument related to this payment transaction.
- getPaymentProcessor(): PaymentProcessor
Returns the payment processor related to this payment transaction.
Returns:
- the payment processor related to this payment transaction.
- getTransactionID(): String
Returns the payment service-specific transaction id.
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.
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.
Parameters:
- accountID - the payment service-specific account id.
- setAccountType(accountType: String): void
Sets the payment service-specific account type.
Parameters:
- accountType - the payment service-specific account type.
- setAmount(amount: Money): void
Sets the amount of the transaction.
Parameters:
- amount - the amount of the transaction.
- setPaymentProcessor(paymentProcessor: PaymentProcessor): void
Sets the payment processor related to this payment transaction.
Parameters:
- paymentProcessor - the payment processor related to this payment transaction.
- setTransactionID(transactionID: String): void
Sets the payment service-specific transaction id.
Parameters:
- transactionID - 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.
Parameters:
- type - the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.