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 category of transfer.
`static class`	`Transfer.DirectionEnum`	The direction of the 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 String`	`JSON_PROPERTY_ACCOUNT_HOLDER`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_BALANCE_ACCOUNT`
`static String`	`JSON_PROPERTY_CATEGORY`
`static String`	`JSON_PROPERTY_CATEGORY_DATA`
`static String`	`JSON_PROPERTY_COUNTERPARTY`
`static String`	`JSON_PROPERTY_CREATION_DATE`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_DIRECTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_PAYMENT_INSTRUMENT`
`static String`	`JSON_PROPERTY_REASON`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY`
`static String`	`JSON_PROPERTY_STATUS`

Constructor Summary

Constructors
Constructor Description

Transfer()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Transfer`	`accountHolder(ResourceReference accountHolder)`
`Transfer`	`amount(Amount amount)`
`Transfer`	`balanceAccount(ResourceReference balanceAccount)`
`Transfer`	`category(Transfer.CategoryEnum category)`
`Transfer`	`categoryData(TransferCategoryData categoryData)`
`Transfer`	`counterparty(CounterpartyV3 counterparty)`
`Transfer`	`creationDate(OffsetDateTime creationDate)`
`Transfer`	`description(String description)`
`Transfer`	`direction(Transfer.DirectionEnum direction)`
`boolean`	`equals(Object o)`	Return true if this Transfer object is equal to 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
`Transfer.CategoryEnum`	`getCategory()`	The category of transfer.
`TransferCategoryData`	`getCategoryData()`	Get categoryData
`CounterpartyV3`	`getCounterparty()`	Get counterparty
`OffsetDateTime`	`getCreationDate()`	The date and time when the event was triggered, in ISO 8601 extended format.
`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
`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`	`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`	`setCategory(Transfer.CategoryEnum category)`
`void`	`setCategoryData(TransferCategoryData categoryData)`
`void`	`setCounterparty(CounterpartyV3 counterparty)`
`void`	`setCreationDate(OffsetDateTime creationDate)`
`void`	`setDescription(String description)`
`void`	`setDirection(Transfer.DirectionEnum direction)`
`void`	`setId(String id)`
`void`	`setPaymentInstrument(PaymentInstrument paymentInstrument)`
`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()`

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

- Field Detail
  - JSON_PROPERTY_ACCOUNT_HOLDER
```
public static final String JSON_PROPERTY_ACCOUNT_HOLDER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BALANCE_ACCOUNT
```
public static final String JSON_PROPERTY_BALANCE_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CATEGORY
```
public static final String JSON_PROPERTY_CATEGORY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CATEGORY_DATA
```
public static final String JSON_PROPERTY_CATEGORY_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COUNTERPARTY
```
public static final String JSON_PROPERTY_COUNTERPARTY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CREATION_DATE
```
public static final String JSON_PROPERTY_CREATION_DATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DIRECTION
```
public static final String JSON_PROPERTY_DIRECTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_INSTRUMENT
```
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REASON
```
public static final String JSON_PROPERTY_REASON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY
```
public static final String JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STATUS
```
public static final String JSON_PROPERTY_STATUS
```
    See Also:
    
    Constant Field Values
- 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)
```
  - category
```
public Transfer category(Transfer.CategoryEnum category)
```
  - getCategory
```
public Transfer.CategoryEnum getCategory()
```
    The category 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)
```
  - categoryData
```
public Transfer categoryData(TransferCategoryData categoryData)
```
  - getCategoryData
```
public TransferCategoryData getCategoryData()
```
    Get categoryData
    
    Returns:
    
    categoryData
  - setCategoryData
```
public void setCategoryData(TransferCategoryData categoryData)
```
  - counterparty
```
public Transfer counterparty(CounterpartyV3 counterparty)
```
  - getCounterparty
```
public CounterpartyV3 getCounterparty()
```
    Get counterparty
    
    Returns:
    
    counterparty
  - setCounterparty
```
public void setCounterparty(CounterpartyV3 counterparty)
```
  - creationDate
```
public Transfer creationDate(OffsetDateTime creationDate)
```
  - getCreationDate
```
public OffsetDateTime getCreationDate()
```
    The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
    
    Returns:
    
    creationDate
  - setCreationDate
```
public void setCreationDate(OffsetDateTime creationDate)
```
  - 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)
```
  - 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 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)
```
    Return true if this Transfer 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 Transfer fromJson(String jsonString)
                         throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of Transfer given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of Transfer
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to Transfer
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of Transfer to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class Transfer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_HOLDER

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_BALANCE_ACCOUNT

JSON_PROPERTY_CATEGORY

JSON_PROPERTY_CATEGORY_DATA

JSON_PROPERTY_COUNTERPARTY

JSON_PROPERTY_CREATION_DATE

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_DIRECTION

JSON_PROPERTY_ID

JSON_PROPERTY_PAYMENT_INSTRUMENT

JSON_PROPERTY_REASON

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY

JSON_PROPERTY_STATUS

Constructor Detail

Transfer

Method Detail

accountHolder

getAccountHolder

setAccountHolder

amount

getAmount

setAmount

balanceAccount

getBalanceAccount

setBalanceAccount

category

getCategory

setCategory

categoryData

getCategoryData

setCategoryData

counterparty

getCounterparty

setCounterparty

creationDate

getCreationDate

setCreationDate

description

getDescription

setDescription

direction

getDirection

setDirection

id

getId

setId

paymentInstrument

getPaymentInstrument

setPaymentInstrument

reason

getReason

setReason

reference

getReference

setReference

referenceForBeneficiary

getReferenceForBeneficiary

setReferenceForBeneficiary

status

getStatus

setStatus

equals

hashCode

toString

fromJson

toJson