java.lang.Object
- com.adyen.model.balancecontrol.BalanceTransferRequest

public class BalanceTransferRequest
extends Object

BalanceTransferRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BalanceTransferRequest.TypeEnum
The type of balance transfer.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_FROM_MERCHANT`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_TO_MERCHANT`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

BalanceTransferRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BalanceTransferRequest`	`amount(Amount amount)`	amount
`BalanceTransferRequest`	`description(String description)`	A human-readable description for the transfer.
`boolean`	`equals(Object o)`	Return true if this BalanceTransferRequest object is equal to o.
`static BalanceTransferRequest`	`fromJson(String jsonString)`	Create an instance of BalanceTransferRequest given an JSON string
`BalanceTransferRequest`	`fromMerchant(String fromMerchant)`	The unique identifier of the source merchant account from which funds are deducted.
`Amount`	`getAmount()`	amount
`String`	`getDescription()`	A human-readable description for the transfer.
`String`	`getFromMerchant()`	The unique identifier of the source merchant account from which funds are deducted.
`String`	`getReference()`	A reference for the balance transfer.
`String`	`getToMerchant()`	The unique identifier of the destination merchant account from which funds are transferred.
`BalanceTransferRequest.TypeEnum`	`getType()`	The type of balance transfer.
`int`	`hashCode()`
`BalanceTransferRequest`	`reference(String reference)`	A reference for the balance transfer.
`void`	`setAmount(Amount amount)`	amount
`void`	`setDescription(String description)`	A human-readable description for the transfer.
`void`	`setFromMerchant(String fromMerchant)`	The unique identifier of the source merchant account from which funds are deducted.
`void`	`setReference(String reference)`	A reference for the balance transfer.
`void`	`setToMerchant(String toMerchant)`	The unique identifier of the destination merchant account from which funds are transferred.
`void`	`setType(BalanceTransferRequest.TypeEnum type)`	The type of balance transfer.
`String`	`toJson()`	Convert an instance of BalanceTransferRequest to an JSON string
`BalanceTransferRequest`	`toMerchant(String toMerchant)`	The unique identifier of the destination merchant account from which funds are transferred.
`String`	`toString()`
`BalanceTransferRequest`	`type(BalanceTransferRequest.TypeEnum type)`	The type of balance transfer.

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FROM_MERCHANT
```
public static final String JSON_PROPERTY_FROM_MERCHANT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TO_MERCHANT
```
public static final String JSON_PROPERTY_TO_MERCHANT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BalanceTransferRequest
```
public BalanceTransferRequest()
```
- Method Detail
  - amount
```
public BalanceTransferRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - description
```
public BalanceTransferRequest description(String description)
```
    A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
    
    Parameters:
    
    description -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getDescription
```
public String getDescription()
```
    A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
    A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
    
    Parameters:
    
    description -
  - fromMerchant
```
public BalanceTransferRequest fromMerchant(String fromMerchant)
```
    The unique identifier of the source merchant account from which funds are deducted.
    
    Parameters:
    
    fromMerchant -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getFromMerchant
```
public String getFromMerchant()
```
    The unique identifier of the source merchant account from which funds are deducted.
    
    Returns:
    
    fromMerchant
  - setFromMerchant
```
public void setFromMerchant(String fromMerchant)
```
    The unique identifier of the source merchant account from which funds are deducted.
    
    Parameters:
    
    fromMerchant -
  - reference
```
public BalanceTransferRequest reference(String reference)
```
    A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
    
    Parameters:
    
    reference -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getReference
```
public String getReference()
```
    A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
    
    Parameters:
    
    reference -
  - toMerchant
```
public BalanceTransferRequest toMerchant(String toMerchant)
```
    The unique identifier of the destination merchant account from which funds are transferred.
    
    Parameters:
    
    toMerchant -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getToMerchant
```
public String getToMerchant()
```
    The unique identifier of the destination merchant account from which funds are transferred.
    
    Returns:
    
    toMerchant
  - setToMerchant
```
public void setToMerchant(String toMerchant)
```
    The unique identifier of the destination merchant account from which funds are transferred.
    
    Parameters:
    
    toMerchant -
  - type
```
public BalanceTransferRequest type(BalanceTransferRequest.TypeEnum type)
```
    The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
    
    Parameters:
    
    type -
    
    Returns:
    
    the current BalanceTransferRequest instance, allowing for method chaining
  - getType
```
public BalanceTransferRequest.TypeEnum getType()
```
    The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
    
    Returns:
    
    type
  - setType
```
public void setType(BalanceTransferRequest.TypeEnum type)
```
    The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
    
    Parameters:
    
    type -
  - equals
```
public boolean equals(Object o)
```
    Return true if this BalanceTransferRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static BalanceTransferRequest fromJson(String jsonString)
                                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of BalanceTransferRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of BalanceTransferRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BalanceTransferRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of BalanceTransferRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class BalanceTransferRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_FROM_MERCHANT

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_TO_MERCHANT

JSON_PROPERTY_TYPE

Constructor Detail

BalanceTransferRequest

Method Detail

amount

getAmount

setAmount

description

getDescription

setDescription

fromMerchant

getFromMerchant

setFromMerchant

reference

getReference

setReference

toMerchant

getToMerchant

setToMerchant

type

getType

setType

equals

hashCode

toString

fromJson

toJson