Package com.commercetools.api.models.payment

Class PaymentBuilder

java.lang.Object

com.commercetools.api.models.payment.PaymentBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<Payment>

public class PaymentBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<Payment>

PaymentBuilder Example to create an instance using the builder pattern

     Payment payment = Payment.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .amountPlanned(amountPlannedBuilder -> amountPlannedBuilder)
             .paymentMethodInfo(paymentMethodInfoBuilder -> paymentMethodInfoBuilder)
             .paymentStatus(paymentStatusBuilder -> paymentStatusBuilder)
             .plusTransactions(transactionsBuilder -> transactionsBuilder)
             .plusInterfaceInteractions(interfaceInteractionsBuilder -> interfaceInteractionsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PaymentBuilder()

Method Summary

Modifier and Type	Method	Description
PaymentBuilder	addInterfaceInteractions(Function<CustomFieldsBuilder,CustomFields> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	addTransactions(Function<TransactionBuilder,Transaction> builder)	Financial transactions of the Payment.
PaymentBuilder	amountAuthorized(TypedMoney amountAuthorized)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	amountAuthorized(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	amountPaid(TypedMoney amountPaid)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	amountPaid(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	amountPlanned(CentPrecisionMoney amountPlanned)	Money value the Payment intends to receive from the customer.
PaymentBuilder	amountPlanned(Function<CentPrecisionMoneyBuilder,CentPrecisionMoneyBuilder> builder)	Money value the Payment intends to receive from the customer.
PaymentBuilder	amountRefunded(TypedMoney amountRefunded)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	amountRefunded(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)	Deprecated because its value can be calculated from the total amounts saved in the Transactions.
PaymentBuilder	anonymousId(String anonymousId)	Anonymous session associated with the Payment.
PaymentBuilder	authorizedUntil(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.
Payment	build()	builds Payment with checking for non-null required values
Payment	buildUnchecked()	builds Payment without checking for non-null required values
PaymentBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Payment was initially created.
PaymentBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
PaymentBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
PaymentBuilder	custom(CustomFields custom)	Custom Fields for the Payment.
PaymentBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields for the Payment.
PaymentBuilder	customer(CustomerReference customer)	Reference to a Customer associated with the Payment.
PaymentBuilder	customer(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)	Reference to a Customer associated with the Payment.
PaymentBuilder	externalId(String externalId)	Additional identifier for external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
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.
PaymentBuilder	id(String id)	Unique identifier of the Payment.
PaymentBuilder	interfaceId(String interfaceId)	Identifier used by the payment service that processes the Payment (for example, a PSP).
PaymentBuilder	interfaceInteractions(CustomFields... interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	interfaceInteractions(List<CustomFields> interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	key(String key)	User-defined unique identifier of the Payment.
PaymentBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the Payment was last updated.
PaymentBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
PaymentBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
static PaymentBuilder	of()	factory method for an instance of PaymentBuilder
static PaymentBuilder	of(Payment template)	create builder for Payment instance
PaymentBuilder	paymentMethodInfo(PaymentMethodInfo paymentMethodInfo)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentBuilder	paymentMethodInfo(Function<PaymentMethodInfoBuilder,PaymentMethodInfoBuilder> builder)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentBuilder	paymentStatus(PaymentStatus paymentStatus)	Current status of the Payment.
PaymentBuilder	paymentStatus(Function<PaymentStatusBuilder,PaymentStatusBuilder> builder)	Current status of the Payment.
PaymentBuilder	plusInterfaceInteractions(CustomFields... interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	plusInterfaceInteractions(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	plusTransactions(Transaction... transactions)	Financial transactions of the Payment.
PaymentBuilder	plusTransactions(Function<TransactionBuilder,TransactionBuilder> builder)	Financial transactions of the Payment.
PaymentBuilder	setInterfaceInteractions(Function<CustomFieldsBuilder,CustomFields> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	setTransactions(Function<TransactionBuilder,Transaction> builder)	Financial transactions of the Payment.
PaymentBuilder	transactions(Transaction... transactions)	Financial transactions of the Payment.
PaymentBuilder	transactions(List<Transaction> transactions)	Financial transactions of the Payment.
PaymentBuilder	version(Long version)	Current version of the Payment.
PaymentBuilder	withAmountPlanned(Function<CentPrecisionMoneyBuilder,CentPrecisionMoney> builder)	Money value the Payment intends to receive from the customer.
PaymentBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
PaymentBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields for the Payment.
PaymentBuilder	withCustomer(Function<CustomerReferenceBuilder,CustomerReference> builder)	Reference to a Customer associated with the Payment.
PaymentBuilder	withInterfaceInteractions(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
PaymentBuilder	withPaymentMethodInfo(Function<PaymentMethodInfoBuilder,PaymentMethodInfo> builder)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentBuilder	withPaymentStatus(Function<PaymentStatusBuilder,PaymentStatus> builder)	Current status of the Payment.
PaymentBuilder	withTransactions(Function<TransactionBuilder,TransactionBuilder> builder)	Financial transactions of the Payment.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PaymentBuilder

public PaymentBuilder()

Method Details

id

public PaymentBuilder id(String id)

Unique identifier of the Payment.

Parameters:

id - value to be set

Returns:

Builder

version

public PaymentBuilder version(Long version)

Current version of the Payment.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public PaymentBuilder createdAt(ZonedDateTime createdAt)

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

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public PaymentBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

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

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public PaymentBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public PaymentBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public PaymentBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

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

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public PaymentBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

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

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public PaymentBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

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

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public PaymentBuilder createdBy(@Nullable
 CreatedBy createdBy)

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

Parameters:

createdBy - value to be set

Returns:

Builder

customer

public PaymentBuilder customer(Function<CustomerReferenceBuilder,CustomerReferenceBuilder> builder)

Reference to a Customer associated with the Payment.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public PaymentBuilder withCustomer(Function<CustomerReferenceBuilder,CustomerReference> builder)

Reference to a Customer associated with the Payment.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public PaymentBuilder customer(@Nullable
 CustomerReference customer)

Reference to a Customer associated with the Payment.

Parameters:

customer - value to be set

Returns:

Builder

anonymousId

public PaymentBuilder anonymousId(@Nullable
 String anonymousId)

Anonymous session associated with the Payment.

Parameters:

anonymousId - value to be set

Returns:

Builder

externalId

public PaymentBuilder externalId(@Nullable
 String externalId)

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

Parameters:

externalId - value to be set

Returns:

Builder

interfaceId

public PaymentBuilder interfaceId(@Nullable
 String interfaceId)

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.

Parameters:

interfaceId - value to be set

Returns:

Builder

amountPlanned

public PaymentBuilder amountPlanned(Function<CentPrecisionMoneyBuilder,CentPrecisionMoneyBuilder> builder)

Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.

Parameters:

builder - function to build the amountPlanned value

Returns:

Builder

withAmountPlanned

public PaymentBuilder withAmountPlanned(Function<CentPrecisionMoneyBuilder,CentPrecisionMoney> builder)

Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.

Parameters:

builder - function to build the amountPlanned value

Returns:

Builder

amountPlanned

public PaymentBuilder amountPlanned(CentPrecisionMoney amountPlanned)

Money value the Payment intends to receive from the customer. The value typically matches the Cart or Order gross total.

Parameters:

amountPlanned - value to be set

Returns:

Builder

amountAuthorized

public PaymentBuilder amountAuthorized(@Nullable
 TypedMoney amountAuthorized)

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

Parameters:

amountAuthorized - value to be set

Returns:

Builder

amountAuthorized

public PaymentBuilder amountAuthorized(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)

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

Parameters:

builder - function to build the amountAuthorized value

Returns:

Builder

authorizedUntil

public PaymentBuilder authorizedUntil(@Nullable
 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.

Parameters:

authorizedUntil - value to be set

Returns:

Builder

amountPaid

public PaymentBuilder amountPaid(@Nullable
 TypedMoney amountPaid)

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

Parameters:

amountPaid - value to be set

Returns:

Builder

amountPaid

public PaymentBuilder amountPaid(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)

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

Parameters:

builder - function to build the amountPaid value

Returns:

Builder

amountRefunded

public PaymentBuilder amountRefunded(@Nullable
 TypedMoney amountRefunded)

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

Parameters:

amountRefunded - value to be set

Returns:

Builder

amountRefunded

public PaymentBuilder amountRefunded(Function<TypedMoneyBuilder,io.vrap.rmf.base.client.Builder<? extends TypedMoney>> builder)

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

Parameters:

builder - function to build the amountRefunded value

Returns:

Builder

paymentMethodInfo

public PaymentBuilder paymentMethodInfo(Function<PaymentMethodInfoBuilder,PaymentMethodInfoBuilder> builder)

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

Parameters:

builder - function to build the paymentMethodInfo value

Returns:

Builder

withPaymentMethodInfo

public PaymentBuilder withPaymentMethodInfo(Function<PaymentMethodInfoBuilder,PaymentMethodInfo> builder)

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

Parameters:

builder - function to build the paymentMethodInfo value

Returns:

Builder

paymentMethodInfo

public PaymentBuilder paymentMethodInfo(PaymentMethodInfo paymentMethodInfo)

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

Parameters:

paymentMethodInfo - value to be set

Returns:

Builder

paymentStatus

public PaymentBuilder paymentStatus(Function<PaymentStatusBuilder,PaymentStatusBuilder> builder)

Current status of the Payment.

Parameters:

builder - function to build the paymentStatus value

Returns:

Builder

withPaymentStatus

public PaymentBuilder withPaymentStatus(Function<PaymentStatusBuilder,PaymentStatus> builder)

Current status of the Payment.

Parameters:

builder - function to build the paymentStatus value

Returns:

Builder

paymentStatus

public PaymentBuilder paymentStatus(PaymentStatus paymentStatus)

Current status of the Payment.

Parameters:

paymentStatus - value to be set

Returns:

Builder

transactions

public PaymentBuilder transactions(Transaction... transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

transactions

public PaymentBuilder transactions(List<Transaction> transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

plusTransactions

public PaymentBuilder plusTransactions(Transaction... transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

plusTransactions

public PaymentBuilder plusTransactions(Function<TransactionBuilder,TransactionBuilder> builder)

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

Parameters:

builder - function to build the transactions value

Returns:

Builder

withTransactions

public PaymentBuilder withTransactions(Function<TransactionBuilder,TransactionBuilder> builder)

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

Parameters:

builder - function to build the transactions value

Returns:

Builder

addTransactions

public PaymentBuilder addTransactions(Function<TransactionBuilder,Transaction> builder)

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

Parameters:

builder - function to build the transactions value

Returns:

Builder

setTransactions

public PaymentBuilder setTransactions(Function<TransactionBuilder,Transaction> builder)

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

Parameters:

builder - function to build the transactions value

Returns:

Builder

interfaceInteractions

public PaymentBuilder interfaceInteractions(CustomFields... interfaceInteractions)

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.

Parameters:

interfaceInteractions - value to be set

Returns:

Builder

interfaceInteractions

public PaymentBuilder interfaceInteractions(List<CustomFields> interfaceInteractions)

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.

Parameters:

interfaceInteractions - value to be set

Returns:

Builder

plusInterfaceInteractions

public PaymentBuilder plusInterfaceInteractions(CustomFields... interfaceInteractions)

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.

Parameters:

interfaceInteractions - value to be set

Returns:

Builder

plusInterfaceInteractions

public PaymentBuilder plusInterfaceInteractions(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

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.

Parameters:

builder - function to build the interfaceInteractions value

Returns:

Builder

withInterfaceInteractions

public PaymentBuilder withInterfaceInteractions(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

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.

Parameters:

builder - function to build the interfaceInteractions value

Returns:

Builder

addInterfaceInteractions

public PaymentBuilder addInterfaceInteractions(Function<CustomFieldsBuilder,CustomFields> builder)

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.

Parameters:

builder - function to build the interfaceInteractions value

Returns:

Builder

setInterfaceInteractions

public PaymentBuilder setInterfaceInteractions(Function<CustomFieldsBuilder,CustomFields> builder)

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.

Parameters:

builder - function to build the interfaceInteractions value

Returns:

Builder

custom

public PaymentBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields for the Payment.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public PaymentBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields for the Payment.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public PaymentBuilder custom(@Nullable
 CustomFields custom)

Custom Fields for the Payment.

Parameters:

custom - value to be set

Returns:

Builder

key

public PaymentBuilder key(@Nullable
 String key)

User-defined unique identifier of the Payment.

Parameters:

key - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Payment.

Returns:

id

getVersion

public Long getVersion()

Current version of the Payment.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

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

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

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

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

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

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

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

Returns:

createdBy

getCustomer

@Nullable
public CustomerReference getCustomer()

Reference to a Customer associated with the Payment.

Returns:

customer

getAnonymousId

@Nullable
public String getAnonymousId()

Anonymous session associated with the Payment.

Returns:

anonymousId

getExternalId

@Nullable
public String getExternalId()

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

Returns:

externalId

getInterfaceId

@Nullable
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.

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.

Returns:

amountPlanned

getAmountAuthorized

@Nullable
public TypedMoney getAmountAuthorized()

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

Returns:

amountAuthorized

getAuthorizedUntil

@Nullable
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.

Returns:

authorizedUntil

getAmountPaid

@Nullable
public TypedMoney getAmountPaid()

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

Returns:

amountPaid

getAmountRefunded

@Nullable
public TypedMoney getAmountRefunded()

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

Returns:

amountRefunded

getPaymentMethodInfo

public PaymentMethodInfo getPaymentMethodInfo()

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

Returns:

paymentMethodInfo

getPaymentStatus

public PaymentStatus getPaymentStatus()

Current status of the Payment.

Returns:

paymentStatus

getTransactions

public List<Transaction> getTransactions()

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

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.

Returns:

interfaceInteractions

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields for the Payment.

Returns:

custom

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Payment.

Returns:

key

build

public Payment build()

builds Payment with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<Payment>

Returns:

Payment

buildUnchecked

public Payment buildUnchecked()

builds Payment without checking for non-null required values

Returns:

Payment

of

public static PaymentBuilder of()

factory method for an instance of PaymentBuilder

Returns:

builder

of

public static PaymentBuilder of(Payment template)

create builder for Payment instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder