java.lang.Object
- app.cybrid.cybrid_api_bank.client.model.TransferBankModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-12-09T17:57:32.653587Z[Etc/UTC]")
public class TransferBankModel
extends Object

TransferBankModel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TransferBankModel.SideEnum`	The direction of the quote: 'deposit' or 'withdrawal'.
`static class`	`TransferBankModel.StateEnum`	The transfer's state
`static class`	`TransferBankModel.TransferTypeEnum`	The type of transfer.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_ASSET`
`static String`	`JSON_PROPERTY_BANK_GUID`
`static String`	`JSON_PROPERTY_CREATED_AT`
`static String`	`JSON_PROPERTY_CUSTOMER_GUID`
`static String`	`JSON_PROPERTY_DESTINATION_ACCOUNT`
`static String`	`JSON_PROPERTY_ESTIMATED_AMOUNT`
`static String`	`JSON_PROPERTY_ESTIMATED_NETWORK_FEE`
`static String`	`JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID`
`static String`	`JSON_PROPERTY_FAILURE_CODE`
`static String`	`JSON_PROPERTY_FEE`
`static String`	`JSON_PROPERTY_GUID`
`static String`	`JSON_PROPERTY_LABELS`
`static String`	`JSON_PROPERTY_NETWORK_FEE`
`static String`	`JSON_PROPERTY_NETWORK_FEE_ASSET`
`static String`	`JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT`
`static String`	`JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT_ASSET`
`static String`	`JSON_PROPERTY_QUOTE_GUID`
`static String`	`JSON_PROPERTY_REFERENCE_TRANSFER_GUID`
`static String`	`JSON_PROPERTY_SIDE`
`static String`	`JSON_PROPERTY_SOURCE_ACCOUNT`
`static String`	`JSON_PROPERTY_STATE`
`static String`	`JSON_PROPERTY_TRANSFER_DETAILS`
`static String`	`JSON_PROPERTY_TRANSFER_TYPE`
`static String`	`JSON_PROPERTY_TXN_HASH`
`static String`	`JSON_PROPERTY_UPDATED_AT`

Constructor Summary

Constructors
Constructor Description

