RequestSepaMoneyTransferParams (finapi-adapter 3.0.28 API)

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

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

Parameters for a single or collective SEPA money transfer order request

Constructor Summary

Constructors
Constructor and Description

RequestSepaMoneyTransferParams()

Constructors
Constructor and Description
`RequestSepaMoneyTransferParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestSepaMoneyTransferParams`	`accountId(Long accountId)`
`RequestSepaMoneyTransferParams`	`addAdditionalMoneyTransfersItem(SingleMoneyTransferRecipientData additionalMoneyTransfersItem)`
`RequestSepaMoneyTransferParams`	`additionalMoneyTransfers(List<SingleMoneyTransferRecipientData> additionalMoneyTransfers)`
`RequestSepaMoneyTransferParams`	`amount(BigDecimal amount)`
`RequestSepaMoneyTransferParams`	`bankingPin(String bankingPin)`
`RequestSepaMoneyTransferParams`	`challengeResponse(String challengeResponse)`
`RequestSepaMoneyTransferParams`	`clearingAccountId(String clearingAccountId)`
`boolean`	`equals(Object o)`
`Long`	`getAccountId()` Identifier of the bank account that you want to transfer money from
`List<SingleMoneyTransferRecipientData>`	`getAdditionalMoneyTransfers()` In case that you want to submit not just a single money transfer, but do a collective money transfer, use this field to pass a list of additional money transfer orders.
`BigDecimal`	`getAmount()` The amount to transfer.
`String`	`getBankingPin()` Online banking PIN.
`String`	`getChallengeResponse()` Challenge response.
`String`	`getClearingAccountId()` Identifier of a clearing account.
`String`	`getPurpose()` The purpose of the transfer transaction
`String`	`getRecipientBic()` BIC of the recipient's account.
`String`	`getRecipientIban()` IBAN of the recipient's account.
`String`	`getRecipientName()` Name of the recipient.
`String`	`getTwoStepProcedureId()` The bank-given ID of the two-step-procedure that should be used for the money transfer.
`int`	`hashCode()`
`RequestSepaMoneyTransferParams`	`purpose(String purpose)`
`RequestSepaMoneyTransferParams`	`recipientBic(String recipientBic)`
`RequestSepaMoneyTransferParams`	`recipientIban(String recipientIban)`
`RequestSepaMoneyTransferParams`	`recipientName(String recipientName)`
`void`	`setAccountId(Long accountId)`
`void`	`setAdditionalMoneyTransfers(List<SingleMoneyTransferRecipientData> additionalMoneyTransfers)`
`void`	`setAmount(BigDecimal amount)`
`void`	`setBankingPin(String bankingPin)`
`void`	`setChallengeResponse(String challengeResponse)`
`void`	`setClearingAccountId(String clearingAccountId)`
`void`	`setPurpose(String purpose)`
`void`	`setRecipientBic(String recipientBic)`
`void`	`setRecipientIban(String recipientIban)`
`void`	`setRecipientName(String recipientName)`
`void`	`setTwoStepProcedureId(String twoStepProcedureId)`
`String`	`toString()`
`RequestSepaMoneyTransferParams`	`twoStepProcedureId(String twoStepProcedureId)`

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

- Constructor Detail
  - RequestSepaMoneyTransferParams
```
public RequestSepaMoneyTransferParams()
```
- Method Detail
  - recipientName
```
public RequestSepaMoneyTransferParams recipientName(String recipientName)
```
  - getRecipientName
```
public String getRecipientName()
```
    Name of the recipient. Note: Neither finAPI nor the involved bank servers are guaranteed to validate the recipient name. Even if the recipient name does not depict the actual registered account holder of the specified recipient account, the money transfer request might still be successful. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required.
    
    Returns:
    
    recipientName
  - setRecipientName
```
public void setRecipientName(String recipientName)
```
  - recipientIban
```
public RequestSepaMoneyTransferParams recipientIban(String recipientIban)
```
  - getRecipientIban
```
public String getRecipientIban()
```
    IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required.
    
    Returns:
    
    recipientIban
  - setRecipientIban
```
public void setRecipientIban(String recipientIban)
```
  - recipientBic
