java.lang.Object
- com.adyen.model.transfers.Transfer

```
public class Transfer
extends Object
```
Transfer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Transfer.CategoryEnum`	The type of transfer.
`static class`	`Transfer.CustomTypeAdapterFactory`
`static class`	`Transfer.DirectionEnum`	The direction of the transfer.
`static class`	`Transfer.PriorityEnum`	The priority for the bank transfer.
`static class`	`Transfer.ReasonEnum`	Additional information about the status of the transfer.
`static class`	`Transfer.StatusEnum`	The result of the transfer.

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ACCOUNT_HOLDER`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_BALANCE_ACCOUNT`
`static String`	`SERIALIZED_NAME_BALANCE_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_CATEGORY`
`static String`	`SERIALIZED_NAME_COUNTERPARTY`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DIRECTION`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_PAYMENT_INSTRUMENT`
`static String`	`SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID`
`static String`	`SERIALIZED_NAME_PRIORITY`
`static String`	`SERIALIZED_NAME_REASON`
`static String`	`SERIALIZED_NAME_REFERENCE`
`static String`	`SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY`
`static String`	`SERIALIZED_NAME_STATUS`

Constructor Summary

Constructors
Constructor Description

Transfer()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Transfer`	`accountHolder(ResourceReference accountHolder)`
`Transfer`	`amount(Amount amount)`
`Transfer`	`balanceAccount(ResourceReference balanceAccount)`
`Transfer`	`balanceAccountId(String balanceAccountId)`	Deprecated.
`Transfer`	`category(Transfer.CategoryEnum category)`
`Transfer`	`counterparty(CounterpartyV3 counterparty)`
`Transfer`	`description(String description)`
`Transfer`	`direction(Transfer.DirectionEnum direction)`
`boolean`	`equals(Object o)`
`static Transfer`	`fromJson(String jsonString)`	Create an instance of Transfer given an JSON string
`ResourceReference`	`getAccountHolder()`	Get accountHolder
`Amount`	`getAmount()`	Get amount
`ResourceReference`	`getBalanceAccount()`	Get balanceAccount
`String`	`getBalanceAccountId()`	Deprecated.
`Transfer.CategoryEnum`	`getCategory()`	The type of transfer.
`CounterpartyV3`	`getCounterparty()`	Get counterparty
`String`	`getDescription()`	Your description for the transfer.
`Transfer.DirectionEnum`	`getDirection()`	The direction of the transfer.
`String`	`getId()`	The ID of the resource.
`PaymentInstrument`	`getPaymentInstrument()`	Get paymentInstrument
`String`	`getPaymentInstrumentId()`	Deprecated.
`Transfer.PriorityEnum`	`getPriority()`	The priority for the bank transfer.
`Transfer.ReasonEnum`	`getReason()`	Additional information about the status of the transfer.
`String`	`getReference()`	Your reference for the transfer, used internally within your platform.
`String`	`getReferenceForBeneficiary()`	A reference that is sent to the recipient.
`Transfer.StatusEnum`	`getStatus()`	The result of the transfer.
`int`	`hashCode()`
`Transfer`	`id(String id)`
`Transfer`	`paymentInstrument(PaymentInstrument paymentInstrument)`
`Transfer`	`paymentInstrumentId(String paymentInstrumentId)`	Deprecated.
`Transfer`	`priority(Transfer.PriorityEnum priority)`
`Transfer`	`reason(Transfer.ReasonEnum reason)`
`Transfer`	`reference(String reference)`
`Transfer`	`referenceForBeneficiary(String referenceForBeneficiary)`
`void`	`setAccountHolder(ResourceReference accountHolder)`
`void`	`setAmount(Amount amount)`
`void`	`setBalanceAccount(ResourceReference balanceAccount)`
`void`	`setBalanceAccountId(String balanceAccountId)`	Deprecated.
`void`	`setCategory(Transfer.CategoryEnum category)`
`void`	`setCounterparty(CounterpartyV3 counterparty)`
`void`	`setDescription(String description)`
`void`	`setDirection(Transfer.DirectionEnum direction)`
`void`	`setId(String id)`
`void`	`setPaymentInstrument(PaymentInstrument paymentInstrument)`
`void`	`setPaymentInstrumentId(String paymentInstrumentId)`	Deprecated.
`void`	`setPriority(Transfer.PriorityEnum priority)`
`void`	`setReason(Transfer.ReasonEnum reason)`
`void`	`setReference(String reference)`
`void`	`setReferenceForBeneficiary(String referenceForBeneficiary)`
`void`	`setStatus(Transfer.StatusEnum status)`
`Transfer`	`status(Transfer.StatusEnum status)`
`String`	`toJson()`	Convert an instance of Transfer to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found

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