TransferBankModel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TransferBankModel`	`addLabelsItem(String labelsItem)`
`TransferBankModel`	`amount(BigInteger amount)`
`TransferBankModel`	`asset(String asset)`
`TransferBankModel`	`bankGuid(String bankGuid)`
`TransferBankModel`	`createdAt(OffsetDateTime createdAt)`
`TransferBankModel`	`customerGuid(String customerGuid)`
`TransferBankModel`	`destinationAccount(TransferDestinationAccountBankModel destinationAccount)`
`boolean`	`equals(Object o)`
`TransferBankModel`	`estimatedAmount(BigInteger estimatedAmount)`
`TransferBankModel`	`estimatedNetworkFee(BigInteger estimatedNetworkFee)`
`TransferBankModel`	`externalBankAccountGuid(String externalBankAccountGuid)`
`TransferBankModel`	`failureCode(String failureCode)`
`TransferBankModel`	`fee(BigInteger fee)`
`BigInteger`	`getAmount()`	The actual amount in base units of the asset.
`String`	`getAsset()`	The asset the transfer is related to, e.g., USD.
`String`	`getBankGuid()`	The associated bank's identifier.
`OffsetDateTime`	`getCreatedAt()`	ISO8601 datetime the record was created at.
`String`	`getCustomerGuid()`	The associated customer's identifier.
`TransferDestinationAccountBankModel`	`getDestinationAccount()`	Get destinationAccount
`BigInteger`	`getEstimatedAmount()`	The estimated amount in base units of the asset.
`BigInteger`	`getEstimatedNetworkFee()`	The estimated network fee in base units of network_fee_asset.
`String`	`getExternalBankAccountGuid()`	The associated external bank account's identifier.
`String`	`getFailureCode()`	The failure code for failed transfers.
`BigInteger`	`getFee()`	The fee associated with the transfer.
`String`	`getGuid()`	Auto-generated unique identifier for the transfer.
`List<String>`	`getLabels()`	The labels associated with the transfer.
`BigInteger`	`getNetworkFee()`	The actual network fee in base units of network_fee_asset.
`String`	`getNetworkFeeAsset()`	The asset code of the network fee.
`BigInteger`	`getNetworkFeeLiabilityAmount()`	The equivalent fiat network fee in base units of network_fee_liability_amount_asset.
`String`	`getNetworkFeeLiabilityAmountAsset()`	The fiat asset the network_fee_liability_amount is denominated in.
`String`	`getQuoteGuid()`	The associated quote's identifier.
`String`	`getReferenceTransferGuid()`	The guid of the related transfer.
`TransferBankModel.SideEnum`	`getSide()`	The direction of the quote: 'deposit' or 'withdrawal'.
`TransferSourceAccountBankModel`	`getSourceAccount()`	Get sourceAccount
`TransferBankModel.StateEnum`	`getState()`	The transfer's state
`Object`	`getTransferDetails()`	The raw details on the transfer from the bank.
`TransferBankModel.TransferTypeEnum`	`getTransferType()`	The type of transfer.
`String`	`getTxnHash()`	The hash of the blockchain transaction
`OffsetDateTime`	`getUpdatedAt()`	ISO8601 datetime the record was last updated at.
`TransferBankModel`	`guid(String guid)`
`int`	`hashCode()`
`TransferBankModel`	`labels(List<String> labels)`
`TransferBankModel`	`networkFee(BigInteger networkFee)`
`TransferBankModel`	`networkFeeAsset(String networkFeeAsset)`
`TransferBankModel`	`networkFeeLiabilityAmount(BigInteger networkFeeLiabilityAmount)`
`TransferBankModel`	`networkFeeLiabilityAmountAsset(String networkFeeLiabilityAmountAsset)`
`TransferBankModel`	`quoteGuid(String quoteGuid)`
`TransferBankModel`	`referenceTransferGuid(String referenceTransferGuid)`
`void`	`setAmount(BigInteger amount)`
`void`	`setAsset(String asset)`
`void`	`setBankGuid(String bankGuid)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setCustomerGuid(String customerGuid)`
`void`	`setDestinationAccount(TransferDestinationAccountBankModel destinationAccount)`
`void`	`setEstimatedAmount(BigInteger estimatedAmount)`
`void`	`setEstimatedNetworkFee(BigInteger estimatedNetworkFee)`
`void`	`setExternalBankAccountGuid(String externalBankAccountGuid)`
`void`	`setFailureCode(String failureCode)`
`void`	`setFee(BigInteger fee)`
`void`	`setGuid(String guid)`
`void`	`setLabels(List<String> labels)`
`void`	`setNetworkFee(BigInteger networkFee)`
`void`	`setNetworkFeeAsset(String networkFeeAsset)`
`void`	`setNetworkFeeLiabilityAmount(BigInteger networkFeeLiabilityAmount)`
`void`	`setNetworkFeeLiabilityAmountAsset(String networkFeeLiabilityAmountAsset)`
`void`	`setQuoteGuid(String quoteGuid)`
`void`	`setReferenceTransferGuid(String referenceTransferGuid)`
`void`	`setSide(TransferBankModel.SideEnum side)`
`void`	`setSourceAccount(TransferSourceAccountBankModel sourceAccount)`
`void`	`setState(TransferBankModel.StateEnum state)`
`void`	`setTransferDetails(Object transferDetails)`
`void`	`setTransferType(TransferBankModel.TransferTypeEnum transferType)`
`void`	`setTxnHash(String txnHash)`
`void`	`setUpdatedAt(OffsetDateTime updatedAt)`
`TransferBankModel`	`side(TransferBankModel.SideEnum side)`
`TransferBankModel`	`sourceAccount(TransferSourceAccountBankModel sourceAccount)`
`TransferBankModel`	`state(TransferBankModel.StateEnum state)`
`String`	`toString()`
`TransferBankModel`	`transferDetails(Object transferDetails)`
`TransferBankModel`	`transferType(TransferBankModel.TransferTypeEnum transferType)`
`TransferBankModel`	`txnHash(String txnHash)`
`TransferBankModel`	`updatedAt(OffsetDateTime updatedAt)`

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

Field Detail

JSON_PROPERTY_GUID

public static final String JSON_PROPERTY_GUID

See Also:: Constant Field Values

JSON_PROPERTY_TRANSFER_TYPE

public static final String JSON_PROPERTY_TRANSFER_TYPE

See Also:: Constant Field Values

JSON_PROPERTY_BANK_GUID

public static final String JSON_PROPERTY_BANK_GUID

See Also:: Constant Field Values

JSON_PROPERTY_CUSTOMER_GUID

public static final String JSON_PROPERTY_CUSTOMER_GUID

See Also:: Constant Field Values

JSON_PROPERTY_QUOTE_GUID

public static final String JSON_PROPERTY_QUOTE_GUID

See Also:: Constant Field Values

JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID

public static final String JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID

See Also:: Constant Field Values

JSON_PROPERTY_ASSET

public static final String JSON_PROPERTY_ASSET

See Also:: Constant Field Values

JSON_PROPERTY_SIDE

public static final String JSON_PROPERTY_SIDE

See Also:: Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:: Constant Field Values

JSON_PROPERTY_FAILURE_CODE

public static final String JSON_PROPERTY_FAILURE_CODE

See Also:: Constant Field Values

JSON_PROPERTY_AMOUNT

public static final String JSON_PROPERTY_AMOUNT

See Also:: Constant Field Values

JSON_PROPERTY_ESTIMATED_AMOUNT

public static final String JSON_PROPERTY_ESTIMATED_AMOUNT

See Also:: Constant Field Values

JSON_PROPERTY_FEE

public static final String JSON_PROPERTY_FEE

See Also:: Constant Field Values

JSON_PROPERTY_ESTIMATED_NETWORK_FEE

public static final String JSON_PROPERTY_ESTIMATED_NETWORK_FEE

See Also:: Constant Field Values

JSON_PROPERTY_NETWORK_FEE

public static final String JSON_PROPERTY_NETWORK_FEE

See Also:: Constant Field Values

JSON_PROPERTY_NETWORK_FEE_ASSET

public static final String JSON_PROPERTY_NETWORK_FEE_ASSET

See Also:: Constant Field Values

JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT

public static final String JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT

See Also:: Constant Field Values

JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT_ASSET

public static final String JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT_ASSET

See Also:: Constant Field Values

JSON_PROPERTY_TXN_HASH

public static final String JSON_PROPERTY_TXN_HASH

See Also:: Constant Field Values

JSON_PROPERTY_REFERENCE_TRANSFER_GUID

public static final String JSON_PROPERTY_REFERENCE_TRANSFER_GUID

See Also:: Constant Field Values

JSON_PROPERTY_SOURCE_ACCOUNT

public static final String JSON_PROPERTY_SOURCE_ACCOUNT

See Also:: Constant Field Values

JSON_PROPERTY_DESTINATION_ACCOUNT

public static final String JSON_PROPERTY_DESTINATION_ACCOUNT

See Also:: Constant Field Values

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

See Also:: Constant Field Values

JSON_PROPERTY_UPDATED_AT

public static final String JSON_PROPERTY_UPDATED_AT

See Also:: Constant Field Values

JSON_PROPERTY_TRANSFER_DETAILS

public static final String JSON_PROPERTY_TRANSFER_DETAILS

See Also:: Constant Field Values

JSON_PROPERTY_LABELS

public static final String JSON_PROPERTY_LABELS

See Also:: Constant Field Values

Constructor Detail
- TransferBankModel
```
public TransferBankModel()
```

Method Detail

guid

public TransferBankModel guid(String guid)

getGuid
```
@Nullable
public String getGuid()
```
Auto-generated unique identifier for the transfer.

Returns:

guid

setGuid
```
public void setGuid(String guid)
```

transferType

public TransferBankModel transferType(TransferBankModel.TransferTypeEnum transferType)

getTransferType

@Nullable
public TransferBankModel.TransferTypeEnum getTransferType()

The type of transfer.

Returns:: transferType

setTransferType

public void setTransferType(TransferBankModel.TransferTypeEnum transferType)

bankGuid

public TransferBankModel bankGuid(String bankGuid)

getBankGuid
```
@Nullable
public String getBankGuid()
```
The associated bank's identifier.

Returns:

bankGuid

setBankGuid

public void setBankGuid(String bankGuid)

customerGuid

public TransferBankModel customerGuid(String customerGuid)

getCustomerGuid
```
@Nullable
public String getCustomerGuid()
```
The associated customer's identifier.

Returns:

customerGuid

setCustomerGuid

public void setCustomerGuid(String customerGuid)

quoteGuid

public TransferBankModel quoteGuid(String quoteGuid)

getQuoteGuid
```
@Nullable
public String getQuoteGuid()
```
The associated quote's identifier.

Returns:

quoteGuid

setQuoteGuid

public void setQuoteGuid(String quoteGuid)

externalBankAccountGuid

public TransferBankModel externalBankAccountGuid(String externalBankAccountGuid)

getExternalBankAccountGuid
```
@Nullable
public String getExternalBankAccountGuid()
```
The associated external bank account's identifier.

Returns:

externalBankAccountGuid

setExternalBankAccountGuid

public void setExternalBankAccountGuid(String externalBankAccountGuid)

asset

public TransferBankModel asset(String asset)

getAsset
```
@Nullable
public String getAsset()
```
The asset the transfer is related to, e.g., USD.

Returns:

asset

setAsset

public void setAsset(String asset)

side

public TransferBankModel side(TransferBankModel.SideEnum side)

getSide
```
@Nullable
public TransferBankModel.SideEnum getSide()
```
The direction of the quote: 'deposit' or 'withdrawal'.

Returns:

side

setSide

public void setSide(TransferBankModel.SideEnum side)

state

public TransferBankModel state(TransferBankModel.StateEnum state)

getState

@Nullable
public TransferBankModel.StateEnum getState()

The transfer's state

Returns:: state

setState

public void setState(TransferBankModel.StateEnum state)

failureCode

public TransferBankModel failureCode(String failureCode)

getFailureCode
```
@Nullable
public String getFailureCode()
```
The failure code for failed transfers.

Returns:

failureCode

setFailureCode

public void setFailureCode(String failureCode)

amount

public TransferBankModel amount(BigInteger amount)

getAmount
```
@Nullable
public BigInteger getAmount()
```
The actual amount in base units of the asset.

Returns:

amount

setAmount

public void setAmount(BigInteger amount)

estimatedAmount

public TransferBankModel estimatedAmount(BigInteger estimatedAmount)

getEstimatedAmount
```
@Nullable
public BigInteger getEstimatedAmount()
```
The estimated amount in base units of the asset.

Returns:

estimatedAmount

setEstimatedAmount

public void setEstimatedAmount(BigInteger estimatedAmount)

fee

public TransferBankModel fee(BigInteger fee)

getFee
```
@Nullable
public BigInteger getFee()
```
The fee associated with the transfer.

Returns:

fee

setFee

public void setFee(BigInteger fee)

estimatedNetworkFee

public TransferBankModel estimatedNetworkFee(BigInteger estimatedNetworkFee)

getEstimatedNetworkFee
```
@Nullable
public BigInteger getEstimatedNetworkFee()
```
The estimated network fee in base units of network_fee_asset. Only present on `crypto` transfers.

Returns:

estimatedNetworkFee

setEstimatedNetworkFee

public void setEstimatedNetworkFee(BigInteger estimatedNetworkFee)

networkFee

public TransferBankModel networkFee(BigInteger networkFee)

getNetworkFee
```
@Nullable
public BigInteger getNetworkFee()
```
The actual network fee in base units of network_fee_asset. Only present on `crypto` transfers that have successfully completed.

Returns:

networkFee

setNetworkFee

public void setNetworkFee(BigInteger networkFee)

networkFeeAsset

public TransferBankModel networkFeeAsset(String networkFeeAsset)

getNetworkFeeAsset
```
@Nullable
public String getNetworkFeeAsset()
```
The asset code of the network fee. Only present on `crypto` transfers that have successfully completed.

Returns:

networkFeeAsset

setNetworkFeeAsset

public void setNetworkFeeAsset(String networkFeeAsset)

networkFeeLiabilityAmount

public TransferBankModel networkFeeLiabilityAmount(BigInteger networkFeeLiabilityAmount)

getNetworkFeeLiabilityAmount
```
@Nullable
public BigInteger getNetworkFeeLiabilityAmount()
```
The equivalent fiat network fee in base units of network_fee_liability_amount_asset. Only present on `crypto` transfers that have successfully completed.

Returns:

networkFeeLiabilityAmount

setNetworkFeeLiabilityAmount

public void setNetworkFeeLiabilityAmount(BigInteger networkFeeLiabilityAmount)

networkFeeLiabilityAmountAsset

public TransferBankModel networkFeeLiabilityAmountAsset(String networkFeeLiabilityAmountAsset)

getNetworkFeeLiabilityAmountAsset
```
@Nullable
public String getNetworkFeeLiabilityAmountAsset()
```
The fiat asset the network_fee_liability_amount is denominated in. Only present on `crypto` transfers that have successfully completed.

Returns:

networkFeeLiabilityAmountAsset

setNetworkFeeLiabilityAmountAsset

public void setNetworkFeeLiabilityAmountAsset(String networkFeeLiabilityAmountAsset)

txnHash

public TransferBankModel txnHash(String txnHash)

getTxnHash
```
@Nullable
public String getTxnHash()
```
The hash of the blockchain transaction

Returns:

txnHash

setTxnHash

public void setTxnHash(String txnHash)

referenceTransferGuid

public TransferBankModel referenceTransferGuid(String referenceTransferGuid)

getReferenceTransferGuid
```
@Nullable
public String getReferenceTransferGuid()
```
The guid of the related transfer. Only present on `funding_return` transfers.

Returns:

referenceTransferGuid

setReferenceTransferGuid

public void setReferenceTransferGuid(String referenceTransferGuid)

sourceAccount

public TransferBankModel sourceAccount(TransferSourceAccountBankModel sourceAccount)

getSourceAccount

@Nullable
public TransferSourceAccountBankModel getSourceAccount()

Get sourceAccount

Returns:: sourceAccount

setSourceAccount

public void setSourceAccount(TransferSourceAccountBankModel sourceAccount)

destinationAccount

public TransferBankModel destinationAccount(TransferDestinationAccountBankModel destinationAccount)

getDestinationAccount

@Nullable
public TransferDestinationAccountBankModel getDestinationAccount()

Get destinationAccount

Returns:: destinationAccount

setDestinationAccount

public void setDestinationAccount(TransferDestinationAccountBankModel destinationAccount)

createdAt

public TransferBankModel createdAt(OffsetDateTime createdAt)

getCreatedAt
```
@Nullable
public OffsetDateTime getCreatedAt()
```
ISO8601 datetime the record was created at.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public TransferBankModel updatedAt(OffsetDateTime updatedAt)

getUpdatedAt
```
@Nullable
public OffsetDateTime getUpdatedAt()
```
ISO8601 datetime the record was last updated at.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

transferDetails

public TransferBankModel transferDetails(Object transferDetails)

getTransferDetails
```
@Nullable
public Object getTransferDetails()
```
The raw details on the transfer from the bank.

Returns:

transferDetails

setTransferDetails

public void setTransferDetails(Object transferDetails)

labels

public TransferBankModel labels(List<String> labels)

addLabelsItem

public TransferBankModel addLabelsItem(String labelsItem)

getLabels
```
@Nullable
public List<String> getLabels()
```
The labels associated with the transfer.

Returns:

labels

setLabels

public void setLabels(List<String> labels)

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

Class TransferBankModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_GUID

JSON_PROPERTY_TRANSFER_TYPE

JSON_PROPERTY_BANK_GUID

JSON_PROPERTY_CUSTOMER_GUID

JSON_PROPERTY_QUOTE_GUID

JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID

JSON_PROPERTY_ASSET

JSON_PROPERTY_SIDE

JSON_PROPERTY_STATE

JSON_PROPERTY_FAILURE_CODE

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_ESTIMATED_AMOUNT

JSON_PROPERTY_FEE

JSON_PROPERTY_ESTIMATED_NETWORK_FEE

JSON_PROPERTY_NETWORK_FEE

JSON_PROPERTY_NETWORK_FEE_ASSET

JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT

JSON_PROPERTY_NETWORK_FEE_LIABILITY_AMOUNT_ASSET

JSON_PROPERTY_TXN_HASH

JSON_PROPERTY_REFERENCE_TRANSFER_GUID

JSON_PROPERTY_SOURCE_ACCOUNT

JSON_PROPERTY_DESTINATION_ACCOUNT

JSON_PROPERTY_CREATED_AT

JSON_PROPERTY_UPDATED_AT

JSON_PROPERTY_TRANSFER_DETAILS

JSON_PROPERTY_LABELS

Constructor Detail

TransferBankModel

Method Detail

guid

getGuid

setGuid

transferType

getTransferType

setTransferType

bankGuid

getBankGuid

setBankGuid

customerGuid

getCustomerGuid

setCustomerGuid

quoteGuid

getQuoteGuid

setQuoteGuid

externalBankAccountGuid

getExternalBankAccountGuid

setExternalBankAccountGuid

asset

getAsset

setAsset

side

getSide

setSide

state

getState

setState

failureCode

getFailureCode

setFailureCode

amount

getAmount

setAmount

estimatedAmount

getEstimatedAmount

setEstimatedAmount

fee

getFee

setFee

estimatedNetworkFee

getEstimatedNetworkFee

setEstimatedNetworkFee

networkFee

getNetworkFee