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

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

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

Defines the request schema for `/processor/bank_transfer/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACH_CLASS`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CUSTOM_TAG`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_NETWORK`
`static String`	`SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_PROCESSOR_TOKEN`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

ProcessorBankTransferCreateRequest()

Constructors
Constructor and Description
`ProcessorBankTransferCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessorBankTransferCreateRequest`	`achClass(ACHClass achClass)`
`ProcessorBankTransferCreateRequest`	`amount(String amount)`
`ProcessorBankTransferCreateRequest`	`clientId(String clientId)`
`ProcessorBankTransferCreateRequest`	`customTag(String customTag)`
`ProcessorBankTransferCreateRequest`	`description(String description)`
`boolean`	`equals(Object o)`
`ACHClass`	`getAchClass()` Get achClass
`String`	`getAmount()` The amount of the bank transfer (decimal string with two digits of precision e.g.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getCustomTag()` An arbitrary string provided by the client for storage with the bank transfer.
`String`	`getDescription()` The transfer description.
`String`	`getIdempotencyKey()` A random key provided by the client, per unique bank transfer.
`String`	`getIsoCurrencyCode()` The currency of the transfer amount – should be set to \"USD\".
`Map<String,String>`	`getMetadata()` The Metadata object is a mapping of client-provided string fields to any string value.
`BankTransferNetwork`	`getNetwork()` Get network
`String`	`getOriginationAccountId()` Plaid’s unique identifier for the origination account for this transfer.
`String`	`getProcessorToken()` The processor token obtained from the Plaid integration partner.
`String`	`getSecret()` Your Plaid API `secret`.
`BankTransferType`	`getType()` Get type
`BankTransferUser`	`getUser()` Get user
`int`	`hashCode()`
`ProcessorBankTransferCreateRequest`	`idempotencyKey(String idempotencyKey)`
`ProcessorBankTransferCreateRequest`	`isoCurrencyCode(String isoCurrencyCode)`
`ProcessorBankTransferCreateRequest`	`metadata(Map<String,String> metadata)`
`ProcessorBankTransferCreateRequest`	`network(BankTransferNetwork network)`
`ProcessorBankTransferCreateRequest`	`originationAccountId(String originationAccountId)`
`ProcessorBankTransferCreateRequest`	`processorToken(String processorToken)`
`ProcessorBankTransferCreateRequest`	`putMetadataItem(String key, String metadataItem)`
`ProcessorBankTransferCreateRequest`	`secret(String secret)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setClientId(String clientId)`
`void`	`setCustomTag(String customTag)`
`void`	`setDescription(String description)`
`void`	`setIdempotencyKey(String idempotencyKey)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setNetwork(BankTransferNetwork network)`
`void`	`setOriginationAccountId(String originationAccountId)`
`void`	`setProcessorToken(String processorToken)`
`void`	`setSecret(String secret)`
`void`	`setType(BankTransferType type)`
`void`	`setUser(BankTransferUser user)`
`String`	`toString()`
`ProcessorBankTransferCreateRequest`	`type(BankTransferType type)`
`ProcessorBankTransferCreateRequest`	`user(BankTransferUser user)`

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_IDEMPOTENCY_KEY

public static final String SERIALIZED_NAME_IDEMPOTENCY_KEY

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESSOR_TOKEN

public static final String SERIALIZED_NAME_PROCESSOR_TOKEN

See Also:: Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_NETWORK

public static final String SERIALIZED_NAME_NETWORK

See Also:: Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:: Constant Field Values

SERIALIZED_NAME_ISO_CURRENCY_CODE

public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE

See Also:: Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:: Constant Field Values

SERIALIZED_NAME_ACH_CLASS

public static final String SERIALIZED_NAME_ACH_CLASS

See Also:: Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:: Constant Field Values

SERIALIZED_NAME_CUSTOM_TAG

public static final String SERIALIZED_NAME_CUSTOM_TAG

See Also:: Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:: Constant Field Values

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

public static final String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

See Also:: Constant Field Values

Constructor Detail
- ProcessorBankTransferCreateRequest
```
public ProcessorBankTransferCreateRequest()
```

Method Detail

clientId

public ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest 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)
```

idempotencyKey

public ProcessorBankTransferCreateRequest idempotencyKey(String idempotencyKey)

getIdempotencyKey
```
public String getIdempotencyKey()
```
A random key provided by the client, per unique bank transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

Returns:

idempotencyKey

setIdempotencyKey

public void setIdempotencyKey(String idempotencyKey)

processorToken

public ProcessorBankTransferCreateRequest 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)

type

public ProcessorBankTransferCreateRequest type(BankTransferType type)

getType
```
public BankTransferType getType()
```
Get type

Returns:

type

setType

public void setType(BankTransferType type)

network

public ProcessorBankTransferCreateRequest network(BankTransferNetwork network)

getNetwork

public BankTransferNetwork getNetwork()

Get network

Returns:: network

setNetwork

public void setNetwork(BankTransferNetwork network)

amount

public ProcessorBankTransferCreateRequest amount(String amount)

getAmount
```
public String getAmount()
```
The amount of the bank transfer (decimal string with two digits of precision e.g. \"10.00\").

Returns:

amount

setAmount
```
public void setAmount(String amount)
```

isoCurrencyCode

public ProcessorBankTransferCreateRequest isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode
```
public String getIsoCurrencyCode()
```
The currency of the transfer amount – should be set to \"USD\".

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

description

public ProcessorBankTransferCreateRequest description(String description)

getDescription
```
public String getDescription()
```
The transfer description. Maximum of 10 characters.

Returns:

description

setDescription

public void setDescription(String description)

achClass

public ProcessorBankTransferCreateRequest achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:: achClass

setAchClass

public void setAchClass(ACHClass achClass)

user

public ProcessorBankTransferCreateRequest user(BankTransferUser user)

getUser
```
public BankTransferUser getUser()
```
Get user

Returns:

user

setUser

public void setUser(BankTransferUser user)

customTag

public ProcessorBankTransferCreateRequest customTag(String customTag)

getCustomTag
```
@Nullable
public String getCustomTag()
```
An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

Returns:

customTag

setCustomTag

public void setCustomTag(String customTag)

metadata

public ProcessorBankTransferCreateRequest metadata(Map<String,String> metadata)

putMetadataItem

public ProcessorBankTransferCreateRequest putMetadataItem(String key,
                                                          String metadataItem)

getMetadata
```
@Nullable
public Map<String,String> getMetadata()
```
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

originationAccountId

public ProcessorBankTransferCreateRequest originationAccountId(String originationAccountId)

getOriginationAccountId
```
@Nullable
public String getOriginationAccountId()
```
Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

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 ProcessorBankTransferCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_IDEMPOTENCY_KEY

SERIALIZED_NAME_PROCESSOR_TOKEN

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_USER

SERIALIZED_NAME_CUSTOM_TAG

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

Constructor Detail

ProcessorBankTransferCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

idempotencyKey

getIdempotencyKey

setIdempotencyKey

processorToken

getProcessorToken

setProcessorToken

type

getType

setType

network

getNetwork

setNetwork

amount

getAmount

setAmount

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

description

getDescription

setDescription

achClass

getAchClass

setAchClass

user

getUser

setUser

customTag

getCustomTag

setCustomTag

metadata

putMetadataItem

getMetadata

setMetadata

originationAccountId

getOriginationAccountId

setOriginationAccountId

equals

hashCode

toString