Package com.commercetools.api.models.payment

Class PaymentDraftBuilder

java.lang.Object

com.commercetools.api.models.payment.PaymentDraftBuilder

All Implemented Interfaces:

PaymentDraftBuilderMixin, Builder<PaymentDraft>

public class PaymentDraftBuilder
extends Object
implements Builder<PaymentDraft>, PaymentDraftBuilderMixin

PaymentDraftBuilder Example to create an instance using the builder pattern

     PaymentDraft paymentDraft = PaymentDraft.builder()
             .amountPlanned(amountPlannedBuilder -> amountPlannedBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PaymentDraftBuilder()

Method Summary

Modifier and Type	Method	Description
PaymentDraftBuilder	addInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	addTransactions(Function<TransactionDraftBuilder,TransactionDraft> builder)	Financial transactions of the Payment.
PaymentDraftBuilder	amountPlanned(Money amountPlanned)	Money value the Payment intends to receive from the customer.
PaymentDraftBuilder	amountPlanned(Function<MoneyBuilder,MoneyBuilder> builder)	Money value the Payment intends to receive from the customer.
PaymentDraftBuilder	anonymousId(String anonymousId)	Anonymous session associated with the Payment.
PaymentDraft	build()	builds PaymentDraft with checking for non-null required values
PaymentDraft	buildUnchecked()	builds PaymentDraft without checking for non-null required values
PaymentDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Payment.
PaymentDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Payment.
PaymentDraftBuilder	customer(CustomerResourceIdentifier customer)	Reference to a Customer associated with the Payment.
PaymentDraftBuilder	customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	Reference to a Customer associated with the Payment.
Money	getAmountPlanned()	Money value the Payment intends to receive from the customer.
String	getAnonymousId()	Anonymous session associated with the Payment.
CustomFieldsDraft	getCustom()	Custom Fields for the Payment.
CustomerResourceIdentifier	getCustomer()	Reference to a Customer associated with the Payment.
String	getInterfaceId()	Identifier used by the payment service that processes the Payment (for example, a PSP).
List<CustomFieldsDraft>	getInterfaceInteractions()	Represents information exchange with the payment service, for example, a PSP.
String	getKey()	User-defined unique identifier for the Payment.
PaymentMethodInfoDraft	getPaymentMethodInfo()	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentStatusDraft	getPaymentStatus()	Current status of the Payment.
List<TransactionDraft>	getTransactions()	Financial transactions of the Payment.
PaymentDraftBuilder	interfaceId(String interfaceId)	Identifier used by the payment service that processes the Payment (for example, a PSP).
PaymentDraftBuilder	interfaceInteractions(CustomFieldsDraft... interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	interfaceInteractions(List<CustomFieldsDraft> interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	key(String key)	User-defined unique identifier for the Payment.
static PaymentDraftBuilder	of()	factory method for an instance of PaymentDraftBuilder
static PaymentDraftBuilder	of(PaymentDraft template)	create builder for PaymentDraft instance
PaymentDraftBuilder	paymentMethodInfo(PaymentMethodInfoDraft paymentMethodInfo)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentDraftBuilder	paymentMethodInfo(Function<PaymentMethodInfoDraftBuilder,PaymentMethodInfoDraftBuilder> builder)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentDraftBuilder	paymentStatus(PaymentStatusDraft paymentStatus)	Current status of the Payment.
PaymentDraftBuilder	paymentStatus(Function<PaymentStatusDraftBuilder,PaymentStatusDraftBuilder> builder)	Current status of the Payment.
PaymentDraftBuilder	plusInterfaceInteractions(CustomFieldsDraft... interfaceInteractions)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	plusInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	plusTransactions(TransactionDraft... transactions)	Financial transactions of the Payment.
PaymentDraftBuilder	plusTransactions(Function<TransactionDraftBuilder,TransactionDraftBuilder> builder)	Financial transactions of the Payment.
PaymentDraftBuilder	setInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	setTransactions(Function<TransactionDraftBuilder,TransactionDraft> builder)	Financial transactions of the Payment.
PaymentDraftBuilder	transactions(TransactionDraft... transactions)	Financial transactions of the Payment.
PaymentDraftBuilder	transactions(List<TransactionDraft> transactions)	Financial transactions of the Payment.
PaymentDraftBuilder	withAmountPlanned(Function<MoneyBuilder,Money> builder)	Money value the Payment intends to receive from the customer.
PaymentDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Payment.
PaymentDraftBuilder	withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)	Reference to a Customer associated with the Payment.
PaymentDraftBuilder	withInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Represents information exchange with the payment service, for example, a PSP.
PaymentDraftBuilder	withPaymentMethodInfo(Function<PaymentMethodInfoDraftBuilder,PaymentMethodInfoDraft> builder)	Information regarding the payment interface (for example, a PSP), and the specific payment method used.
PaymentDraftBuilder	withPaymentStatus(Function<PaymentStatusDraftBuilder,PaymentStatusDraft> builder)	Current status of the Payment.
PaymentDraftBuilder	withTransactions(Function<TransactionDraftBuilder,TransactionDraftBuilder> builder)	Financial transactions of the Payment.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.commercetools.api.models.payment.PaymentDraftBuilderMixin

paymentMethodInfo

Constructor Details

PaymentDraftBuilder

public PaymentDraftBuilder()

Method Details

customer

public PaymentDraftBuilder customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

Reference to a Customer associated with the Payment.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public PaymentDraftBuilder withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

Reference to a Customer associated with the Payment.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public PaymentDraftBuilder customer(@Nullable
 CustomerResourceIdentifier customer)

Reference to a Customer associated with the Payment.

Parameters:

customer - value to be set

Returns:

Builder

anonymousId

public PaymentDraftBuilder anonymousId(@Nullable
 String anonymousId)

Anonymous session associated with the Payment.

Parameters:

anonymousId - value to be set

Returns:

Builder

interfaceId

public PaymentDraftBuilder 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. Once set, it cannot be changed.

Parameters:

interfaceId - value to be set

Returns:

Builder

amountPlanned

public PaymentDraftBuilder amountPlanned(Function<MoneyBuilder,MoneyBuilder> 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 PaymentDraftBuilder withAmountPlanned(Function<MoneyBuilder,Money> 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 PaymentDraftBuilder amountPlanned(Money 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

paymentMethodInfo

public PaymentDraftBuilder paymentMethodInfo(Function<PaymentMethodInfoDraftBuilder,PaymentMethodInfoDraftBuilder> 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 PaymentDraftBuilder withPaymentMethodInfo(Function<PaymentMethodInfoDraftBuilder,PaymentMethodInfoDraft> 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 PaymentDraftBuilder paymentMethodInfo(@Nullable
 PaymentMethodInfoDraft paymentMethodInfo)

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

Specified by:

paymentMethodInfo in interface PaymentDraftBuilderMixin

Parameters:

paymentMethodInfo - value to be set

Returns:

Builder

paymentStatus

public PaymentDraftBuilder paymentStatus(Function<PaymentStatusDraftBuilder,PaymentStatusDraftBuilder> builder)

Current status of the Payment.

Parameters:

builder - function to build the paymentStatus value

Returns:

Builder

withPaymentStatus

public PaymentDraftBuilder withPaymentStatus(Function<PaymentStatusDraftBuilder,PaymentStatusDraft> builder)

Current status of the Payment.

Parameters:

builder - function to build the paymentStatus value

Returns:

Builder

paymentStatus

public PaymentDraftBuilder paymentStatus(@Nullable
 PaymentStatusDraft paymentStatus)

Current status of the Payment.

Parameters:

paymentStatus - value to be set

Returns:

Builder

transactions

public PaymentDraftBuilder transactions(@Nullable
 TransactionDraft... transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

transactions

public PaymentDraftBuilder transactions(@Nullable
 List<TransactionDraft> transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

plusTransactions

public PaymentDraftBuilder plusTransactions(@Nullable
 TransactionDraft... transactions)

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

Parameters:

transactions - value to be set

Returns:

Builder

plusTransactions

public PaymentDraftBuilder plusTransactions(Function<TransactionDraftBuilder,TransactionDraftBuilder> 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 PaymentDraftBuilder withTransactions(Function<TransactionDraftBuilder,TransactionDraftBuilder> 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 PaymentDraftBuilder addTransactions(Function<TransactionDraftBuilder,TransactionDraft> 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 PaymentDraftBuilder setTransactions(Function<TransactionDraftBuilder,TransactionDraft> 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 PaymentDraftBuilder interfaceInteractions(@Nullable
 CustomFieldsDraft... 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 PaymentDraftBuilder interfaceInteractions(@Nullable
 List<CustomFieldsDraft> 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 PaymentDraftBuilder plusInterfaceInteractions(@Nullable
 CustomFieldsDraft... 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 PaymentDraftBuilder plusInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> 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 PaymentDraftBuilder withInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> 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 PaymentDraftBuilder addInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> 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 PaymentDraftBuilder setInterfaceInteractions(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> 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 PaymentDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Payment.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public PaymentDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Payment.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public PaymentDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Payment.

Parameters:

custom - value to be set

Returns:

Builder

key

public PaymentDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the Payment.

Parameters:

key - value to be set

Returns:

Builder

getCustomer

@Nullable
public CustomerResourceIdentifier getCustomer()

Reference to a Customer associated with the Payment.

Returns:

customer

getAnonymousId

@Nullable
public String getAnonymousId()

Anonymous session associated with the Payment.

Returns:

anonymousId

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. Once set, it cannot be changed.

Returns:

interfaceId

getAmountPlanned

public Money getAmountPlanned()

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

Returns:

amountPlanned

getPaymentMethodInfo

@Nullable
public PaymentMethodInfoDraft getPaymentMethodInfo()

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

Returns:

paymentMethodInfo

getPaymentStatus

@Nullable
public PaymentStatusDraft getPaymentStatus()

Current status of the Payment.

Returns:

paymentStatus

getTransactions

@Nullable
public List<TransactionDraft> getTransactions()

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

Returns:

transactions

getInterfaceInteractions

@Nullable
public List<CustomFieldsDraft> 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 CustomFieldsDraft getCustom()

Custom Fields for the Payment.

Returns:

custom

getKey

@Nullable
public String getKey()

User-defined unique identifier for the Payment.

Returns:

key

build

public PaymentDraft build()

builds PaymentDraft with checking for non-null required values

Specified by:

build in interface Builder<PaymentDraft>

Returns:

PaymentDraft

buildUnchecked

public PaymentDraft buildUnchecked()

builds PaymentDraft without checking for non-null required values

Returns:

PaymentDraft

of

public static PaymentDraftBuilder of()

factory method for an instance of PaymentDraftBuilder

Returns:

builder

of

public static PaymentDraftBuilder of(PaymentDraft template)

create builder for PaymentDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder