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

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

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

Defines the request schema for `/transfer/refund/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TRANSFER_ID`

Constructor Summary

Constructors
Constructor and Description

TransferRefundCreateRequest()

Constructors
Constructor and Description
`TransferRefundCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferRefundCreateRequest`	`amount(String amount)`
`TransferRefundCreateRequest`	`clientId(String clientId)`
`boolean`	`equals(Object o)`
`String`	`getAmount()` The amount of the refund (decimal string with two digits of precision e.g.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getIdempotencyKey()` A random key provided by the client, per unique refund.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTransferId()` The ID of the transfer to refund.
`int`	`hashCode()`
`TransferRefundCreateRequest`	`idempotencyKey(String idempotencyKey)`
`TransferRefundCreateRequest`	`secret(String secret)`
`void`	`setAmount(String amount)`
`void`	`setClientId(String clientId)`
`void`	`setIdempotencyKey(String idempotencyKey)`
`void`	`setSecret(String secret)`
`void`	`setTransferId(String transferId)`
`String`	`toString()`
`TransferRefundCreateRequest`	`transferId(String transferId)`

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_TRANSFER_ID
```
public static final String SERIALIZED_NAME_TRANSFER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IDEMPOTENCY_KEY
```
public static final String SERIALIZED_NAME_IDEMPOTENCY_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferRefundCreateRequest
```
public TransferRefundCreateRequest()
```
- Method Detail
  - clientId
```
public TransferRefundCreateRequest 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 TransferRefundCreateRequest 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)
```
  - transferId
```
public TransferRefundCreateRequest transferId(String transferId)
```
  - getTransferId
```
public String getTransferId()
```
    The ID of the transfer to refund.
    
    Returns:
    
    transferId
  - setTransferId
```
public void setTransferId(String transferId)
```
  - amount
```
public TransferRefundCreateRequest amount(String amount)
```
  - getAmount
```
public String getAmount()
```
    The amount of the refund (decimal string with two digits of precision e.g. \"10.00\").
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - idempotencyKey
```
public TransferRefundCreateRequest idempotencyKey(String idempotencyKey)
```
  - getIdempotencyKey
```
public String getIdempotencyKey()
```
    A random key provided by the client, per unique refund. 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 refund fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single refund is created.
    
    Returns:
    
    idempotencyKey
  - setIdempotencyKey
```
public void setIdempotencyKey(String idempotencyKey)
```
  - 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 TransferRefundCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_TRANSFER_ID

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_IDEMPOTENCY_KEY

Constructor Detail

TransferRefundCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

transferId

getTransferId

setTransferId

amount

getAmount

setAmount

idempotencyKey

getIdempotencyKey

setIdempotencyKey

equals

hashCode

toString