RequestSepaDirectDebitParams (finapi-adapter 3.0.28 API)

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

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

Parameters for a single or collective SEPA direct debit order request

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RequestSepaDirectDebitParams.DirectDebitTypeEnum` Type of the direct debit; either <code>BASIC</code> or <code>B2B</code> (Business-To-Business).
`static class`	`RequestSepaDirectDebitParams.SequenceTypeEnum` Sequence type of the direct debit.

Constructor Summary

Constructors
Constructor and Description

RequestSepaDirectDebitParams()

Constructors
Constructor and Description
`RequestSepaDirectDebitParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestSepaDirectDebitParams`	`accountId(Long accountId)`
`RequestSepaDirectDebitParams`	`addDirectDebitsItem(SingleDirectDebitData directDebitsItem)`
`RequestSepaDirectDebitParams`	`bankingPin(String bankingPin)`
`RequestSepaDirectDebitParams`	`directDebits(List<SingleDirectDebitData> directDebits)`
`RequestSepaDirectDebitParams`	`directDebitType(RequestSepaDirectDebitParams.DirectDebitTypeEnum directDebitType)`
`boolean`	`equals(Object o)`
`RequestSepaDirectDebitParams`	`executionDate(String executionDate)`
`Long`	`getAccountId()` Identifier of the bank account to which you want to transfer the money.
`String`	`getBankingPin()` Online banking PIN.
`List<SingleDirectDebitData>`	`getDirectDebits()` List of the direct debits that you want to execute.
`RequestSepaDirectDebitParams.DirectDebitTypeEnum`	`getDirectDebitType()` Type of the direct debit; either <code>BASIC</code> or <code>B2B</code> (Business-To-Business).
`String`	`getExecutionDate()` Execution date for the direct debit(s), in the format 'yyyy-MM-dd'.
`RequestSepaDirectDebitParams.SequenceTypeEnum`	`getSequenceType()` Sequence type of the direct debit.
`String`	`getTwoStepProcedureId()` The bank-given ID of the two-step-procedure that should be used for the direct debit order.
`int`	`hashCode()`
`RequestSepaDirectDebitParams`	`sequenceType(RequestSepaDirectDebitParams.SequenceTypeEnum sequenceType)`
`void`	`setAccountId(Long accountId)`
`void`	`setBankingPin(String bankingPin)`
`void`	`setDirectDebits(List<SingleDirectDebitData> directDebits)`
`void`	`setDirectDebitType(RequestSepaDirectDebitParams.DirectDebitTypeEnum directDebitType)`
`void`	`setExecutionDate(String executionDate)`
`void`	`setSequenceType(RequestSepaDirectDebitParams.SequenceTypeEnum sequenceType)`
`void`	`setTwoStepProcedureId(String twoStepProcedureId)`
`String`	`toString()`
`RequestSepaDirectDebitParams`	`twoStepProcedureId(String twoStepProcedureId)`

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

- Constructor Detail
 - RequestSepaDirectDebitParams
```
public RequestSepaDirectDebitParams()
```
- Method Detail
 - accountId
```
public RequestSepaDirectDebitParams accountId(Long accountId)
```
 - getAccountId
```
public Long getAccountId()
```
 Identifier of the bank account to which you want to transfer the money.
 
 Returns:
 
 accountId
 - setAccountId
```
public void setAccountId(Long accountId)
```
 - bankingPin
```
public RequestSepaDirectDebitParams bankingPin(String bankingPin)
```
 - getBankingPin
```
public String getBankingPin()
```
 Online banking PIN. If a PIN is stored in the account's bank connection, then this field may remain unset. If the field is set though then it will always be used (even if there is some other PIN stored in the bank connection).
 
 Returns:
 
 bankingPin
 - setBankingPin
```
public void setBankingPin(String bankingPin)
```
 - twoStepProcedureId
```
public RequestSepaDirectDebitParams twoStepProcedureId(String twoStepProcedureId)
```
 - getTwoStepProcedureId
```
public String getTwoStepProcedureId()
```
 The bank-given ID of the two-step-procedure that should be used for the direct debit order. For a list of available two-step-procedures, see the corresponding bank connection (GET /bankConnections). If this field is not set, then the bank connection's default two-step procedure will be used. Note that in this case, when the bank connection has no default two-step procedure set, then the service will return an error (see response messages for details).
 
 Returns:
 
 twoStepProcedureId
 - setTwoStepProcedureId
```
public void setTwoStepProcedureId(String twoStepProcedureId)
```
 - directDebitType
```
public RequestSepaDirectDebitParams directDebitType(RequestSepaDirectDebitParams.DirectDebitTypeEnum directDebitType)
```
 - getDirectDebitType
```
public RequestSepaDirectDebitParams.DirectDebitTypeEnum getDirectDebitType()
```
 Type of the direct debit; either <code>BASIC</code> or <code>B2B</code> (Business-To-Business). Please note that an account which supports the basic type must not necessarily support B2B (or vice versa). Check the source account's 'supportedOrders' field to find out which types of direct debit it supports. 
 
 Returns:
 
 directDebitType
 - setDirectDebitType
```
public void setDirectDebitType(RequestSepaDirectDebitParams.DirectDebitTypeEnum directDebitType)
```
 - sequenceType
```
public RequestSepaDirectDebitParams sequenceType(RequestSepaDirectDebitParams.SequenceTypeEnum sequenceType)
```
 - getSequenceType
```
public RequestSepaDirectDebitParams.SequenceTypeEnum getSequenceType()
```
 Sequence type of the direct debit. Possible values: • <code>OOFF</code> - means that this is a one-time direct debit order • <code>FRST</code> - means that this is the first in a row of multiple direct debit orders • <code>RCUR</code> - means that this is one (but not the first or final) within a row of multiple direct debit orders • <code>FNAL</code> - means that this is the final in a row of multiple direct debit orders 
 
 Returns:
 
 sequenceType
 - setSequenceType
```
public void setSequenceType(RequestSepaDirectDebitParams.SequenceTypeEnum sequenceType)
```
 - executionDate
```
public RequestSepaDirectDebitParams executionDate(String executionDate)
```
 - getExecutionDate
```
public String getExecutionDate()
```
 Execution date for the direct debit(s), in the format 'yyyy-MM-dd'.
 
 Returns:
 
 executionDate
 - setExecutionDate
```
public void setExecutionDate(String executionDate)
```
 - directDebits
```
public RequestSepaDirectDebitParams directDebits(List<SingleDirectDebitData> directDebits)
```
 - addDirectDebitsItem
```
public RequestSepaDirectDebitParams addDirectDebitsItem(SingleDirectDebitData directDebitsItem)
```
 - getDirectDebits
```
public List<SingleDirectDebitData> getDirectDebits()
```
 List of the direct debits that you want to execute. Please check the account's 'supportedOrders' field to find out whether you can pass multiple direct debits or just one.
 
 Returns:
 
 directDebits
 - setDirectDebits
```
public void setDirectDebits(List<SingleDirectDebitData> directDebits)
```
 - 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 RequestSepaDirectDebitParams

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestSepaDirectDebitParams

Method Detail

accountId

getAccountId

setAccountId

bankingPin

getBankingPin

setBankingPin

twoStepProcedureId

getTwoStepProcedureId

setTwoStepProcedureId

directDebitType

getDirectDebitType

setDirectDebitType

sequenceType

getSequenceType

setSequenceType

executionDate

getExecutionDate

setExecutionDate

directDebits

addDirectDebitsItem

getDirectDebits

setDirectDebits

equals

hashCode

toString