Package app.cybrid.cybrid_api_bank.client.model

Class TransferBankModel

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-13T20:57:56.572581Z[Etc/UTC]")
public class TransferBankModel
extends Object
    TransferBankModel

    • Constructor Detail

      • TransferBankModel

        public TransferBankModel()

    • Method Detail

      • getGuid

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

      • setGuid

        public void setGuid​(String guid)

      • 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)

      • getBankGuid

        @Nullable
public String getBankGuid()
        The associated bank's identifier.
        Returns:
        bankGuid

      • getBankGuid_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getBankGuid_JsonNullable()

      • setBankGuid_JsonNullable

        public void setBankGuid_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> bankGuid)

      • setBankGuid

        public void setBankGuid​(String bankGuid)

      • getCustomerGuid

        @Nullable
public String getCustomerGuid()
        The associated customer's identifier.
        Returns:
        customerGuid

      • getCustomerGuid_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getCustomerGuid_JsonNullable()

      • setCustomerGuid_JsonNullable

        public void setCustomerGuid_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> customerGuid)

      • setCustomerGuid

        public void setCustomerGuid​(String customerGuid)

      • getQuoteGuid

        @Nullable
public String getQuoteGuid()
        The associated quote's identifier.
        Returns:
        quoteGuid

      • setQuoteGuid

        public void setQuoteGuid​(String quoteGuid)

      • getExternalBankAccountGuid

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

      • getExternalBankAccountGuid_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getExternalBankAccountGuid_JsonNullable()

      • setExternalBankAccountGuid_JsonNullable

        public void setExternalBankAccountGuid_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> externalBankAccountGuid)

      • setExternalBankAccountGuid

        public void setExternalBankAccountGuid​(String externalBankAccountGuid)

      • getAsset

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

      • setAsset

        public void setAsset​(String asset)

      • getSide

        @Nullable
public String getSide()
        The direction of the quote; one of deposit or withdrawal.
        Returns:
        side

      • setSide

        public void setSide​(String side)

      • 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)

      • 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

      • getFailureCode_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getFailureCode_JsonNullable()

      • setFailureCode_JsonNullable

        public void setFailureCode_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> failureCode)

      • setFailureCode

        public void setFailureCode​(String failureCode)

      • getReturnCode

        @Nullable
public String getReturnCode()
        The return code for reversed transfers
        Returns:
        returnCode

      • getReturnCode_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getReturnCode_JsonNullable()

      • setReturnCode_JsonNullable

        public void setReturnCode_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> returnCode)

      • setReturnCode

        public void setReturnCode​(String returnCode)

      • getAmount

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

      • getAmount_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<BigInteger> getAmount_JsonNullable()

      • setAmount_JsonNullable

        public void setAmount_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<BigInteger> amount)

      • setAmount

        public void setAmount​(BigInteger amount)

      • getEstimatedAmount

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

      • setEstimatedAmount

        public void setEstimatedAmount​(BigInteger estimatedAmount)

      • getFee

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

      • getEstimatedNetworkFee

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

      • getEstimatedNetworkFee_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<BigInteger> getEstimatedNetworkFee_JsonNullable()

      • setEstimatedNetworkFee_JsonNullable

        public void setEstimatedNetworkFee_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<BigInteger> estimatedNetworkFee)

      • setEstimatedNetworkFee

        public void setEstimatedNetworkFee​(BigInteger estimatedNetworkFee)

      • 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

      • getNetworkFee_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<BigInteger> getNetworkFee_JsonNullable()

      • setNetworkFee_JsonNullable

        public void setNetworkFee_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<BigInteger> networkFee)

      • setNetworkFee

        public void setNetworkFee​(BigInteger networkFee)

      • getNetworkFeeAsset

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

      • getNetworkFeeAsset_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getNetworkFeeAsset_JsonNullable()

      • setNetworkFeeAsset_JsonNullable

        public void setNetworkFeeAsset_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> networkFeeAsset)

      • setNetworkFeeAsset

        public void setNetworkFeeAsset​(String networkFeeAsset)

      • 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

      • getNetworkFeeLiabilityAmount_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<BigInteger> getNetworkFeeLiabilityAmount_JsonNullable()

      • setNetworkFeeLiabilityAmount_JsonNullable

        public void setNetworkFeeLiabilityAmount_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<BigInteger> 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

      • getNetworkFeeLiabilityAmountAsset_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getNetworkFeeLiabilityAmountAsset_JsonNullable()

      • setNetworkFeeLiabilityAmountAsset_JsonNullable

        public void setNetworkFeeLiabilityAmountAsset_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> networkFeeLiabilityAmountAsset)

      • setNetworkFeeLiabilityAmountAsset

        public void setNetworkFeeLiabilityAmountAsset​(String networkFeeLiabilityAmountAsset)

      • getTxnHash

        @Nullable
