io.sphere.sdk.payments

Interface Payment

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<Payment>, Referenceable<Payment>, Resource<Payment>, ResourceIdentifiable<Payment>, ResourceView<Payment,Payment>, Timestamped, Versioned<Payment>, WithKey

public interface Payment
extends Resource<Payment>, Custom, WithKey

Payments hold information about the current state of receiving and/or refunding money, but the process itself is handled by a PSP. They are usually referenced by an Order or a Cart.

See Also:

PaymentCreateCommand, PaymentUpdateCommand, PaymentDeleteCommand, PaymentByIdGet, PaymentQuery, Order.getPaymentInfo(), Cart.getPaymentInfo()

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.
CustomFields	getCustom()
Reference<Customer>	getCustomer()
String	getExternalId() Deprecated. This field will be removed with the next major SDK update.
String	getInterfaceId() The identifier that is used by the interface that manages the payment (usually the PSP).
List<CustomFields>	getInterfaceInteractions()
String	getKey() User-specific unique identifier for the payment.
PaymentMethodInfo	getPaymentMethodInfo()
PaymentStatus	getPaymentStatus()
List<Transaction>	getTransactions()
static Reference<Payment>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<Payment>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Payment>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getCustomer

@Nullable
Reference<Customer> getCustomer()

getExternalId

@Deprecated
 @Nullable
String getExternalId()

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

The external id can be used as additional identifier for external systems like CRM or ERP.

Returns:

the external id

getInterfaceId

@Nullable
String getInterfaceId()

The identifier that is used by the interface that manages the payment (usually the PSP). Can not be changed once it has been set. The combination of getInterfaceId() and getPaymentMethodInfo() must be unique.

Returns:

the interface id

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 authorization limit date

getAmountPaid

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

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

Returns:

the paid amount

getAmountRefunded

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

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

Returns:

the refunded amount

getPaymentMethodInfo

PaymentMethodInfo getPaymentMethodInfo()

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

getPaymentStatus

PaymentStatus getPaymentStatus()

getTransactions

List<Transaction> getTransactions()

getInterfaceInteractions

List<CustomFields> 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

toReference

default Reference<Payment> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Payment>

Specified by:

toReference in interface Resource<Payment>

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Payment> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

referenceOfId

static Reference<Payment> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference