com.plaid.client.model

Enum PaymentInitiationPaymentStatus

java.lang.Object

java.lang.Enum<PaymentInitiationPaymentStatus>

com.plaid.client.model.PaymentInitiationPaymentStatus

All Implemented Interfaces:

Serializable, Comparable<PaymentInitiationPaymentStatus>

public enum PaymentInitiationPaymentStatus
extends Enum<PaymentInitiationPaymentStatus>

The status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_INITIATED`: The payment has been successfully authorised and accepted by the financial institution. For successful payments, this is a potential terminal status. Further status transitions can be to REJECTED and, when supported by the institution, to EXECUTED. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error may be caused by transient system outages and is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked by Plaid. This can occur, for example, due to Plaid flagging the payment as potentially risky. This is a retryable error. `PAYMENT_STATUS_AUTHORISING`: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction. `PAYMENT_STATUS_CANCELLED`: The payment was cancelled (typically by the end user) during authorisation. `PAYMENT_STATUS_EXECUTED`: The funds have successfully left the payer account and payment is considered complete. Not all institutions support this status: support is more common in the UK, and less common in the EU. For institutions where this status is not supported, the terminal status for a successful payment will be `PAYMENT_STATUS_INITIATED`. `PAYMENT_STATUS_SETTLED`: The payment has settled and funds are available for use. A payment will typically settle within seconds to several days, depending on which payment rail is used. This status is only available to customers using [Plaid Virtual Accounts](https://plaid.com/docs/virtual-accounts/). `PAYMENT_STATUS_ESTABLISHED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_REJECTED`: The payment was rejected by the financial institution. Deprecated: These statuses will be removed in a future release. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentInitiationPaymentStatus.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHORISING
BLOCKED
CANCELLED
COMPLETED
ENUM_UNKNOWN
ESTABLISHED
EXECUTED
FAILED
INITIATED
INPUT_NEEDED
INSUFFICIENT_FUNDS
PROCESSING
REJECTED
SETTLED
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static PaymentInitiationPaymentStatus	fromValue(String value)
String	getValue()
String	toString()
static PaymentInitiationPaymentStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaymentInitiationPaymentStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INPUT_NEEDED

public static final PaymentInitiationPaymentStatus INPUT_NEEDED

PROCESSING

public static final PaymentInitiationPaymentStatus PROCESSING

INITIATED

public static final PaymentInitiationPaymentStatus INITIATED

COMPLETED

public static final PaymentInitiationPaymentStatus COMPLETED

INSUFFICIENT_FUNDS

public static final PaymentInitiationPaymentStatus INSUFFICIENT_FUNDS

FAILED

public static final PaymentInitiationPaymentStatus FAILED

BLOCKED

public static final PaymentInitiationPaymentStatus BLOCKED

UNKNOWN

public static final PaymentInitiationPaymentStatus UNKNOWN

EXECUTED

public static final PaymentInitiationPaymentStatus EXECUTED

SETTLED

public static final PaymentInitiationPaymentStatus SETTLED

AUTHORISING

public static final PaymentInitiationPaymentStatus AUTHORISING

CANCELLED

public static final PaymentInitiationPaymentStatus CANCELLED

ESTABLISHED

public static final PaymentInitiationPaymentStatus ESTABLISHED

REJECTED

public static final PaymentInitiationPaymentStatus REJECTED

ENUM_UNKNOWN

public static final PaymentInitiationPaymentStatus ENUM_UNKNOWN

Method Detail

values

public static PaymentInitiationPaymentStatus[] 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 (PaymentInitiationPaymentStatus c : PaymentInitiationPaymentStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static PaymentInitiationPaymentStatus 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<PaymentInitiationPaymentStatus>

fromValue

public static PaymentInitiationPaymentStatus fromValue(String value)