- Field Detail
  - SERIALIZED_NAME_ACCOUNT_HOLDER
```
public static final String SERIALIZED_NAME_ACCOUNT_HOLDER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BALANCE_ACCOUNT
```
public static final String SERIALIZED_NAME_BALANCE_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BALANCE_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_BALANCE_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CATEGORY
```
public static final String SERIALIZED_NAME_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNTERPARTY
```
public static final String SERIALIZED_NAME_COUNTERPARTY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DIRECTION
```
public static final String SERIALIZED_NAME_DIRECTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_INSTRUMENT
```
public static final String SERIALIZED_NAME_PAYMENT_INSTRUMENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID
```
public static final String SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRIORITY
```
public static final String SERIALIZED_NAME_PRIORITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REASON
```
public static final String SERIALIZED_NAME_REASON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFERENCE
```
public static final String SERIALIZED_NAME_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY
```
public static final String SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - Transfer
```
public Transfer()
```
- Method Detail
  - accountHolder
```
public Transfer accountHolder(ResourceReference accountHolder)
```
  - getAccountHolder
```
public ResourceReference getAccountHolder()
```
    Get accountHolder
    
    Returns:
    
    accountHolder
  - setAccountHolder
```
public void setAccountHolder(ResourceReference accountHolder)
```
  - amount
```
public Transfer amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - balanceAccount
```
public Transfer balanceAccount(ResourceReference balanceAccount)
```
  - getBalanceAccount
```
public ResourceReference getBalanceAccount()
```
    Get balanceAccount
    
    Returns:
    
    balanceAccount
  - setBalanceAccount
```
public void setBalanceAccount(ResourceReference balanceAccount)
```
  - balanceAccountId
```
@Deprecated
public Transfer balanceAccountId(String balanceAccountId)
```
    Deprecated.
  - getBalanceAccountId
```
@Deprecated
public String getBalanceAccountId()
```
    Deprecated.
    
    The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
    
    Returns:
    
    balanceAccountId
  - setBalanceAccountId
```
@Deprecated
public void setBalanceAccountId(String balanceAccountId)
```
    Deprecated.
  - category
```
public Transfer category(Transfer.CategoryEnum category)
```
  - getCategory
```
public Transfer.CategoryEnum getCategory()
```
    The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users.
    
    Returns:
    
    category
  - setCategory
```
public void setCategory(Transfer.CategoryEnum category)
```
  - counterparty
```
public Transfer counterparty(CounterpartyV3 counterparty)
```
  - getCounterparty
```
public CounterpartyV3 getCounterparty()
```
    Get counterparty
    
    Returns:
    
    counterparty
  - setCounterparty
```
public void setCounterparty(CounterpartyV3 counterparty)
```
  - description
```
public Transfer description(String description)
```
  - getDescription
```
public String getDescription()
```
    Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?**
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - direction
```
public Transfer direction(Transfer.DirectionEnum direction)
```
  - getDirection
```
public Transfer.DirectionEnum getDirection()
```
    The direction of the transfer. Possible values: **incoming**, **outgoing**.
    
    Returns:
    
    direction
  - setDirection
```
public void setDirection(Transfer.DirectionEnum direction)
```
  - id
```
public Transfer id(String id)
```
  - getId
```
public String getId()
```
    The ID of the resource.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - paymentInstrument
