Package com.commercetools.api.models.payment

Class PaymentImpl

java.lang.Object

com.commercetools.api.models.payment.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

public class PaymentImpl
extends Object
implements Payment, io.vrap.rmf.base.client.ModelBase

Payment

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

Constructor	Description
PaymentImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TypedMoney	getAmountAuthorized()	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
TypedMoney	getAmountPaid()	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
CentPrecisionMoney	getAmountPlanned()	Money value the Payment intends to receive from the customer.
TypedMoney	getAmountRefunded()	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
String	getAnonymousId()	Anonymous session associated with the Payment.
String	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.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Payment was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	Custom Fields for the Payment.
CustomerReference	getCustomer()	Reference to a Customer associated with the Payment.
String	getExternalId()	Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
String	getId()	Unique identifier of the Payment.
String	getInterfaceId()	Identifier used by the payment service that processes the Payment (for example, a PSP).
List<CustomFields>	getInterfaceInteractions()	Represents information exchange with the payment service, for example, a PSP.
String	getKey()	User-defined unique identifier of the Payment.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the Payment was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
PaymentMethodInfo	getPaymentMethodInfo()	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentStatus	getPaymentStatus()	Current status of the Payment.
List<Transaction>	getTransactions()	Financial transactions of the Payment.
Long	getVersion()	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	setId(String id)	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	setKey(String key)	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

public String getId()

Unique identifier of the Payment.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<Payment>

Specified by:

getId in interface Identifiable<Payment>

Specified by:

getId in interface Payment

Specified by:

getId in interface Versioned<Payment>

Returns:

id

getVersion

public Long getVersion()

Current version of the Payment.

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<Payment>

Specified by:

getVersion in interface Payment

Specified by:

getVersion in interface Versioned<Payment>

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the Payment was initially created.

Specified by:

getCreatedAt in interface BaseResource

Specified by:

getCreatedAt in interface Payment

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the Payment was last updated.

Specified by:

getLastModifiedAt in interface BaseResource

Specified by:

getLastModifiedAt in interface Payment

Returns:

lastModifiedAt

getLastModifiedBy

public LastModifiedBy getLastModifiedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Specified by:

getLastModifiedBy in interface Payment

Returns:

lastModifiedBy

getCreatedBy

public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Specified by:

getCreatedBy in interface Payment

Returns:

createdBy

getCustomer

public CustomerReference getCustomer()

Reference to a Customer associated with the Payment.

Specified by:

getCustomer in interface Payment

Returns:

customer

getAnonymousId

public String getAnonymousId()

Anonymous session associated with the Payment.

Specified by:

getAnonymousId in interface Payment

Returns:

anonymousId

getExternalId

public String getExternalId()

Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).

Specified by:

getExternalId in interface Payment

Returns:

externalId

getInterfaceId

public String getInterfaceId()

Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique.

Specified by:

getInterfaceId in interface Payment

Returns:

interfaceId

getAmountPlanned

public CentPrecisionMoney 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 interface Payment

Returns:

amountPlanned

getAmountAuthorized

public TypedMoney getAmountAuthorized()

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

getAmountAuthorized in interface Payment

Returns:

amountAuthorized

getAuthorizedUntil

public String 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 interface Payment

Returns:

authorizedUntil

getAmountPaid

public TypedMoney getAmountPaid()

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

getAmountPaid in interface Payment

Returns:

amountPaid

getAmountRefunded

public TypedMoney getAmountRefunded()

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

getAmountRefunded in interface Payment

Returns:

amountRefunded

getPaymentMethodInfo

public PaymentMethodInfo getPaymentMethodInfo()

Information regarding the payment interface (for example, a PSP), and the specific payment method used.

Specified by:

getPaymentMethodInfo in interface Payment

Returns:

paymentMethodInfo

getPaymentStatus

public PaymentStatus getPaymentStatus()

Current status of the Payment.

Specified by:

getPaymentStatus in interface Payment

Returns:

paymentStatus

getTransactions

public List<Transaction> getTransactions()

Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.

Specified by:

getTransactions in interface Payment

Returns:

transactions

getInterfaceInteractions

public List<CustomFields> 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 interface Payment

Returns:

interfaceInteractions

getCustom

public CustomFields getCustom()

Custom Fields for the Payment.

Specified by:

getCustom in interface Customizable<Payment>

Specified by:

getCustom in interface Payment

Returns:

custom

getKey

public String getKey()

User-defined unique identifier of the Payment.

Specified by:

getKey in interface Payment

Specified by:

getKey in interface WithKey

Returns:

key

setId

public void setId(String id)

Description copied from interface: Payment

Unique identifier of the Payment.

Specified by:

setId in interface BaseResource

Specified by:

setId in interface Payment

Parameters:

id - value to be set

setVersion

public void setVersion(Long version)

Description copied from interface: Payment

Current version of the Payment.

