Class PostTransferBankModel
- java.lang.Object
-
- app.cybrid.cybrid_api_bank.client.model.PostTransferBankModel
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-11-05T16:45:10.687565Z[Etc/UTC]") public class PostTransferBankModel extends Object
Request body for transfer creation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPostTransferBankModel.ExpectedBehavioursEnumGets or Sets expectedBehavioursstatic classPostTransferBankModel.PaymentRailEnumThe desired payment rail to initiate the transfer for.static classPostTransferBankModel.TransferTypeEnumThe type of transfer.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_BANK_FIAT_ACCOUNT_GUIDstatic StringJSON_PROPERTY_BENEFICIARY_MEMOstatic StringJSON_PROPERTY_CUSTOMER_FIAT_ACCOUNT_GUIDstatic StringJSON_PROPERTY_CUSTOMER_GUIDstatic StringJSON_PROPERTY_DESTINATION_ACCOUNT_GUIDstatic StringJSON_PROPERTY_DESTINATION_PARTICIPANTSstatic StringJSON_PROPERTY_EXPECTED_BEHAVIOURSstatic StringJSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUIDstatic StringJSON_PROPERTY_EXTERNAL_WALLET_GUIDstatic StringJSON_PROPERTY_FIAT_ACCOUNT_GUIDstatic StringJSON_PROPERTY_LABELSstatic StringJSON_PROPERTY_NETWORK_FEE_ACCOUNT_GUIDstatic StringJSON_PROPERTY_PAYMENT_RAILstatic StringJSON_PROPERTY_QUOTE_GUIDstatic StringJSON_PROPERTY_SEND_AS_DEPOSIT_BANK_ACCOUNT_GUIDstatic StringJSON_PROPERTY_SOURCE_ACCOUNT_GUIDstatic StringJSON_PROPERTY_SOURCE_PARTICIPANTSstatic StringJSON_PROPERTY_TRANSFER_TYPE
-
Constructor Summary
Constructors Constructor Description PostTransferBankModel()
-
Method Summary
-
-
-
Field Detail
-
JSON_PROPERTY_QUOTE_GUID
public static final String JSON_PROPERTY_QUOTE_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_EXTERNAL_BANK_ACCOUNT_GUID
public static final String JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FIAT_ACCOUNT_GUID
public static final String JSON_PROPERTY_FIAT_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SEND_AS_DEPOSIT_BANK_ACCOUNT_GUID
public static final String JSON_PROPERTY_SEND_AS_DEPOSIT_BANK_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_RAIL
public static final String JSON_PROPERTY_PAYMENT_RAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BENEFICIARY_MEMO
public static final String JSON_PROPERTY_BENEFICIARY_MEMO
- 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_PARTICIPANTS
public static final String JSON_PROPERTY_DESTINATION_PARTICIPANTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BANK_FIAT_ACCOUNT_GUID
public static final String JSON_PROPERTY_BANK_FIAT_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CUSTOMER_FIAT_ACCOUNT_GUID
public static final String JSON_PROPERTY_CUSTOMER_FIAT_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOURCE_ACCOUNT_GUID
public static final String JSON_PROPERTY_SOURCE_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESTINATION_ACCOUNT_GUID
public static final String JSON_PROPERTY_DESTINATION_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXTERNAL_WALLET_GUID
public static final String JSON_PROPERTY_EXTERNAL_WALLET_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_NETWORK_FEE_ACCOUNT_GUID
public static final String JSON_PROPERTY_NETWORK_FEE_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPECTED_BEHAVIOURS
public static final String JSON_PROPERTY_EXPECTED_BEHAVIOURS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LABELS
public static final String JSON_PROPERTY_LABELS
- See Also:
- Constant Field Values
-
-
Method Detail
-
quoteGuid
public PostTransferBankModel quoteGuid(String quoteGuid)
-
getQuoteGuid
@Nonnull public String getQuoteGuid()
The associated quote's identifier.- Returns:
- quoteGuid
-
setQuoteGuid
public void setQuoteGuid(String quoteGuid)
-
transferType
public PostTransferBankModel transferType(PostTransferBankModel.TransferTypeEnum transferType)
-
getTransferType
@Nonnull public PostTransferBankModel.TransferTypeEnum getTransferType()
The type of transfer.- Returns:
- transferType
-
setTransferType
public void setTransferType(PostTransferBankModel.TransferTypeEnum transferType)
-
externalBankAccountGuid
public PostTransferBankModel externalBankAccountGuid(String externalBankAccountGuid)
-
getExternalBankAccountGuid
@Nullable public String getExternalBankAccountGuid()
The customer's 'plaid' or 'plaid_processor_token' external bank account's identifier. Required when transfer_type is funding or transfer_type is instant_funding.- Returns:
- externalBankAccountGuid
-
setExternalBankAccountGuid
public void setExternalBankAccountGuid(String externalBankAccountGuid)
-
fiatAccountGuid
public PostTransferBankModel fiatAccountGuid(String fiatAccountGuid)
-
getFiatAccountGuid
@Nullable public String getFiatAccountGuid()
The identifier for the fiat account to use for the transfer. Required if the customer or bank has multiple fiat accounts. Optional when transfer_type is funding.- Returns:
- fiatAccountGuid
-
setFiatAccountGuid
public void setFiatAccountGuid(String fiatAccountGuid)
-
sendAsDepositBankAccountGuid
public PostTransferBankModel sendAsDepositBankAccountGuid(String sendAsDepositBankAccountGuid)
-
getSendAsDepositBankAccountGuid
@Nullable public String getSendAsDepositBankAccountGuid()
The deposit bank account's identifier. Only valid for withdrawals. The deposit bank account must be owned by the customer or bank initiating the transfer. Optional when transfer_type is funding.- Returns:
- sendAsDepositBankAccountGuid
-
setSendAsDepositBankAccountGuid
public void setSendAsDepositBankAccountGuid(String sendAsDepositBankAccountGuid)
-
paymentRail
public PostTransferBankModel paymentRail(PostTransferBankModel.PaymentRailEnum paymentRail)
-
getPaymentRail
@Nullable public PostTransferBankModel.PaymentRailEnum getPaymentRail()
The desired payment rail to initiate the transfer for. Optional when transfer_type is funding.- Returns:
- paymentRail
-
setPaymentRail
public void setPaymentRail(PostTransferBankModel.PaymentRailEnum paymentRail)
-
beneficiaryMemo
public PostTransferBankModel beneficiaryMemo(String beneficiaryMemo)
-
getBeneficiaryMemo
@Nullable public String getBeneficiaryMemo()
The memo to send to the counterparty. Optional when transfer_type is funding.- Returns:
- beneficiaryMemo
-
setBeneficiaryMemo
public void setBeneficiaryMemo(String beneficiaryMemo)
-
sourceParticipants
public PostTransferBankModel sourceParticipants(List<PostTransferParticipantBankModel> sourceParticipants)
-
addSourceParticipantsItem
public PostTransferBankModel addSourceParticipantsItem(PostTransferParticipantBankModel sourceParticipantsItem)
-
getSourceParticipants
@Nullable public List<PostTransferParticipantBankModel> getSourceParticipants()
The source participants for the transfer. Optional when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, transfer_type is crypto, or transfer_type is lightning.- Returns:
- sourceParticipants
-
setSourceParticipants
public void setSourceParticipants(List<PostTransferParticipantBankModel> sourceParticipants)
-
destinationParticipants
public PostTransferBankModel destinationParticipants(List<PostTransferParticipantBankModel> destinationParticipants)
-
addDestinationParticipantsItem
public PostTransferBankModel addDestinationParticipantsItem(PostTransferParticipantBankModel destinationParticipantsItem)
-
getDestinationParticipants
@Nullable public List<PostTransferParticipantBankModel> getDestinationParticipants()
The destination participants for the transfer. Optional when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, transfer_type is crypto, or transfer_type is lightning.- Returns:
- destinationParticipants
-
setDestinationParticipants
public void setDestinationParticipants(List<PostTransferParticipantBankModel> destinationParticipants)
-
bankFiatAccountGuid
public PostTransferBankModel bankFiatAccountGuid(String bankFiatAccountGuid)
-
getBankFiatAccountGuid
@Nullable public String getBankFiatAccountGuid()
The identifier for the fiat account to use for the transfer. Required if the bank has multiple fiat accounts. Optional when transfer_type is instant_funding or transfer_type is lightning.- Returns:
- bankFiatAccountGuid
-
setBankFiatAccountGuid
public void setBankFiatAccountGuid(String bankFiatAccountGuid)
-
customerFiatAccountGuid
public PostTransferBankModel customerFiatAccountGuid(String customerFiatAccountGuid)
-
getCustomerFiatAccountGuid
@Nullable public String getCustomerFiatAccountGuid()
The identifier for the fiat account to use for the transfer. Required if the customer has multiple fiat accounts. Optional when transfer_type is instant_funding or transfer_type is lightning.- Returns:
- customerFiatAccountGuid
-
setCustomerFiatAccountGuid
public void setCustomerFiatAccountGuid(String customerFiatAccountGuid)
-
sourceAccountGuid
public PostTransferBankModel sourceAccountGuid(String sourceAccountGuid)
-
getSourceAccountGuid
@Nullable public String getSourceAccountGuid()
The source account's identifier. Required when transfer_type is book or transfer_type is inter_account.- Returns:
- sourceAccountGuid
-
setSourceAccountGuid
public void setSourceAccountGuid(String sourceAccountGuid)
-
destinationAccountGuid
public PostTransferBankModel destinationAccountGuid(String destinationAccountGuid)
-
getDestinationAccountGuid
@Nullable public String getDestinationAccountGuid()
The destination account's identifier. Required when transfer_type is book or transfer_type is inter_account.- Returns:
- destinationAccountGuid
-
setDestinationAccountGuid
public void setDestinationAccountGuid(String destinationAccountGuid)
-
externalWalletGuid
public PostTransferBankModel externalWalletGuid(String externalWalletGuid)
-
getExternalWalletGuid
@Nullable public String getExternalWalletGuid()
The customer's external wallet's identifier. Optional when transfer_type is crypto.- Returns:
- externalWalletGuid
-
setExternalWalletGuid
public void setExternalWalletGuid(String externalWalletGuid)
-
customerGuid
public PostTransferBankModel customerGuid(String customerGuid)
-
getCustomerGuid
@Nullable public String getCustomerGuid()
The customer's identifier. Required when transfer_type is lightning.- Returns:
- customerGuid
-
setCustomerGuid
public void setCustomerGuid(String customerGuid)
-
networkFeeAccountGuid
public PostTransferBankModel networkFeeAccountGuid(String networkFeeAccountGuid)
-
getNetworkFeeAccountGuid
@Nullable public String getNetworkFeeAccountGuid()
The network fee account's identifier. Required for network fee transfers. Must be the identifier for the customer's or bank's fiat or trading account. For customer's to pay the network fees, include the customer's fiat or trading account guid. For bank's to pay the network fees, include the bank's fiat or trading account guid. Required when transfer_type is lightning.- Returns:
- networkFeeAccountGuid
-
setNetworkFeeAccountGuid
public void setNetworkFeeAccountGuid(String networkFeeAccountGuid)
-
expectedBehaviours
public PostTransferBankModel expectedBehaviours(List<PostTransferBankModel.ExpectedBehavioursEnum> expectedBehaviours)
-
addExpectedBehavioursItem
public PostTransferBankModel addExpectedBehavioursItem(PostTransferBankModel.ExpectedBehavioursEnum expectedBehavioursItem)
-
getExpectedBehaviours
@Nullable public List<PostTransferBankModel.ExpectedBehavioursEnum> getExpectedBehaviours()
The optional expected behaviour to simulate. Only applicable for transfers under sandbox banks. The force_review behaviour will force the transfer to be reviewed for funding and instant_funding transfers.- Returns:
- expectedBehaviours
-
setExpectedBehaviours
public void setExpectedBehaviours(List<PostTransferBankModel.ExpectedBehavioursEnum> expectedBehaviours)
-
labels
public PostTransferBankModel labels(List<String> labels)
-
addLabelsItem
public PostTransferBankModel addLabelsItem(String labelsItem)
-
getLabels
@Nullable public List<String> getLabels()
The labels associated with the transfer.- Returns:
- labels
-
-