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

public class TransferInfo
extends Object

TransferInfo

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TransferInfo.CategoryEnum`	The type of transfer.
`static class`	`TransferInfo.CustomTypeAdapterFactory`
`static class`	`TransferInfo.PriorityEnum`	The priority for the bank transfer.

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_AMOUNT`
`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_ID`
`static String`	`SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID`
`static String`	`SERIALIZED_NAME_PRIORITY`
`static String`	`SERIALIZED_NAME_REFERENCE`
`static String`	`SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY`

Constructor Summary

Constructors
Constructor Description

TransferInfo()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TransferInfo`	`amount(Amount amount)`
`TransferInfo`	`balanceAccountId(String balanceAccountId)`
`TransferInfo`	`category(TransferInfo.CategoryEnum category)`
`TransferInfo`	`counterparty(CounterpartyInfoV3 counterparty)`
`TransferInfo`	`description(String description)`
`boolean`	`equals(Object o)`
`static TransferInfo`	`fromJson(String jsonString)`	Create an instance of TransferInfo given an JSON string
`Amount`	`getAmount()`	Get amount
`String`	`getBalanceAccountId()`	The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
`TransferInfo.CategoryEnum`	`getCategory()`	The type of transfer.
`CounterpartyInfoV3`	`getCounterparty()`	Get counterparty
`String`	`getDescription()`	A human-readable description for the transfer.
`String`	`getId()`	The ID of the resource.
`String`	`getPaymentInstrumentId()`	The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
`TransferInfo.PriorityEnum`	`getPriority()`	The priority for the bank transfer.
`String`	`getReference()`	Your reference for the transfer, used internally within your platform.
`String`	`getReferenceForBeneficiary()`	A reference that is sent to the recipient.
`int`	`hashCode()`
`TransferInfo`	`id(String id)`
`TransferInfo`	`paymentInstrumentId(String paymentInstrumentId)`
`TransferInfo`	`priority(TransferInfo.PriorityEnum priority)`
`TransferInfo`	`reference(String reference)`
`TransferInfo`	`referenceForBeneficiary(String referenceForBeneficiary)`
`void`	`setAmount(Amount amount)`
`void`	`setBalanceAccountId(String balanceAccountId)`
`void`	`setCategory(TransferInfo.CategoryEnum category)`
`void`	`setCounterparty(CounterpartyInfoV3 counterparty)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setPaymentInstrumentId(String paymentInstrumentId)`
`void`	`setPriority(TransferInfo.PriorityEnum priority)`
`void`	`setReference(String reference)`
`void`	`setReferenceForBeneficiary(String referenceForBeneficiary)`
`String`	`toJson()`	Convert an instance of TransferInfo 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_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    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_ID
```
public static final String SERIALIZED_NAME_ID
```
    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_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
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - TransferInfo
```
public TransferInfo()
```
- Method Detail
  - amount
```
public TransferInfo amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - balanceAccountId
```
public TransferInfo balanceAccountId(String balanceAccountId)
```
  - getBalanceAccountId
```
public String getBalanceAccountId()
```
    The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
    
    Returns:
    
    balanceAccountId
  - setBalanceAccountId
```
public void setBalanceAccountId(String balanceAccountId)
```
  - category
```
public TransferInfo category(TransferInfo.CategoryEnum category)
```
  - getCategory
```
public TransferInfo.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(TransferInfo.CategoryEnum category)
```
  - counterparty
```
public TransferInfo counterparty(CounterpartyInfoV3 counterparty)
```
  - getCounterparty
```
public CounterpartyInfoV3 getCounterparty()
```
    Get counterparty
    
    Returns:
    
    counterparty
  - setCounterparty
```
public void setCounterparty(CounterpartyInfoV3 counterparty)
```
  - description
```
public TransferInfo description(String description)
```
  - 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)
```
  - id
```
public TransferInfo id(String id)
```
  - getId
```
public String getId()
```
    The ID of the resource.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - paymentInstrumentId
```
public TransferInfo paymentInstrumentId(String paymentInstrumentId)
```
  - getPaymentInstrumentId
```
public String getPaymentInstrumentId()
```
    The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
    
    Returns:
    
    paymentInstrumentId
  - setPaymentInstrumentId
```
public void setPaymentInstrumentId(String paymentInstrumentId)
```
  - priority
```
public TransferInfo priority(TransferInfo.PriorityEnum priority)
```
  - getPriority
```
public TransferInfo.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).
    
    Returns:
    
    priority
  - setPriority
```
public void setPriority(TransferInfo.PriorityEnum priority)
```
  - reference
```
public TransferInfo 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 TransferInfo 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)
```
  - 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 TransferInfo
  - fromJson
```
public static TransferInfo fromJson(String jsonString)
                             throws IOException
```
    Create an instance of TransferInfo given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of TransferInfo
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to TransferInfo
  - toJson
```
public String toJson()
```
    Convert an instance of TransferInfo to an JSON string
    
    Returns:
    
    JSON string

Class TransferInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_BALANCE_ACCOUNT_ID

SERIALIZED_NAME_CATEGORY

SERIALIZED_NAME_COUNTERPARTY

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_ID

SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID

SERIALIZED_NAME_PRIORITY

SERIALIZED_NAME_REFERENCE

SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY

openapiFields

openapiRequiredFields

Constructor Detail

TransferInfo

Method Detail

amount

getAmount

setAmount

balanceAccountId

getBalanceAccountId

setBalanceAccountId

category

getCategory

setCategory

counterparty

getCounterparty

setCounterparty

description

getDescription

setDescription

id

getId

setId

paymentInstrumentId

getPaymentInstrumentId

setPaymentInstrumentId

priority

getPriority

setPriority

reference

getReference

setReference

referenceForBeneficiary

getReferenceForBeneficiary

setReferenceForBeneficiary

equals

hashCode

toString

validateJsonObject

fromJson

toJson