FieldCode (open-banking-gateway 0.20.0 API)

java.lang.Object
- java.lang.Enum<FieldCode>
- - de.adorsys.opba.protocol.api.dto.codes.FieldCode

All Implemented Interfaces:

Serializable, Comparable<FieldCode>
```
public enum FieldCode
extends Enum<FieldCode>
```
Represents what kind of input is expected/provided from/by user. For example protocol may want users' PSU_ID in order to create consent. This code is used to represent this.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOOKING_STATUS` Transaction booking status is required.
`CREDITOR_ACCOUNT` Creditor account is required from user in order to payment initiate.
`CREDITOR_ADDRESS` Creditor address is additional information about ASPSP.
`CREDITOR_AGENT` Creditor agent is additional information about ASPSP.
`CREDITOR_NAME` Creditor name is required in order to payment initiate.
`DEBTOR_ACCOUNT` DebtorAccount is required from user in order to payment initiate.
`END_TO_END_IDENTIFICATION` End to end identification is unique end to end identity
`FREQUENCY_PER_DAY` How frequently the consent can be used per day.
`IBAN` IBAN is required from user.
`INSTRUCTED_AMOUNT` Instructed amount is required from user in order to payment initiate.
`NONE` Null object.
`PSU_ID` PSU login in ASPSP
`PSU_IP_ADDRESS` IP address of PSU browser, mobile phone, etc.
`PSU_IP_PORT` IP port of IP address between PSU and TPP.
`PSU_PASSWORD` PIN password / password used to login to ASPSP
`RECURRING_INDICATOR` Whether the consent is for recurring action.
`REDIRECT_URI_NOK` ASPSP redirect URL to be called if consent was declined
`REMITTANCE_INFORMATION` Remittance information is additional data about Payment
`RESOURCE_ID` I.e.
`SCA_CHALLENGE_RESULT` Challenge result of 2-factor or multifactor authorization.
`SCA_METHOD_ID` When multiple SCA challenges (2-factor or multifactor authorization) are available (i.e.
`TPP_REDIRECT_PREFERRED` Tpp redirect Preferred
`VALID_UNTIL` Date until when the consent will be valid.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FieldCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FieldCode[]`	`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
  - NONE
```
public static final FieldCode NONE
```
    Null object.
  - PSU_ID
```
public static final FieldCode PSU_ID
```
    PSU login in ASPSP
  - PSU_IP_ADDRESS
```
public static final FieldCode PSU_IP_ADDRESS
```
    IP address of PSU browser, mobile phone, etc.
  - PSU_PASSWORD
```
public static final FieldCode PSU_PASSWORD
```
    PIN password / password used to login to ASPSP
  - RECURRING_INDICATOR
```
public static final FieldCode RECURRING_INDICATOR
```
    Whether the consent is for recurring action.
  - VALID_UNTIL
```
public static final FieldCode VALID_UNTIL
```
    Date until when the consent will be valid.
  - FREQUENCY_PER_DAY
```
public static final FieldCode FREQUENCY_PER_DAY
```
    How frequently the consent can be used per day. For example 12 for list accounts means that FinTech can retrieve user account list 12 times per day and after that authorization error will appear.
  - IBAN
```
public static final FieldCode IBAN
```
    IBAN is required from user.
  - BOOKING_STATUS
```
public static final FieldCode BOOKING_STATUS
```
    Transaction booking status is required.
  - SCA_CHALLENGE_RESULT
```
public static final FieldCode SCA_CHALLENGE_RESULT
```
    Challenge result of 2-factor or multifactor authorization. I.e. SMS secret code from ASPSP to proceed with consent.
  - SCA_METHOD_ID
```
public static final FieldCode SCA_METHOD_ID
```
    When multiple SCA challenges (2-factor or multifactor authorization) are available (i.e. SMS from ASPSP, EMAIL from ASPSP) - the identifier of SCA challenge.
  - REDIRECT_URI_NOK
```
public static final FieldCode REDIRECT_URI_NOK
```
    ASPSP redirect URL to be called if consent was declined
  - PSU_IP_PORT
```
public static final FieldCode PSU_IP_PORT
```
    IP port of IP address between PSU and TPP.
  - DEBTOR_ACCOUNT
```
public static final FieldCode DEBTOR_ACCOUNT
```
    DebtorAccount is required from user in order to payment initiate.
  - INSTRUCTED_AMOUNT
```
public static final FieldCode INSTRUCTED_AMOUNT
```
    Instructed amount is required from user in order to payment initiate.
  - CREDITOR_ACCOUNT
```
public static final FieldCode CREDITOR_ACCOUNT
```
    Creditor account is required from user in order to payment initiate.
  - CREDITOR_NAME
```
public static final FieldCode CREDITOR_NAME
```
    Creditor name is required in order to payment initiate.
  - CREDITOR_AGENT
```
public static final FieldCode CREDITOR_AGENT
```
    Creditor agent is additional information about ASPSP. Used in order to payment initiate.
  - CREDITOR_ADDRESS
```
public static final FieldCode CREDITOR_ADDRESS
```
    Creditor address is additional information about ASPSP. Used in order to payment initiate.
  - REMITTANCE_INFORMATION
```
public static final FieldCode REMITTANCE_INFORMATION
```
    Remittance information is additional data about Payment
  - END_TO_END_IDENTIFICATION
```
public static final FieldCode END_TO_END_IDENTIFICATION
```
    End to end identification is unique end to end identity
  - TPP_REDIRECT_PREFERRED
```
public static final FieldCode TPP_REDIRECT_PREFERRED
```
    Tpp redirect Preferred
  - RESOURCE_ID
```
public static final FieldCode RESOURCE_ID
```
    I.e. account id.
- Method Detail
  - values
```
public static FieldCode[] 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 (FieldCode c : FieldCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FieldCode 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

Enum FieldCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

PSU_ID

PSU_IP_ADDRESS

PSU_PASSWORD

RECURRING_INDICATOR

VALID_UNTIL

FREQUENCY_PER_DAY

IBAN

BOOKING_STATUS

SCA_CHALLENGE_RESULT

SCA_METHOD_ID

REDIRECT_URI_NOK

PSU_IP_PORT

DEBTOR_ACCOUNT

INSTRUCTED_AMOUNT

CREDITOR_ACCOUNT

CREDITOR_NAME

CREDITOR_AGENT

CREDITOR_ADDRESS

REMITTANCE_INFORMATION

END_TO_END_IDENTIFICATION

TPP_REDIRECT_PREFERRED

RESOURCE_ID

Method Detail

values

valueOf