SandboxBankTransferSimulateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.SandboxBankTransferSimulateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class SandboxBankTransferSimulateRequest
extends Object

Defines the request schema for `/sandbox/bank_transfer/simulate`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_BANK_TRANSFER_ID`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_EVENT_TYPE`
`static String`	`SERIALIZED_NAME_FAILURE_REASON`
`static String`	`SERIALIZED_NAME_SECRET`

Constructor Summary

Constructors
Constructor and Description

SandboxBankTransferSimulateRequest()

Constructors
Constructor and Description
`SandboxBankTransferSimulateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SandboxBankTransferSimulateRequest`	`bankTransferId(String bankTransferId)`
`SandboxBankTransferSimulateRequest`	`clientId(String clientId)`
`boolean`	`equals(Object o)`
`SandboxBankTransferSimulateRequest`	`eventType(String eventType)`
`SandboxBankTransferSimulateRequest`	`failureReason(BankTransferFailure failureReason)`
`String`	`getBankTransferId()` Plaid’s unique identifier for a bank transfer.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getEventType()` The asynchronous event to be simulated.
`BankTransferFailure`	`getFailureReason()` Get failureReason
`String`	`getSecret()` Your Plaid API `secret`.
`int`	`hashCode()`
`SandboxBankTransferSimulateRequest`	`secret(String secret)`
`void`	`setBankTransferId(String bankTransferId)`
`void`	`setClientId(String clientId)`
`void`	`setEventType(String eventType)`
`void`	`setFailureReason(BankTransferFailure failureReason)`
`void`	`setSecret(String secret)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_CLIENT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECRET
```
public static final String SERIALIZED_NAME_SECRET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BANK_TRANSFER_ID
```
public static final String SERIALIZED_NAME_BANK_TRANSFER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVENT_TYPE
```
public static final String SERIALIZED_NAME_EVENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAILURE_REASON
```
public static final String SERIALIZED_NAME_FAILURE_REASON
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SandboxBankTransferSimulateRequest
```
public SandboxBankTransferSimulateRequest()
```
- Method Detail
  - clientId
```
public SandboxBankTransferSimulateRequest clientId(String clientId)
```
  - getClientId
```
@Nullable
public String getClientId()
```
    Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
    
    Returns:
    
    clientId
  - setClientId
```
public void setClientId(String clientId)
```
  - secret
```
public SandboxBankTransferSimulateRequest secret(String secret)
```
  - getSecret
```
@Nullable
public String getSecret()
```
    Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
    
    Returns:
    
    secret
  - setSecret
```
public void setSecret(String secret)
```
  - bankTransferId
```
public SandboxBankTransferSimulateRequest bankTransferId(String bankTransferId)
```
  - getBankTransferId
```
public String getBankTransferId()
```
    Plaid’s unique identifier for a bank transfer.
    
    Returns:
    
    bankTransferId
  - setBankTransferId
```
public void setBankTransferId(String bankTransferId)
```
  - eventType
```
public SandboxBankTransferSimulateRequest eventType(String eventType)
```
  - getEventType
```
public String getEventType()
```
    The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`. An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include: `pending` --> `failed` `pending` --> `posted` `posted` --> `reversed`
    
    Returns:
    
    eventType
  - setEventType
```
public void setEventType(String eventType)
```
  - failureReason
```
public SandboxBankTransferSimulateRequest failureReason(BankTransferFailure failureReason)
```
  - getFailureReason
```
@Nullable
public BankTransferFailure getFailureReason()
```
    Get failureReason
    
    Returns:
    
    failureReason
  - setFailureReason
```
public void setFailureReason(BankTransferFailure failureReason)
```
  - 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 SandboxBankTransferSimulateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_BANK_TRANSFER_ID

SERIALIZED_NAME_EVENT_TYPE

SERIALIZED_NAME_FAILURE_REASON

Constructor Detail

SandboxBankTransferSimulateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

bankTransferId

getBankTransferId

setBankTransferId

eventType

getEventType

setEventType

failureReason

getFailureReason

setFailureReason

equals

hashCode

toString