DirectDebitOrderingResponse (finapi-adapter 3.0.28 API)

java.lang.Object
- io.swagger.client.model.DirectDebitOrderingResponse

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class DirectDebitOrderingResponse
extends Object

Bank server's response to a direct debit order request

Constructor Summary

Constructors
Constructor and Description

DirectDebitOrderingResponse()

Constructors
Constructor and Description
`DirectDebitOrderingResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DirectDebitOrderingResponse`	`answerFieldLabel(String answerFieldLabel)`
`DirectDebitOrderingResponse`	`challengeMessage(String challengeMessage)`
`boolean`	`equals(Object o)`
`String`	`getAnswerFieldLabel()` Suggestion from the bank server on how you can label your input field where the user must enter his TAN.
`String`	`getChallengeMessage()` Message from the bank server containing information or instructions on how to retrieve the TAN that is needed to execute the requested order.
`String`	`getOpticalData()` In case that the bank server has instructed the user to scan a flicker code, then this field will contain the raw data for the flicker animation as a BASE-64 string.
`String`	`getPhotoTanData()` In case that the bank server has instructed the user to scan a photo (or more generally speaking, any kind of QR-code-like data), then this field will contain the raw data of the photo as a BASE-64 string.
`String`	`getPhotoTanMimeType()` In case that the 'photoTanData' field is set (i.e.
`String`	`getSuccessMessage()` Technical message from the bank server, confirming the success of the request.
`String`	`getTanListNumber()` In case that the bank server has instructed the user to look up a TAN from a TAN list, this field may contain the identification number of the TAN list.
`String`	`getWarnMessage()` In some cases, a bank server may accept the requested order, but return a warn message.
`int`	`hashCode()`
`DirectDebitOrderingResponse`	`opticalData(String opticalData)`
`DirectDebitOrderingResponse`	`photoTanData(String photoTanData)`
`DirectDebitOrderingResponse`	`photoTanMimeType(String photoTanMimeType)`
`void`	`setAnswerFieldLabel(String answerFieldLabel)`
`void`	`setChallengeMessage(String challengeMessage)`
`void`	`setOpticalData(String opticalData)`
`void`	`setPhotoTanData(String photoTanData)`
`void`	`setPhotoTanMimeType(String photoTanMimeType)`
`void`	`setSuccessMessage(String successMessage)`
`void`	`setTanListNumber(String tanListNumber)`
`void`	`setWarnMessage(String warnMessage)`
`DirectDebitOrderingResponse`	`successMessage(String successMessage)`
`DirectDebitOrderingResponse`	`tanListNumber(String tanListNumber)`
`String`	`toString()`
`DirectDebitOrderingResponse`	`warnMessage(String warnMessage)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DirectDebitOrderingResponse
```
public DirectDebitOrderingResponse()
```
- Method Detail
  - successMessage
```
public DirectDebitOrderingResponse successMessage(String successMessage)
```
  - getSuccessMessage
```
public String getSuccessMessage()
```
    Technical message from the bank server, confirming the success of the request. Typically, you would not want to present this message to the user. Note that this field may not be set. However if it is not set, it does not necessarily mean that there was an error in processing the request.
    
    Returns:
    
    successMessage
  - setSuccessMessage
```
public void setSuccessMessage(String successMessage)
```
  - warnMessage
```
public DirectDebitOrderingResponse warnMessage(String warnMessage)
```
  - getWarnMessage
```
public String getWarnMessage()
```
    In some cases, a bank server may accept the requested order, but return a warn message. This message may be of technical nature, but could also be of interest to the user.
    
    Returns:
    
    warnMessage
  - setWarnMessage
```
public void setWarnMessage(String warnMessage)
```
  - challengeMessage
```
public DirectDebitOrderingResponse challengeMessage(String challengeMessage)
```
  - getChallengeMessage
```
public String getChallengeMessage()
```
    Message from the bank server containing information or instructions on how to retrieve the TAN that is needed to execute the requested order. This message should be presented to the user. Note that some bank servers may limit the message to just the most crucial information, e.g. the message may contain just a single number that depicts the target TAN number on a user's TAN list. You may want to parse the challenge message for such cases and extend it with more detailed information before showing it to the user.
    
    Returns:
    
    challengeMessage
  - setChallengeMessage
```
public void setChallengeMessage(String challengeMessage)
```
  - answerFieldLabel
```
public DirectDebitOrderingResponse answerFieldLabel(String answerFieldLabel)
```
  - getAnswerFieldLabel
```
public String getAnswerFieldLabel()
```
    Suggestion from the bank server on how you can label your input field where the user must enter his TAN. A typical value that many bank servers give is 'TAN-Nummer'.
    
    Returns:
    
    answerFieldLabel
  - setAnswerFieldLabel
```
public void setAnswerFieldLabel(String answerFieldLabel)
```
  - tanListNumber
```
public DirectDebitOrderingResponse tanListNumber(String tanListNumber)
```
  - getTanListNumber
```
public String getTanListNumber()
```
    In case that the bank server has instructed the user to look up a TAN from a TAN list, this field may contain the identification number of the TAN list. However in most cases, this field is only set (i.e. not null) when the user has multiple active TAN lists.
    
    Returns:
    
    tanListNumber
  - setTanListNumber
```
public void setTanListNumber(String tanListNumber)
```
  - opticalData
```
public DirectDebitOrderingResponse opticalData(String opticalData)
```
  - getOpticalData
```
public String getOpticalData()
```
    In case that the bank server has instructed the user to scan a flicker code, then this field will contain the raw data for the flicker animation as a BASE-64 string. Otherwise, this field will be not set (i.e. null). For more information on how to process the flicker code data, please address the <a href=\"https://finapi.zendesk.com\">finAPI Developer Portal</a>.
    
    Returns:
    
    opticalData
  - setOpticalData
```
public void setOpticalData(String opticalData)
```
  - photoTanMimeType
```
public DirectDebitOrderingResponse photoTanMimeType(String photoTanMimeType)
```
  - getPhotoTanMimeType
```
public String getPhotoTanMimeType()
```
    In case that the 'photoTanData' field is set (i.e. not null), this field contains the MIME type to use for interpreting the photo data (e.g.: 'image/png')
    
    Returns:
    
    photoTanMimeType
  - setPhotoTanMimeType
```
public void setPhotoTanMimeType(String photoTanMimeType)
```
  - photoTanData
```
public DirectDebitOrderingResponse photoTanData(String photoTanData)
```
  - getPhotoTanData
```
public String getPhotoTanData()
```
    In case that the bank server has instructed the user to scan a photo (or more generally speaking, any kind of QR-code-like data), then this field will contain the raw data of the photo as a BASE-64 string. Otherwise, this field will be not set (i.e. null). For more information on how to process the photo data, please address the <a href=\"https://finapi.zendesk.com\">finAPI Developer Portal</a>.
    
    Returns:
    
    photoTanData
  - setPhotoTanData
```
public void setPhotoTanData(String photoTanData)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DirectDebitOrderingResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DirectDebitOrderingResponse

Method Detail

successMessage

getSuccessMessage

setSuccessMessage

warnMessage

getWarnMessage

setWarnMessage

challengeMessage

getChallengeMessage

setChallengeMessage

answerFieldLabel

getAnswerFieldLabel

setAnswerFieldLabel

tanListNumber

getTanListNumber

setTanListNumber

opticalData

getOpticalData

setOpticalData

photoTanMimeType

getPhotoTanMimeType

setPhotoTanMimeType

photoTanData

getPhotoTanData

setPhotoTanData

equals

hashCode

toString