CaptureStatus (PayPal Server SDK 1.0.0 API)

java.lang.Object
- java.lang.Enum<CaptureStatus>
- - com.paypal.sdk.models.CaptureStatus

All Implemented Interfaces:

Serializable, Comparable<CaptureStatus>
```
public enum CaptureStatus
extends Enum<CaptureStatus>
```
CaptureStatus to be used.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`_UNKNOWN` Unknown values will be mapped by this enum member
`COMPLETED` The funds for this captured payment were credited to the payee's PayPal account.
`DECLINED` The funds could not be captured.
`FAILED` There was an error while capturing payment.
`PARTIALLY_REFUNDED` An amount less than this captured payment's amount was partially refunded to the payer.
`PENDING` The funds for this captured payment was not yet credited to the payee's PayPal account.
`REFUNDED` An amount greater than or equal to this captured payment's amount was refunded to the payer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CaptureStatus`	`constructFromString(String toConvert)` Returns the enum member associated with the given string value.
`static CaptureStatus`	`fromString(String toConvert)` Returns the enum member associated with the given string value.
`String`	`toString()` Get string representation of this enum.
`static List<String>`	`toValue(List<CaptureStatus> toConvert)` Convert list of CaptureStatus values to list of string values.
`String`	`value()` Returns the string value associated with the enum member.
`static CaptureStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CaptureStatus[]`	`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
  - COMPLETED
```
public static final CaptureStatus COMPLETED
```
    The funds for this captured payment were credited to the payee's PayPal account.
  - DECLINED
```
public static final CaptureStatus DECLINED
```
    The funds could not be captured.
  - PARTIALLY_REFUNDED
```
public static final CaptureStatus PARTIALLY_REFUNDED
```
    An amount less than this captured payment's amount was partially refunded to the payer.
  - PENDING
```
public static final CaptureStatus PENDING
```
    The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
  - REFUNDED
```
public static final CaptureStatus REFUNDED
```
    An amount greater than or equal to this captured payment's amount was refunded to the payer.
  - FAILED
```
public static final CaptureStatus FAILED
```
    There was an error while capturing payment.
  - _UNKNOWN
```
public static final CaptureStatus _UNKNOWN
```
    Unknown values will be mapped by this enum member
- Method Detail
  - values
```
public static CaptureStatus[] 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 (CaptureStatus c : CaptureStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CaptureStatus 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
  - constructFromString
```
public static CaptureStatus constructFromString(String toConvert)
                                         throws IOException
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
    
    Throws:
    
    IOException - when provided value is not mapped to any enum member.
  - fromString
```
public static CaptureStatus fromString(String toConvert)
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
  - value
```
public String value()
```
    Returns the string value associated with the enum member.
    
    Returns:
    
    The string value against enum member.
  - toString
```
public String toString()
```
    Get string representation of this enum.
    
    Overrides:
    
    toString in class Enum<CaptureStatus>
  - toValue
```
public static List<String> toValue(List<CaptureStatus> toConvert)
```
    Convert list of CaptureStatus values to list of string values.
    
    Parameters:
    
    toConvert - The list of CaptureStatus values to convert.
    
    Returns:
    
    List of representative string values.

Enum CaptureStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

COMPLETED

DECLINED

PARTIALLY_REFUNDED

PENDING

REFUNDED

FAILED

_UNKNOWN

Method Detail

values

valueOf

constructFromString

fromString

value

toString

toValue