public String getTxnHash()
        The hash of the blockchain transaction
        Returns:
        txnHash

      • getTxnHash_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getTxnHash_JsonNullable()

      • setTxnHash_JsonNullable

        public void setTxnHash_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> txnHash)

      • setTxnHash

        public void setTxnHash​(String txnHash)

      • getReferenceTransferGuid

        @Nullable
public String getReferenceTransferGuid()
        The guid of the related transfer. Only present on return type transfers.
        Returns:
        referenceTransferGuid

      • getReferenceTransferGuid_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getReferenceTransferGuid_JsonNullable()

      • setReferenceTransferGuid_JsonNullable

        public void setReferenceTransferGuid_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> referenceTransferGuid)

      • setReferenceTransferGuid

        public void setReferenceTransferGuid​(String referenceTransferGuid)

      • getSourceAccount_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<TransferSourceAccountBankModel> getSourceAccount_JsonNullable()

      • setSourceAccount_JsonNullable

        public void setSourceAccount_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<TransferSourceAccountBankModel> sourceAccount)

      • getSourceParticipants_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<List<TransferParticipantBankModel>> getSourceParticipants_JsonNullable()

      • setSourceParticipants_JsonNullable

        public void setSourceParticipants_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<List<TransferParticipantBankModel>> sourceParticipants)

      • setDestinationAccount_JsonNullable

        public void setDestinationAccount_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<TransferDestinationAccountBankModel> destinationAccount)

      • getDestinationParticipants_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<List<TransferParticipantBankModel>> getDestinationParticipants_JsonNullable()

      • setDestinationParticipants_JsonNullable

        public void setDestinationParticipants_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<List<TransferParticipantBankModel>> destinationParticipants)

      • getDepositAddressGuid

        @Nullable
public String getDepositAddressGuid()
        The guid of the deposit address. Only present on crypto deposits.
        Returns:
        depositAddressGuid

      • getDepositAddressGuid_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getDepositAddressGuid_JsonNullable()

      • setDepositAddressGuid_JsonNullable

        public void setDepositAddressGuid_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> depositAddressGuid)

      • setDepositAddressGuid

        public void setDepositAddressGuid​(String depositAddressGuid)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        ISO8601 datetime the record was created at.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getUpdatedAt

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

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getHoldDetails_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<TransferHoldDetailsBankModel> getHoldDetails_JsonNullable()

      • setHoldDetails_JsonNullable

        public void setHoldDetails_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<TransferHoldDetailsBankModel> holdDetails)

      • getTransferDetails

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

      • getTransferDetails_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<Object> getTransferDetails_JsonNullable()

      • setTransferDetails_JsonNullable

        public void setTransferDetails_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<Object> transferDetails)

      • setTransferDetails

        public void setTransferDetails​(Object transferDetails)

      • getPaymentRail

        @Nullable
public String getPaymentRail()
        The rail the payment was done on. One of: ach, eft, wire, rtp
        Returns:
        paymentRail

      • getPaymentRail_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<String> getPaymentRail_JsonNullable()

      • setPaymentRail_JsonNullable

        public void setPaymentRail_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<String> paymentRail)

      • setPaymentRail

        public void setPaymentRail​(String paymentRail)

      • getLabels

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

      • getLabels_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<List<String>> getLabels_JsonNullable()

      • setLabels_JsonNullable

        public void setLabels_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<List<String>> labels)

      • setLabels

        public void setLabels​(List<String> labels)

      • getEntries_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<List<TransferEntryBankModel>> getEntries_JsonNullable()

      • setEntries_JsonNullable

        public void setEntries_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<List<TransferEntryBankModel>> entries)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object