io.sphere.sdk.payments

Interface PaymentDraft

All Superinterfaces:

CustomDraft, WithKey

All Known Implementing Classes:

PaymentDraftDsl

public interface PaymentDraft
extends CustomDraft, WithKey

Draft for a new Payment resource.

See Also:

PaymentDraftBuilder, PaymentDraftDsl

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getAmountAuthorized() Deprecated. This field will be removed with the next major SDK update.
javax.money.MonetaryAmount	getAmountPaid() Deprecated. This field will be removed with the next major SDK update.
javax.money.MonetaryAmount	getAmountPlanned()
javax.money.MonetaryAmount	getAmountRefunded() Deprecated. This field will be removed with the next major SDK update.
String	getAnonymousId() Identifies payments belonging to an anonymous session (the customer has not signed up/in yet).
ZonedDateTime	getAuthorizedUntil() Deprecated. This field will be removed with the next major SDK update.
CustomFieldsDraft	getCustom()
Reference<Customer>	getCustomer()
String	getExternalId() Deprecated. This field will be removed with the next major SDK update.3
String	getInterfaceId()
List<CustomFieldsDraft>	getInterfaceInteractions()
String	getKey() User-specific unique identifier for the payment.
PaymentMethodInfo	getPaymentMethodInfo()
PaymentStatus	getPaymentStatus()
List<TransactionDraft>	getTransactions()

Method Detail

getCustomer

@Nullable
Reference<Customer> getCustomer()

getExternalId

@Deprecated
 @Nullable
String getExternalId()

Deprecated. This field will be removed with the next major SDK update.3

Returns:

the external id

getInterfaceId

@Nullable
String getInterfaceId()

getAmountPlanned

javax.money.MonetaryAmount getAmountPlanned()

getAmountAuthorized

@Deprecated
 @Nullable
javax.money.MonetaryAmount getAmountAuthorized()

Deprecated. This field will be removed with the next major SDK update.

Returns:

the authorized amount

getAuthorizedUntil

@Deprecated
 @Nullable
ZonedDateTime getAuthorizedUntil()

Deprecated. This field will be removed with the next major SDK update.

Returns:

the

getAmountPaid

@Deprecated
 @Nullable
javax.money.MonetaryAmount getAmountPaid()

Deprecated. This field will be removed with the next major SDK update.

getAmountRefunded

@Deprecated
 @Nullable
javax.money.MonetaryAmount getAmountRefunded()

Deprecated. This field will be removed with the next major SDK update.

getPaymentMethodInfo

@Nullable
PaymentMethodInfo getPaymentMethodInfo()

getCustom

@Nullable
CustomFieldsDraft getCustom()

Specified by:

getCustom in interface CustomDraft

getPaymentStatus

@Nullable
PaymentStatus getPaymentStatus()

getTransactions

@Nullable
List<TransactionDraft> getTransactions()

getInterfaceInteractions

@Nullable
List<CustomFieldsDraft> getInterfaceInteractions()

getKey

@Nullable
String getKey()

User-specific unique identifier for the payment.

Specified by:

getKey in interface WithKey

Returns:

the user defined key

getAnonymousId

@Nullable
String getAnonymousId()

Identifies payments belonging to an anonymous session (the customer has not signed up/in yet).

Returns:

the anonymous id of this payment