```
public Transfer paymentInstrument(PaymentInstrument paymentInstrument)
```
  - getPaymentInstrument
```
public PaymentInstrument getPaymentInstrument()
```
    Get paymentInstrument
    
    Returns:
    
    paymentInstrument
  - setPaymentInstrument
```
public void setPaymentInstrument(PaymentInstrument paymentInstrument)
```
  - paymentInstrumentId
```
@Deprecated
public Transfer paymentInstrumentId(String paymentInstrumentId)
```
    Deprecated.
  - getPaymentInstrumentId
```
@Deprecated
public String getPaymentInstrumentId()
```
    Deprecated.
    
    The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) used in the transfer.
    
    Returns:
    
    paymentInstrumentId
  - setPaymentInstrumentId
```
@Deprecated
public void setPaymentInstrumentId(String paymentInstrumentId)
```
    Deprecated.
  - priority
```
public Transfer priority(Transfer.PriorityEnum priority)
```
  - getPriority
```
public Transfer.PriorityEnum getPriority()
```
    The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).
    
    Returns:
    
    priority
  - setPriority
```
public void setPriority(Transfer.PriorityEnum priority)
```
  - reason
```
public Transfer reason(Transfer.ReasonEnum reason)
```
  - getReason
```
public Transfer.ReasonEnum getReason()
```
    Additional information about the status of the transfer.
    
    Returns:
    
    reason
  - setReason
```
public void setReason(Transfer.ReasonEnum reason)
```
  - reference
```
public Transfer reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - referenceForBeneficiary
```
public Transfer referenceForBeneficiary(String referenceForBeneficiary)
```
  - getReferenceForBeneficiary
```
public String getReferenceForBeneficiary()
```
    A reference that is sent to the recipient. This reference is also sent in all notification webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others.
    
    Returns:
    
    referenceForBeneficiary
  - setReferenceForBeneficiary
```
public void setReferenceForBeneficiary(String referenceForBeneficiary)
```
  - status
```
public Transfer status(Transfer.StatusEnum status)
```
  - getStatus
```
public Transfer.StatusEnum getStatus()
```
    The result of the transfer. For example, **authorised**, **refused**, or **error**.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(Transfer.StatusEnum status)
```
  - 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
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to Transfer
  - fromJson
```
public static Transfer fromJson(String jsonString)
                         throws IOException
```
    Create an instance of Transfer given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of Transfer
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to Transfer
  - toJson
```
public String toJson()
```
    Convert an instance of Transfer to an JSON string
    
    Returns:
    
    JSON string

Class Transfer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ACCOUNT_HOLDER

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_BALANCE_ACCOUNT

SERIALIZED_NAME_BALANCE_ACCOUNT_ID

SERIALIZED_NAME_CATEGORY

SERIALIZED_NAME_COUNTERPARTY

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_DIRECTION

SERIALIZED_NAME_ID

SERIALIZED_NAME_PAYMENT_INSTRUMENT

SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID

SERIALIZED_NAME_PRIORITY

SERIALIZED_NAME_REASON

SERIALIZED_NAME_REFERENCE

SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY

SERIALIZED_NAME_STATUS

openapiFields

openapiRequiredFields

Constructor Detail

Transfer

Method Detail

accountHolder

getAccountHolder

setAccountHolder

amount

getAmount

setAmount

balanceAccount

getBalanceAccount

setBalanceAccount

balanceAccountId

getBalanceAccountId

setBalanceAccountId

category

getCategory

setCategory

counterparty

getCounterparty

setCounterparty

description

getDescription

setDescription

direction

getDirection

setDirection

id

getId

setId

paymentInstrument

getPaymentInstrument

setPaymentInstrument

paymentInstrumentId

getPaymentInstrumentId

setPaymentInstrumentId

priority

getPriority

setPriority

reason

getReason

setReason

reference

getReference

setReference

referenceForBeneficiary

getReferenceForBeneficiary

setReferenceForBeneficiary

status

getStatus

setStatus

equals

hashCode

toString

validateJsonObject