Package com.adyen.model.balanceplatform
Class TransferRouteRequest
- java.lang.Object
-
- com.adyen.model.balanceplatform.TransferRouteRequest
-
public class TransferRouteRequest extends Object
TransferRouteRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransferRouteRequest.CategoryEnumThe type of transfer.static classTransferRouteRequest.PrioritiesEnumGets or Sets priorities
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_BALANCE_ACCOUNT_IDstatic StringJSON_PROPERTY_BALANCE_PLATFORMstatic StringJSON_PROPERTY_CATEGORYstatic StringJSON_PROPERTY_COUNTERPARTYstatic StringJSON_PROPERTY_COUNTRYstatic StringJSON_PROPERTY_CURRENCYstatic StringJSON_PROPERTY_PRIORITIES
-
Constructor Summary
Constructors Constructor Description TransferRouteRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TransferRouteRequestaddPrioritiesItem(TransferRouteRequest.PrioritiesEnum prioritiesItem)TransferRouteRequestbalanceAccountId(String balanceAccountId)TransferRouteRequestbalancePlatform(String balancePlatform)TransferRouteRequestcategory(TransferRouteRequest.CategoryEnum category)TransferRouteRequestcounterparty(Counterparty counterparty)TransferRouteRequestcountry(String country)TransferRouteRequestcurrency(String currency)booleanequals(Object o)Return true if this TransferRouteRequest object is equal to o.static TransferRouteRequestfromJson(String jsonString)Create an instance of TransferRouteRequest given an JSON stringStringgetBalanceAccountId()The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).StringgetBalancePlatform()The unique identifier assigned to the balance platform associated with the account holder.TransferRouteRequest.CategoryEnumgetCategory()The type of transfer.CounterpartygetCounterparty()Get counterpartyStringgetCountry()The two-character ISO-3166-1 alpha-2 country code of the counterparty.StringgetCurrency()The three-character ISO currency code of transfer.List<TransferRouteRequest.PrioritiesEnum>getPriorities()The list of priorities for the bank transfer.inthashCode()TransferRouteRequestpriorities(List<TransferRouteRequest.PrioritiesEnum> priorities)voidsetBalanceAccountId(String balanceAccountId)The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).voidsetBalancePlatform(String balancePlatform)The unique identifier assigned to the balance platform associated with the account holder.voidsetCategory(TransferRouteRequest.CategoryEnum category)The type of transfer.voidsetCounterparty(Counterparty counterparty)counterpartyvoidsetCountry(String country)The two-character ISO-3166-1 alpha-2 country code of the counterparty.voidsetCurrency(String currency)The three-character ISO currency code of transfer.voidsetPriorities(List<TransferRouteRequest.PrioritiesEnum> priorities)The list of priorities for the bank transfer.StringtoJson()Convert an instance of TransferRouteRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_BALANCE_ACCOUNT_ID
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BALANCE_PLATFORM
public static final String JSON_PROPERTY_BALANCE_PLATFORM
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CATEGORY
public static final String JSON_PROPERTY_CATEGORY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTERPARTY
public static final String JSON_PROPERTY_COUNTERPARTY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTRY
public static final String JSON_PROPERTY_COUNTRY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CURRENCY
public static final String JSON_PROPERTY_CURRENCY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIORITIES
public static final String JSON_PROPERTY_PRIORITIES
- See Also:
- Constant Field Values
-
-
Method Detail
-
balanceAccountId
public TransferRouteRequest 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). Required if `counterparty` is **transferInstrumentId**.- Returns:
- balanceAccountId
-
setBalanceAccountId
public void setBalanceAccountId(String balanceAccountId)
The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**.- Parameters:
balanceAccountId-
-
balancePlatform
public TransferRouteRequest balancePlatform(String balancePlatform)
-
getBalancePlatform
public String getBalancePlatform()
The unique identifier assigned to the balance platform associated with the account holder.- Returns:
- balancePlatform
-
setBalancePlatform
public void setBalancePlatform(String balancePlatform)
The unique identifier assigned to the balance platform associated with the account holder.- Parameters:
balancePlatform-
-
category
public TransferRouteRequest category(TransferRouteRequest.CategoryEnum category)
-
getCategory
public TransferRouteRequest.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.- Returns:
- category
-
setCategory
public void setCategory(TransferRouteRequest.CategoryEnum category)
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.- Parameters:
category-
-
counterparty
public TransferRouteRequest counterparty(Counterparty counterparty)
-
getCounterparty
public Counterparty getCounterparty()
Get counterparty- Returns:
- counterparty
-
setCounterparty
public void setCounterparty(Counterparty counterparty)
counterparty- Parameters:
counterparty-
-
country
public TransferRouteRequest country(String country)
-
getCountry
public String getCountry()
The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.- Returns:
- country
-
setCountry
public void setCountry(String country)
The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.- Parameters:
country-
-
currency
public TransferRouteRequest currency(String currency)
-
getCurrency
public String getCurrency()
The three-character ISO currency code of transfer. For example, **USD** or **EUR**.- Returns:
- currency
-
setCurrency
public void setCurrency(String currency)
The three-character ISO currency code of transfer. For example, **USD** or **EUR**.- Parameters:
currency-
-
priorities
public TransferRouteRequest priorities(List<TransferRouteRequest.PrioritiesEnum> priorities)
-
addPrioritiesItem
public TransferRouteRequest addPrioritiesItem(TransferRouteRequest.PrioritiesEnum prioritiesItem)
-
getPriorities
public List<TransferRouteRequest.PrioritiesEnum> getPriorities()
The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. 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:
- priorities
-
setPriorities
public void setPriorities(List<TransferRouteRequest.PrioritiesEnum> priorities)
The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. 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).- Parameters:
priorities-
-
equals
public boolean equals(Object o)
Return true if this TransferRouteRequest object is equal to o.
-
fromJson
public static TransferRouteRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of TransferRouteRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of TransferRouteRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to TransferRouteRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of TransferRouteRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-