Specified by:

setVersion in interface BaseResource

Specified by:

setVersion in interface Payment

Parameters:

version - value to be set

setCreatedAt

public void setCreatedAt(ZonedDateTime createdAt)

Description copied from interface: Payment

Date and time (UTC) the Payment was initially created.

Specified by:

setCreatedAt in interface BaseResource

Specified by:

setCreatedAt in interface Payment

Parameters:

createdAt - value to be set

setLastModifiedAt

public void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Description copied from interface: Payment

Date and time (UTC) the Payment was last updated.

Specified by:

setLastModifiedAt in interface BaseResource

Specified by:

setLastModifiedAt in interface Payment

Parameters:

lastModifiedAt - value to be set

setLastModifiedBy

public void setLastModifiedBy(LastModifiedBy lastModifiedBy)

Description copied from interface: Payment

Present on resources created after 1 February 2019 except for events not tracked.

Specified by:

setLastModifiedBy in interface Payment

Parameters:

lastModifiedBy - value to be set

setCreatedBy

public void setCreatedBy(CreatedBy createdBy)

Description copied from interface: Payment

Present on resources created after 1 February 2019 except for events not tracked.

Specified by:

setCreatedBy in interface Payment

Parameters:

createdBy - value to be set

setCustomer

public void setCustomer(CustomerReference customer)

Description copied from interface: Payment

Reference to a Customer associated with the Payment.

Specified by:

setCustomer in interface Payment

Parameters:

customer - value to be set

setAnonymousId

public void setAnonymousId(String anonymousId)

Description copied from interface: Payment

Anonymous session associated with the Payment.

Specified by:

setAnonymousId in interface Payment

Parameters:

anonymousId - value to be set

setExternalId

public void setExternalId(String externalId)

Description copied from interface: Payment

Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).

Specified by:

setExternalId in interface Payment

Parameters:

externalId - value to be set

setInterfaceId

public void setInterfaceId(String interfaceId)

Description copied from interface: Payment

Identifier used by the payment service that processes the Payment (for example, a PSP). The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique.

Specified by:

setInterfaceId in interface Payment

Parameters:

interfaceId - value to be set

setAmountPlanned

public void setAmountPlanned(CentPrecisionMoney amountPlanned)

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 interface Payment

Parameters:

amountPlanned - value to be set

setAmountAuthorized

public void setAmountAuthorized(TypedMoney amountAuthorized)

Description copied from interface: Payment

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

setAmountAuthorized in interface Payment

Parameters:

amountAuthorized - value to be set

setAuthorizedUntil

public void setAuthorizedUntil(String authorizedUntil)

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 interface Payment

Parameters:

authorizedUntil - value to be set

setAmountPaid

public void setAmountPaid(TypedMoney amountPaid)

Description copied from interface: Payment

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

setAmountPaid in interface Payment

Parameters:

amountPaid - value to be set

setAmountRefunded

public void setAmountRefunded(TypedMoney amountRefunded)

Description copied from interface: Payment

Deprecated because its value can be calculated from the total amounts saved in the Transactions.

Specified by:

setAmountRefunded in interface Payment

Parameters:

amountRefunded - value to be set

setPaymentMethodInfo

public void setPaymentMethodInfo(PaymentMethodInfo paymentMethodInfo)

Description copied from interface: Payment

Information regarding the payment interface (for example, a PSP), and the specific payment method used.

Specified by:

setPaymentMethodInfo in interface Payment

Parameters:

paymentMethodInfo - value to be set

setPaymentStatus

public void setPaymentStatus(PaymentStatus paymentStatus)

Description copied from interface: Payment

Current status of the Payment.

Specified by:

setPaymentStatus in interface Payment

Parameters:

paymentStatus - value to be set

setTransactions

public void setTransactions(Transaction... transactions)

Description copied from interface: Payment

Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.

Specified by:

setTransactions in interface Payment

Parameters:

transactions - values to be set

setTransactions

public void setTransactions(List<Transaction> transactions)

Description copied from interface: Payment

Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState.

Specified by:

setTransactions in interface Payment

Parameters:

transactions - values to be set

setInterfaceInteractions

public void setInterfaceInteractions(CustomFields... interfaceInteractions)

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 interface Payment

Parameters:

interfaceInteractions - values to be set

setInterfaceInteractions

public void setInterfaceInteractions(List<CustomFields> interfaceInteractions)

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 interface Payment

Parameters:

interfaceInteractions - values to be set

setCustom

public void setCustom(CustomFields custom)

Description copied from interface: Payment

Custom Fields for the Payment.

Specified by:

setCustom in interface Customizable<Payment>

Specified by:

setCustom in interface Payment

Parameters:

custom - value to be set

setKey

public void setKey(String key)

Description copied from interface: Payment

User-defined unique identifier of the Payment.

Specified by:

setKey in interface Payment

Parameters:

key - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object