Class PaymentDraftImpl
- All Implemented Interfaces:
CustomizableDraft<PaymentDraft>
,PaymentDraft
,WithKey
,io.vrap.rmf.base.client.Draft<PaymentDraft>
,io.vrap.rmf.base.client.ModelBase
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated because the value can be calculated from the total amounts saved in the Transactions.Deprecated because the value can be calculated from the total amounts saved in the Transactions.Money value the Payment intends to receive from the customer.Deprecated because the value can be calculated from the total amounts saved in the Transactions.Anonymous session associated with the Payment.Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.Custom Fields for the Payment.Reference to a Customer associated with the Payment.Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).Identifier used by the payment service that processes the Payment (for example, a PSP).Represents information exchange with the payment service, for example, a PSP.getKey()
User-defined unique identifier for the Payment.Information regarding the payment interface (for example, a PSP), and the specific payment method used.Current status of the Payment.Financial transactions of the Payment.int
hashCode()
void
setAmountAuthorized
(Money amountAuthorized) Deprecated because the value can be calculated from the total amounts saved in the Transactions.void
setAmountPaid
(Money amountPaid) Deprecated because the value can be calculated from the total amounts saved in the Transactions.void
setAmountPlanned
(Money amountPlanned) Money value the Payment intends to receive from the customer.void
setAmountRefunded
(Money amountRefunded) Deprecated because the value can be calculated from the total amounts saved in the Transactions.void
setAnonymousId
(String anonymousId) Anonymous session associated with the Payment.void
setAuthorizedUntil
(String authorizedUntil) Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.void
setCustom
(CustomFieldsDraft custom) Custom Fields for the Payment.void
setCustomer
(CustomerResourceIdentifier customer) Reference to a Customer associated with the Payment.void
setExternalId
(String externalId) Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).void
setInterfaceId
(String interfaceId) Identifier used by the payment service that processes the Payment (for example, a PSP).void
setInterfaceInteractions
(CustomFieldsDraft... interfaceInteractions) Represents information exchange with the payment service, for example, a PSP.void
setInterfaceInteractions
(List<CustomFieldsDraft> interfaceInteractions) Represents information exchange with the payment service, for example, a PSP.void
User-defined unique identifier for the Payment.void
setPaymentMethodInfo
(PaymentMethodInfo paymentMethodInfo) Information regarding the payment interface (for example, a PSP), and the specific payment method used.void
setPaymentStatus
(PaymentStatusDraft paymentStatus) Current status of the Payment.void
setTransactions
(TransactionDraft... transactions) Financial transactions of the Payment.void
setTransactions
(List<TransactionDraft> transactions) Financial transactions of the Payment.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.payment.PaymentDraft
withPaymentDraft
-
Constructor Details
-
PaymentDraftImpl
public PaymentDraftImpl()create empty instance
-
-
Method Details
-
getCustomer
Reference to a Customer associated with the Payment.
- Specified by:
getCustomer
in interfacePaymentDraft
- Returns:
- customer
-
getAnonymousId
Anonymous session associated with the Payment.
- Specified by:
getAnonymousId
in interfacePaymentDraft
- Returns:
- anonymousId
-
getExternalId
Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
getExternalId
in interfacePaymentDraft
- Returns:
- externalId
-
getInterfaceId
Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of
interfaceId
and thepaymentInterface
field on PaymentMethodInfo must be unique. Once set, it cannot be changed.- Specified by:
getInterfaceId
in interfacePaymentDraft
- Returns:
- interfaceId
-
getAmountPlanned
Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.
- Specified by:
getAmountPlanned
in interfacePaymentDraft
- Returns:
- amountPlanned
-
getAmountAuthorized
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountAuthorized
in interfacePaymentDraft
- Returns:
- amountAuthorized
-
getAuthorizedUntil
Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.
- Specified by:
getAuthorizedUntil
in interfacePaymentDraft
- Returns:
- authorizedUntil
-
getAmountPaid
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountPaid
in interfacePaymentDraft
- Returns:
- amountPaid
-
getAmountRefunded
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountRefunded
in interfacePaymentDraft
- Returns:
- amountRefunded
-
getPaymentMethodInfo
Information regarding the payment interface (for example, a PSP), and the specific payment method used.
- Specified by:
getPaymentMethodInfo
in interfacePaymentDraft
- Returns:
- paymentMethodInfo
-
getPaymentStatus
Current status of the Payment.
- Specified by:
getPaymentStatus
in interfacePaymentDraft
- Returns:
- paymentStatus
-
getTransactions
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
getTransactions
in interfacePaymentDraft
- Returns:
- transactions
-
getInterfaceInteractions
Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.
- Specified by:
getInterfaceInteractions
in interfacePaymentDraft
- Returns:
- interfaceInteractions
-
getCustom
Custom Fields for the Payment.
- Specified by:
getCustom
in interfaceCustomizableDraft<PaymentDraft>
- Specified by:
getCustom
in interfacePaymentDraft
- Returns:
- custom
-
getKey
User-defined unique identifier for the Payment.
- Specified by:
getKey
in interfacePaymentDraft
- Specified by:
getKey
in interfaceWithKey
- Returns:
- key
-
setCustomer
Description copied from interface:PaymentDraft
Reference to a Customer associated with the Payment.
- Specified by:
setCustomer
in interfacePaymentDraft
- Parameters:
customer
- value to be set
-
setAnonymousId
Description copied from interface:PaymentDraft
Anonymous session associated with the Payment.
- Specified by:
setAnonymousId
in interfacePaymentDraft
- Parameters:
anonymousId
- value to be set
-
setExternalId
Description copied from interface:PaymentDraft
Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
setExternalId
in interfacePaymentDraft
- Parameters:
externalId
- value to be set
-
setInterfaceId
Description copied from interface:PaymentDraft
Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of
interfaceId
and thepaymentInterface
field on PaymentMethodInfo must be unique. Once set, it cannot be changed.- Specified by:
setInterfaceId
in interfacePaymentDraft
- Parameters:
interfaceId
- value to be set
-
setAmountPlanned
Description copied from interface:PaymentDraft
Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.
- Specified by:
setAmountPlanned
in interfacePaymentDraft
- Parameters:
amountPlanned
- value to be set
-
setAmountAuthorized
Description copied from interface:PaymentDraft
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountAuthorized
in interfacePaymentDraft
- Parameters:
amountAuthorized
- value to be set
-
setAuthorizedUntil
Description copied from interface:PaymentDraft
Deprecated because this field is of little practical value, as it is either not reliably known, or the authorization time is fixed for a PSP.
- Specified by:
setAuthorizedUntil
in interfacePaymentDraft
- Parameters:
authorizedUntil
- value to be set
-
setAmountPaid
Description copied from interface:PaymentDraft
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountPaid
in interfacePaymentDraft
- Parameters:
amountPaid
- value to be set
-
setAmountRefunded
Description copied from interface:PaymentDraft
Deprecated because the value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountRefunded
in interfacePaymentDraft
- Parameters:
amountRefunded
- value to be set
-
setPaymentMethodInfo
Description copied from interface:PaymentDraft
Information regarding the payment interface (for example, a PSP), and the specific payment method used.
- Specified by:
setPaymentMethodInfo
in interfacePaymentDraft
- Parameters:
paymentMethodInfo
- value to be set
-
setPaymentStatus
Description copied from interface:PaymentDraft
Current status of the Payment.
- Specified by:
setPaymentStatus
in interfacePaymentDraft
- Parameters:
paymentStatus
- value to be set
-
setTransactions
Description copied from interface:PaymentDraft
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
setTransactions
in interfacePaymentDraft
- Parameters:
transactions
- values to be set
-
setTransactions
Description copied from interface:PaymentDraft
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
setTransactions
in interfacePaymentDraft
- Parameters:
transactions
- values to be set
-
setInterfaceInteractions
Description copied from interface:PaymentDraft
Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.
- Specified by:
setInterfaceInteractions
in interfacePaymentDraft
- Parameters:
interfaceInteractions
- values to be set
-
setInterfaceInteractions
Description copied from interface:PaymentDraft
Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service.
- Specified by:
setInterfaceInteractions
in interfacePaymentDraft
- Parameters:
interfaceInteractions
- values to be set
-
setCustom
Description copied from interface:PaymentDraft
Custom Fields for the Payment.
- Specified by:
setCustom
in interfaceCustomizableDraft<PaymentDraft>
- Specified by:
setCustom
in interfacePaymentDraft
- Parameters:
custom
- value to be set
-
setKey
Description copied from interface:PaymentDraft
User-defined unique identifier for the Payment.
- Specified by:
setKey
in interfacePaymentDraft
- Parameters:
key
- value to be set
-
equals
-
hashCode
-