Package app.cybrid.cybrid_api_bank.client.model

Class TransferBankModel

java.lang.Object

app.cybrid.cybrid_api_bank.client.model.TransferBankModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-02T21:23:00.145386Z[Etc/UTC]")
public class TransferBankModel
extends Object

TransferBankModel

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_DESTINATION_PARTICIPANTS
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_PAYMENT_RAIL
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_SOURCE_PARTICIPANTS
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

Modifier and Type	Method	Description
TransferBankModel	addDestinationParticipantsItem(TransferParticipantBankModel destinationParticipantsItem)
TransferBankModel	addLabelsItem(String labelsItem)
TransferBankModel	addSourceParticipantsItem(TransferParticipantBankModel sourceParticipantsItem)
TransferBankModel	amount(BigInteger amount)
TransferBankModel	asset(String asset)
TransferBankModel	bankGuid(String bankGuid)
TransferBankModel	createdAt(OffsetDateTime createdAt)
TransferBankModel	customerGuid(String customerGuid)
TransferBankModel	destinationAccount(TransferDestinationAccountBankModel destinationAccount)
TransferBankModel	destinationParticipants(List<TransferParticipantBankModel> destinationParticipants)
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
List<TransferParticipantBankModel>	getDestinationParticipants()	The participants in the source account.
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; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, or invalid_address.
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	getPaymentRail()	The rail the payment was done on.
String	getQuoteGuid()	The associated quote's identifier.
String	getReferenceTransferGuid()	The guid of the related transfer.
String	getSide()	The direction of the quote; one of deposit or withdrawal.
TransferSourceAccountBankModel	getSourceAccount()	Get sourceAccount
List<TransferParticipantBankModel>	getSourceParticipants()	The participants in the source account.
String	getState()	The state of the transfer; one of storing, pending, reviewing, completed, or failed.
Object	getTransferDetails()	The raw details on the transfer from the bank.
String	getTransferType()	The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, or instant_funding_return.
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	paymentRail(String paymentRail)
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	setDestinationParticipants(List<TransferParticipantBankModel> destinationParticipants)
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	setPaymentRail(String paymentRail)
void	setQuoteGuid(String quoteGuid)
void	setReferenceTransferGuid(String referenceTransferGuid)
void	setSide(String side)
void	setSourceAccount(TransferSourceAccountBankModel sourceAccount)
void	setSourceParticipants(List<TransferParticipantBankModel> sourceParticipants)
void	setState(String state)
void	setTransferDetails(Object transferDetails)
void	setTransferType(String transferType)
void	setTxnHash(String txnHash)
void	setUpdatedAt(OffsetDateTime updatedAt)
TransferBankModel	side(String side)
TransferBankModel	sourceAccount(TransferSourceAccountBankModel sourceAccount)
TransferBankModel	sourceParticipants(List<TransferParticipantBankModel> sourceParticipants)
TransferBankModel	state(String state)
String	toString()
TransferBankModel	transferDetails(Object transferDetails)
TransferBankModel	transferType(String 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_SOURCE_PARTICIPANTS

public static final String JSON_PROPERTY_SOURCE_PARTICIPANTS

See Also:

Constant Field Values

JSON_PROPERTY_DESTINATION_ACCOUNT

public static final String JSON_PROPERTY_DESTINATION_ACCOUNT

See Also:

Constant Field Values

JSON_PROPERTY_DESTINATION_PARTICIPANTS

public static final String JSON_PROPERTY_DESTINATION_PARTICIPANTS

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_PAYMENT_RAIL

public static final String JSON_PROPERTY_PAYMENT_RAIL

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(String transferType)

getTransferType

@Nullable
public String getTransferType()

The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, or instant_funding_return.

Returns:

transferType

setTransferType

public void setTransferType(String 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(String side)

getSide

@Nullable
public String getSide()

The direction of the quote; one of deposit or withdrawal.

Returns:

side

setSide

public void setSide(String side)

state

public TransferBankModel state(String state)

getState

@Nullable
public String getState()

The state of the transfer; one of storing, pending, reviewing, completed, or failed.

Returns:

state

setState

public void setState(String state)

failureCode

public TransferBankModel failureCode(String failureCode)

getFailureCode

@Nullable
public String getFailureCode()

The failure code for failed transfers; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, or invalid_address.

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)

sourceParticipants

public TransferBankModel sourceParticipants(List<TransferParticipantBankModel> sourceParticipants)

addSourceParticipantsItem

public TransferBankModel addSourceParticipantsItem(TransferParticipantBankModel sourceParticipantsItem)

getSourceParticipants

@Nullable
public List<TransferParticipantBankModel> getSourceParticipants()

The participants in the source account.

Returns:

sourceParticipants

setSourceParticipants

public void setSourceParticipants(List<TransferParticipantBankModel> sourceParticipants)

destinationAccount

public TransferBankModel destinationAccount(TransferDestinationAccountBankModel destinationAccount)

getDestinationAccount

@Nullable
public TransferDestinationAccountBankModel getDestinationAccount()

Get destinationAccount

Returns:

destinationAccount

setDestinationAccount

public void setDestinationAccount(TransferDestinationAccountBankModel destinationAccount)

destinationParticipants

public TransferBankModel destinationParticipants(List<TransferParticipantBankModel> destinationParticipants)

addDestinationParticipantsItem

public TransferBankModel addDestinationParticipantsItem(TransferParticipantBankModel destinationParticipantsItem)

getDestinationParticipants

@Nullable
public List<TransferParticipantBankModel> getDestinationParticipants()

The participants in the source account.

Returns:

destinationParticipants

setDestinationParticipants

public void setDestinationParticipants(List<TransferParticipantBankModel> destinationParticipants)

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)

paymentRail

public TransferBankModel paymentRail(String paymentRail)

getPaymentRail

@Nullable
public String getPaymentRail()

The rail the payment was done on. One of: ach, eft, wire, rtp

Returns:

paymentRail

setPaymentRail

public void setPaymentRail(String paymentRail)

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