```
public RequestSepaMoneyTransferParams recipientBic(String recipientBic)
```
  - getRecipientBic
```
public String getRecipientBic()
```
    BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. Also note that when a BIC is given, then this BIC will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case this field will always be ignored).
    
    Returns:
    
    recipientBic
  - setRecipientBic
```
public void setRecipientBic(String recipientBic)
```
  - clearingAccountId
```
public RequestSepaMoneyTransferParams clearingAccountId(String clearingAccountId)
```
  - getClearingAccountId
```
public String getClearingAccountId()
```
    Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account.
    
    Returns:
    
    clearingAccountId
  - setClearingAccountId
```
public void setClearingAccountId(String clearingAccountId)
```
  - amount
```
public RequestSepaMoneyTransferParams amount(BigDecimal amount)
```
  - getAmount
```
public BigDecimal getAmount()
```
    The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.90)
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(BigDecimal amount)
```
  - purpose
```
public RequestSepaMoneyTransferParams purpose(String purpose)
```
  - getPurpose
```
public String getPurpose()
```
    The purpose of the transfer transaction
    
    Returns:
    
    purpose
  - setPurpose
```
public void setPurpose(String purpose)
```
  - accountId
```
public RequestSepaMoneyTransferParams accountId(Long accountId)
```
  - getAccountId
```
public Long getAccountId()
```
    Identifier of the bank account that you want to transfer money from
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(Long accountId)
```
  - bankingPin
```
public RequestSepaMoneyTransferParams 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 RequestSepaMoneyTransferParams twoStepProcedureId(String twoStepProcedureId)
```
  - getTwoStepProcedureId
```
public String getTwoStepProcedureId()
```
    The bank-given ID of the two-step-procedure that should be used for the money transfer. 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)
```
  - challengeResponse
```
public RequestSepaMoneyTransferParams challengeResponse(String challengeResponse)
```
  - getChallengeResponse
```
public String getChallengeResponse()
```
    Challenge response. This field should be set only when the previous attempt to request a SEPA money transfer failed with HTTP code 510, i.e. the bank sent a challenge for the user for an additional authentication. In this case, this field must contain the response to the bank's challenge.
    
    Returns:
    
    challengeResponse
  - setChallengeResponse
```
public void setChallengeResponse(String challengeResponse)
```
  - additionalMoneyTransfers
```
public RequestSepaMoneyTransferParams additionalMoneyTransfers(List<SingleMoneyTransferRecipientData> additionalMoneyTransfers)
```
  - addAdditionalMoneyTransfersItem
```
public RequestSepaMoneyTransferParams addAdditionalMoneyTransfersItem(SingleMoneyTransferRecipientData additionalMoneyTransfersItem)
```
  - getAdditionalMoneyTransfers
```
public List<SingleMoneyTransferRecipientData> getAdditionalMoneyTransfers()
```
    In case that you want to submit not just a single money transfer, but do a collective money transfer, use this field to pass a list of additional money transfer orders. The service will then pass a collective money transfer request to the bank, including both the money transfer specified on the top-level, as well as all money transfers specified in this list. Note that you should check the account's 'supportedOrders' field to find out whether or not it is supporting collective money transfers.
    
    Returns:
    
    additionalMoneyTransfers
  - setAdditionalMoneyTransfers
```
public void setAdditionalMoneyTransfers(List<SingleMoneyTransferRecipientData> additionalMoneyTransfers)
```
  - 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 RequestSepaMoneyTransferParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestSepaMoneyTransferParams

Method Detail

recipientName

getRecipientName

setRecipientName

recipientIban

getRecipientIban

setRecipientIban

recipientBic

getRecipientBic

setRecipientBic

clearingAccountId

getClearingAccountId

setClearingAccountId

amount

getAmount

setAmount

purpose

getPurpose

setPurpose

accountId

getAccountId

setAccountId

bankingPin

getBankingPin

setBankingPin

twoStepProcedureId

getTwoStepProcedureId

setTwoStepProcedureId

challengeResponse

getChallengeResponse

setChallengeResponse

additionalMoneyTransfers

addAdditionalMoneyTransfersItem

getAdditionalMoneyTransfers

setAdditionalMoneyTransfers

equals

hashCode

toString