Class PaymentImpl
- All Implemented Interfaces:
BaseResource
,Customizable<Payment>
,DomainResource<Payment>
,Identifiable<Payment>
,Payment
,PaymentMixin
,Referencable<Payment>
,ResourceIdentifiable<Payment>
,Versioned<Payment>
,WithKey
,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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated because its value can be calculated from the total amounts saved in the Transactions.Deprecated because its value can be calculated from the total amounts saved in the Transactions.Money value the Payment intends to receive from the customer.Deprecated because its 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.Date and time (UTC) the Payment was initially created.Present on resources created after 1 February 2019 except for events not tracked.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).getId()
Unique identifier of the Payment.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 of the Payment.Date and time (UTC) the Payment was last updated.Present on resources created after 1 February 2019 except for events not tracked.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.Current version of the Payment.int
hashCode()
void
setAmountAuthorized
(TypedMoney amountAuthorized) Deprecated because its value can be calculated from the total amounts saved in the Transactions.void
setAmountPaid
(TypedMoney amountPaid) Deprecated because its value can be calculated from the total amounts saved in the Transactions.void
setAmountPlanned
(CentPrecisionMoney amountPlanned) Money value the Payment intends to receive from the customer.void
setAmountRefunded
(TypedMoney amountRefunded) Deprecated because its 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
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Payment was initially created.void
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) Custom Fields for the Payment.void
setCustomer
(CustomerReference 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
Unique identifier of the Payment.void
setInterfaceId
(String interfaceId) Identifier used by the payment service that processes the Payment (for example, a PSP).void
setInterfaceInteractions
(CustomFields... interfaceInteractions) Represents information exchange with the payment service, for example, a PSP.void
setInterfaceInteractions
(List<CustomFields> interfaceInteractions) Represents information exchange with the payment service, for example, a PSP.void
User-defined unique identifier of the Payment.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Payment was last updated.void
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
setPaymentMethodInfo
(PaymentMethodInfo paymentMethodInfo) Information regarding the payment interface (for example, a PSP), and the specific payment method used.void
setPaymentStatus
(PaymentStatus paymentStatus) Current status of the Payment.void
setTransactions
(Transaction... transactions) Financial transactions of the Payment.void
setTransactions
(List<Transaction> transactions) Financial transactions of the Payment.void
setVersion
(Long version) Current version 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.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.payment.Payment
withPayment
Methods inherited from interface com.commercetools.api.models.payment.PaymentMixin
toReference, toResourceIdentifier
-
Constructor Details
-
PaymentImpl
public PaymentImpl()create empty instance
-
-
Method Details
-
getId
Unique identifier of the Payment.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<Payment>
- Specified by:
getId
in interfaceIdentifiable<Payment>
- Specified by:
getId
in interfacePayment
- Specified by:
getId
in interfaceVersioned<Payment>
- Returns:
- id
-
getVersion
Current version of the Payment.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<Payment>
- Specified by:
getVersion
in interfacePayment
- Specified by:
getVersion
in interfaceVersioned<Payment>
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Payment was initially created.
- Specified by:
getCreatedAt
in interfaceBaseResource
- Specified by:
getCreatedAt
in interfacePayment
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Payment was last updated.
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Specified by:
getLastModifiedAt
in interfacePayment
- Returns:
- lastModifiedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getLastModifiedBy
in interfacePayment
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getCreatedBy
in interfacePayment
- Returns:
- createdBy
-
getCustomer
Reference to a Customer associated with the Payment.
- Specified by:
getCustomer
in interfacePayment
- Returns:
- customer
-
getAnonymousId
Anonymous session associated with the Payment.
- Specified by:
getAnonymousId
in interfacePayment
- Returns:
- anonymousId
-
getExternalId
Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
getExternalId
in interfacePayment
- 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.- Specified by:
getInterfaceId
in interfacePayment
- 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 interfacePayment
- Returns:
- amountPlanned
-
getAmountAuthorized
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountAuthorized
in interfacePayment
- 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 interfacePayment
- Returns:
- authorizedUntil
-
getAmountPaid
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountPaid
in interfacePayment
- Returns:
- amountPaid
-
getAmountRefunded
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
getAmountRefunded
in interfacePayment
- Returns:
- amountRefunded
-
getPaymentMethodInfo
Information regarding the payment interface (for example, a PSP), and the specific payment method used.
- Specified by:
getPaymentMethodInfo
in interfacePayment
- Returns:
- paymentMethodInfo
-
getPaymentStatus
Current status of the Payment.
- Specified by:
getPaymentStatus
in interfacePayment
- Returns:
- paymentStatus
-
getTransactions
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
getTransactions
in interfacePayment
- 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 interfacePayment
- Returns:
- interfaceInteractions
-
getCustom
Custom Fields for the Payment.
- Specified by:
getCustom
in interfaceCustomizable<Payment>
- Specified by:
getCustom
in interfacePayment
- Returns:
- custom
-
getKey
User-defined unique identifier of the Payment.
-
setId
Description copied from interface:Payment
Unique identifier of the Payment.
- Specified by:
setId
in interfaceBaseResource
- Specified by:
setId
in interfacePayment
- Parameters:
id
- value to be set
-
setVersion
Description copied from interface:Payment
Current version of the Payment.
- Specified by:
setVersion
in interfaceBaseResource
- Specified by:
setVersion
in interfacePayment
- Parameters:
version
- value to be set
-
setCreatedAt
Description copied from interface:Payment
Date and time (UTC) the Payment was initially created.
- Specified by:
setCreatedAt
in interfaceBaseResource
- Specified by:
setCreatedAt
in interfacePayment
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Description copied from interface:Payment
Date and time (UTC) the Payment was last updated.
- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Specified by:
setLastModifiedAt
in interfacePayment
- Parameters:
lastModifiedAt
- value to be set
-
setLastModifiedBy
Description copied from interface:Payment
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setLastModifiedBy
in interfacePayment
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Description copied from interface:Payment
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setCreatedBy
in interfacePayment
- Parameters:
createdBy
- value to be set
-
setCustomer
Description copied from interface:Payment
Reference to a Customer associated with the Payment.
- Specified by:
setCustomer
in interfacePayment
- Parameters:
customer
- value to be set
-
setAnonymousId
Description copied from interface:Payment
Anonymous session associated with the Payment.
- Specified by:
setAnonymousId
in interfacePayment
- Parameters:
anonymousId
- value to be set
-
setExternalId
Description copied from interface:Payment
Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
setExternalId
in interfacePayment
- Parameters:
externalId
- value to be set
-
setInterfaceId
Description copied from interface:Payment
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.- Specified by:
setInterfaceId
in interfacePayment
- Parameters:
interfaceId
- value to be set
-
setAmountPlanned
Description copied from interface:Payment
Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.
- Specified by:
setAmountPlanned
in interfacePayment
- Parameters:
amountPlanned
- value to be set
-
setAmountAuthorized
Description copied from interface:Payment
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountAuthorized
in interfacePayment
- Parameters:
amountAuthorized
- value to be set
-
setAuthorizedUntil
Description copied from interface: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.
- Specified by:
setAuthorizedUntil
in interfacePayment
- Parameters:
authorizedUntil
- value to be set
-
setAmountPaid
Description copied from interface:Payment
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountPaid
in interfacePayment
- Parameters:
amountPaid
- value to be set
-
setAmountRefunded
Description copied from interface:Payment
Deprecated because its value can be calculated from the total amounts saved in the Transactions.
- Specified by:
setAmountRefunded
in interfacePayment
- Parameters:
amountRefunded
- value to be set
-
setPaymentMethodInfo
Description copied from interface:Payment
Information regarding the payment interface (for example, a PSP), and the specific payment method used.
- Specified by:
setPaymentMethodInfo
in interfacePayment
- Parameters:
paymentMethodInfo
- value to be set
-
setPaymentStatus
Description copied from interface:Payment
Current status of the Payment.
- Specified by:
setPaymentStatus
in interfacePayment
- Parameters:
paymentStatus
- value to be set
-
setTransactions
Description copied from interface:Payment
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
setTransactions
in interfacePayment
- Parameters:
transactions
- values to be set
-
setTransactions
Description copied from interface:Payment
Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.
- Specified by:
setTransactions
in interfacePayment
- Parameters:
transactions
- values to be set
-
setInterfaceInteractions
Description copied from interface:Payment
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 interfacePayment
- Parameters:
interfaceInteractions
- values to be set
-
setInterfaceInteractions
Description copied from interface:Payment
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 interfacePayment
- Parameters:
interfaceInteractions
- values to be set
-
setCustom
Description copied from interface:Payment
Custom Fields for the Payment.
- Specified by:
setCustom
in interfaceCustomizable<Payment>
- Specified by:
setCustom
in interfacePayment
- Parameters:
custom
- value to be set
-
setKey
Description copied from interface:Payment
User-defined unique identifier of the Payment.
-
equals
-
hashCode
-