docs/PostTransferBankModel

CybridApiBank::PostTransferBankModel

Properties

Name Type Description Notes
quote_guid String The associated quote’s identifier.
transfer_type String The type of transfer.
external_bank_account_guid String 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. [optional]
fiat_account_guid String 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. [optional]
send_as_deposit_bank_account_guid String 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. [optional]
payment_rail String The desired payment rail to initiate the transfer for. Optional when transfer_type is funding. [optional]
beneficiary_memo String The memo to send to the counterparty. Optional when transfer_type is funding. [optional]
source_participants Array<PostTransferParticipantBankModel> 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. [optional]
destination_participants Array<PostTransferParticipantBankModel> 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. [optional]
bank_fiat_account_guid String 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. [optional]
customer_fiat_account_guid String 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. [optional]
source_account_guid String The source account’s identifier. Required when transfer_type is book or transfer_type is inter_account. [optional]
destination_account_guid String The destination account’s identifier. Required when transfer_type is book or transfer_type is inter_account. [optional]
external_wallet_guid String The customer’s external wallet’s identifier. Optional when transfer_type is crypto. [optional]
customer_guid String The customer’s identifier. Required when transfer_type is lightning. [optional]
network_fee_account_guid String 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. [optional]
expected_behaviours Array<String> 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. [optional]
labels Array<String> The labels associated with the transfer. [optional]

Example

require 'cybrid_api_bank_ruby'

instance = CybridApiBank::PostTransferBankModel.new(
  quote_guid: null,
  transfer_type: null,
  external_bank_account_guid: null,
  fiat_account_guid: null,
  send_as_deposit_bank_account_guid: null,
  payment_rail: null,
  beneficiary_memo: null,
  source_participants: null,
  destination_participants: null,
  bank_fiat_account_guid: null,
  customer_fiat_account_guid: null,
  source_account_guid: null,
  destination_account_guid: null,
  external_wallet_guid: null,
  customer_guid: null,
  network_fee_account_guid: null,
  expected_behaviours: null,
  labels: null
)