com.srv4pos.server.api.sale

Enum PaymentState

java.lang.Object

java.lang.Enum<PaymentState>

com.srv4pos.server.api.sale.PaymentState

All Implemented Interfaces:

Serializable, Comparable<PaymentState>

public enum PaymentState
extends Enum<PaymentState>

Determines status of the payment. Assuming the payment can be made trough payment system, it can be CHARGE_FAILED. Or for instance PENDING, which means not yet PAID. etc.

User: Pavel Abizyaev, Date: 04.09.2014 18:46

*

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROVED This state guarantees consumer confirmed the payment.
CANCELED This means consumer or cashier (not the payment system) actively refused the payment.
CHARGE_FAILED This state indicates the PENDING payment was failed on a pending process.
CHARGE_UNKNOWN It happens if we try to cancel but some problem occurs so we don't know actual state anymore. resumePayment call required to discover latest state.
PAUSED This state means our app (not a payment system) doesn't communicate with payment system at the moment.
PENDING This state indicates that payment system has sucessfully received the payment.
REJECTED This state means the payment system (not a consumer) rejected the payment.
SENDING First state when payment is created and going to go trough payment system.
SENDING_FAILED In case of any problems with sending the payment.

Method Summary

Methods

Modifier and Type	Method and Description
static PaymentState	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaymentState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SENDING

public static final PaymentState SENDING

First state when payment is created and going to go trough payment system. It means it's moving to payment system, but payment system didn't report the payment is received.

SENDING_FAILED

public static final PaymentState SENDING_FAILED

In case of any problems with sending the payment.

PENDING

public static final PaymentState PENDING

This state indicates that payment system has sucessfully received the payment. Now it's up to payment system to perform action for the payment. After this state it can go to APPROVED, REJECTED, PAUSED, CANCELED, CHARGE_FAILED.

APPROVED

public static final PaymentState APPROVED

This state guarantees consumer confirmed the payment.

REJECTED

public static final PaymentState REJECTED

This state means the payment system (not a consumer) rejected the payment.

PAUSED

public static final PaymentState PAUSED

This state means our app (not a payment system) doesn't communicate with payment system at the moment. In means, the payment system can perform any action with the payment (like approval, rejection etc.). Later on our app can request latest status via getPaymentStatus() method and then our app updates state of the payment. We can treat PAUSED state as `unknown yet`.

CANCELED

public static final PaymentState CANCELED

This means consumer or cashier (not the payment system) actively refused the payment.

CHARGE_FAILED

public static final PaymentState CHARGE_FAILED

This state indicates the PENDING payment was failed on a pending process.

CHARGE_UNKNOWN

public static final PaymentState CHARGE_UNKNOWN

It happens if we try to cancel but some problem occurs so we don't know actual state anymore. resumePayment call required to discover latest state.

Method Detail

values

public static PaymentState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PaymentState c : PaymentState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PaymentState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null