ProcessorSignalEvaluateRequest (com.plaid:plaid-java 29.0.0 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class ProcessorSignalEvaluateRequest
extends Object

ProcessorSignalEvaluateRequest defines the request schema for `/processor/signal/evaluate`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static String`	`SERIALIZED_NAME_DEFAULT_PAYMENT_METHOD`
`static String`	`SERIALIZED_NAME_DEVICE`
`static String`	`SERIALIZED_NAME_IS_RECURRING`
`static String`	`SERIALIZED_NAME_PROCESSOR_TOKEN`
`static String`	`SERIALIZED_NAME_RULESET_KEY`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_USER_PRESENT`

Constructor Summary

Constructors
Constructor and Description

ProcessorSignalEvaluateRequest()

Constructors
Constructor and Description
`ProcessorSignalEvaluateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessorSignalEvaluateRequest`	`amount(Double amount)`
`ProcessorSignalEvaluateRequest`	`clientId(String clientId)`
`ProcessorSignalEvaluateRequest`	`clientTransactionId(String clientTransactionId)`
`ProcessorSignalEvaluateRequest`	`clientUserId(String clientUserId)`
`ProcessorSignalEvaluateRequest`	`defaultPaymentMethod(String defaultPaymentMethod)`
`ProcessorSignalEvaluateRequest`	`device(SignalDevice device)`
`boolean`	`equals(Object o)`
`Double`	`getAmount()` The transaction amount, in USD (e.g.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getClientTransactionId()` The unique ID that you would like to use to refer to this transaction.
`String`	`getClientUserId()` A unique ID that identifies the end user in your system.
`String`	`getDefaultPaymentMethod()` The default ACH or non-ACH payment method to complete the transaction.
`SignalDevice`	`getDevice()` Get device
`Boolean`	`getIsRecurring()` true if the ACH transaction is a recurring transaction; false otherwise
`String`	`getProcessorToken()` The processor token obtained from the Plaid integration partner.
`String`	`getRulesetKey()` The key of the Ruleset to use for this transaction.
`String`	`getSecret()` Your Plaid API `secret`.
`SignalUser`	`getUser()` Get user
`Boolean`	`getUserPresent()` `true` if the end user is present while initiating the ACH transfer and the endpoint is being called; `false` otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).
`int`	`hashCode()`
`ProcessorSignalEvaluateRequest`	`isRecurring(Boolean isRecurring)`
`ProcessorSignalEvaluateRequest`	`processorToken(String processorToken)`
`ProcessorSignalEvaluateRequest`	`rulesetKey(String rulesetKey)`
`ProcessorSignalEvaluateRequest`	`secret(String secret)`
`void`	`setAmount(Double amount)`
`void`	`setClientId(String clientId)`
`void`	`setClientTransactionId(String clientTransactionId)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setDefaultPaymentMethod(String defaultPaymentMethod)`
`void`	`setDevice(SignalDevice device)`
`void`	`setIsRecurring(Boolean isRecurring)`
`void`	`setProcessorToken(String processorToken)`
`void`	`setRulesetKey(String rulesetKey)`
`void`	`setSecret(String secret)`
`void`	`setUser(SignalUser user)`
`void`	`setUserPresent(Boolean userPresent)`
`String`	`toString()`
`ProcessorSignalEvaluateRequest`	`user(SignalUser user)`
`ProcessorSignalEvaluateRequest`	`userPresent(Boolean userPresent)`

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_PROCESSOR_TOKEN
```
public static final String SERIALIZED_NAME_PROCESSOR_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_CLIENT_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER_PRESENT
```
public static final String SERIALIZED_NAME_USER_PRESENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CLIENT_USER_ID
```
public static final String SERIALIZED_NAME_CLIENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_RECURRING
```
public static final String SERIALIZED_NAME_IS_RECURRING
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DEFAULT_PAYMENT_METHOD
```
public static final String SERIALIZED_NAME_DEFAULT_PAYMENT_METHOD
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DEVICE
```
public static final String SERIALIZED_NAME_DEVICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RULESET_KEY
```
public static final String SERIALIZED_NAME_RULESET_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessorSignalEvaluateRequest
```
public ProcessorSignalEvaluateRequest()
```
- Method Detail
  - clientId
```
public ProcessorSignalEvaluateRequest 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 ProcessorSignalEvaluateRequest 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)
```
  - processorToken
```
public ProcessorSignalEvaluateRequest processorToken(String processorToken)
```
  - getProcessorToken
```
public String getProcessorToken()
```
    The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
    
    Returns:
    
    processorToken
  - setProcessorToken
```
public void setProcessorToken(String processorToken)
```
  - clientTransactionId
```
public ProcessorSignalEvaluateRequest clientTransactionId(String clientTransactionId)
```
  - getClientTransactionId
```
public String getClientTransactionId()
```
    The unique ID that you would like to use to refer to this transaction. For your convenience mapping your internal data, you could use your internal ID/identifier for this transaction. The max length for this field is 36 characters.
    
    Returns:
    
    clientTransactionId
  - setClientTransactionId
```
public void setClientTransactionId(String clientTransactionId)
```
  - amount
```
public ProcessorSignalEvaluateRequest amount(Double amount)
```
  - getAmount
```
public Double getAmount()
```
    The transaction amount, in USD (e.g. `102.05`)
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Double amount)
```
  - userPresent
```
public ProcessorSignalEvaluateRequest userPresent(Boolean userPresent)
```
  - getUserPresent
```
@Nullable
public Boolean getUserPresent()
```
    `true` if the end user is present while initiating the ACH transfer and the endpoint is being called; `false` otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).
    
    Returns:
    
    userPresent
  - setUserPresent
```
public void setUserPresent(Boolean userPresent)
```
  - clientUserId
```
public ProcessorSignalEvaluateRequest clientUserId(String clientUserId)
```
  - getClientUserId
```
@Nullable
public String getClientUserId()
```
    A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - isRecurring
```
public ProcessorSignalEvaluateRequest isRecurring(Boolean isRecurring)
```
  - getIsRecurring
```
@Nullable
public Boolean getIsRecurring()
```
    **true** if the ACH transaction is a recurring transaction; **false** otherwise
    
    Returns:
    
    isRecurring
  - setIsRecurring
```
public void setIsRecurring(Boolean isRecurring)
```
  - defaultPaymentMethod
```
public ProcessorSignalEvaluateRequest defaultPaymentMethod(String defaultPaymentMethod)
```
  - getDefaultPaymentMethod
```
@Nullable
public String getDefaultPaymentMethod()
```
    The default ACH or non-ACH payment method to complete the transaction. `SAME_DAY_ACH`: Same Day ACH by NACHA. The debit transaction is processed and settled on the same day `NEXT_DAY_ACH`: Next Day ACH settlement for debit transactions, offered by some payment processors `STANDARD_ACH`: standard ACH by NACHA `REAL_TIME_PAYMENTS`: real-time payments such as RTP and FedNow `DEBIT_CARD`: if the default payment is over debit card networks `MULTIPLE_PAYMENT_METHODS`: if there is no default debit rail or there are multiple payment methods Possible values: `SAME_DAY_ACH`, `NEXT_DAY_ACH`, `STANDARD_ACH`, `REAL_TIME_PAYMENTS`, `DEBIT_CARD`, `MULTIPLE_PAYMENT_METHODS`
    
    Returns:
    
    defaultPaymentMethod
  - setDefaultPaymentMethod
```
public void setDefaultPaymentMethod(String defaultPaymentMethod)
```
  - user
```
public ProcessorSignalEvaluateRequest user(SignalUser user)
```
  - getUser
```
@Nullable
public SignalUser getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(SignalUser user)
```
  - device
```
public ProcessorSignalEvaluateRequest device(SignalDevice device)
```
  - getDevice
```
@Nullable
public SignalDevice getDevice()
```
    Get device
    
    Returns:
    
    device
  - setDevice
```
public void setDevice(SignalDevice device)
```
  - rulesetKey
```
public ProcessorSignalEvaluateRequest rulesetKey(String rulesetKey)
```
  - getRulesetKey
```
@Nullable
public String getRulesetKey()
```
    The key of the Ruleset to use for this transaction. You can configure a Ruleset using the Signal dashboard located within the Plaid Dashboard. If not provided, no Ruleset will be used. This feature is currently in closed beta; to request access, contact your account manager.
    
    Returns:
    
    rulesetKey
  - setRulesetKey
```
public void setRulesetKey(String rulesetKey)
```
  - 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 ProcessorSignalEvaluateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_PROCESSOR_TOKEN

SERIALIZED_NAME_CLIENT_TRANSACTION_ID

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_USER_PRESENT

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_IS_RECURRING

SERIALIZED_NAME_DEFAULT_PAYMENT_METHOD

SERIALIZED_NAME_USER

SERIALIZED_NAME_DEVICE

SERIALIZED_NAME_RULESET_KEY

Constructor Detail

ProcessorSignalEvaluateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

processorToken

getProcessorToken

setProcessorToken

clientTransactionId

getClientTransactionId

setClientTransactionId

amount

getAmount

setAmount

userPresent

getUserPresent

setUserPresent

clientUserId

getClientUserId

setClientUserId

isRecurring

getIsRecurring

setIsRecurring

defaultPaymentMethod

getDefaultPaymentMethod

setDefaultPaymentMethod

user

getUser

setUser

device

getDevice

setDevice

rulesetKey

getRulesetKey

setRulesetKey

equals

hashCode

toString