Transfers

Create Transfer

Create a transfer to move funds between virtual accounts, or to/from a virtual account to an Outside Instrument.

post/connected-deposits/{version}/transfers/create

Request

Path parameters

versionstring required

Headers

IdempotencyKeystring uuid required

Request body

client_reference_idstring required

API Partner can send the transfer's unique id on their system and it can be used to fetch transfer details later

channel_type'NotSet' | 'ACH' | 'SameDayACH' | 'RTP' | 'Wire' | 'ManualWire' | 'CrossBorder'
transfer_type'UNKNOWN' | 'CARDTOCARD' | 'PARTNERTOCARD' | 'CARDTOPARTNER' | 'PARTNERTOPARTNER' | 'ACCOUNTTOACCOUNT' | 'ACCOUNTTOBANK' | 'BANKTOACCOUNT' | 'CHECKLOAD' | 'CHECKUNLOAD' | 'CARDTOPARTNER_UNLOADTOZERO' | 'CCDCTOACCOUNT' | 'ACCOUNTTOCCDC' | 'ACCOUNTTOBANKREALTIME' | 'BANKTOACCOUNTREQUESTREALTIME' | 'ACCOUNTTOCHECK' | 'PARTNERTOCHECK' required
amountnumber double required

Amount to transfer.

currency'USD' | 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'FOK' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KID' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

Three letter currency code

descriptionstring nullable

API Partner can send the transfer's description for reference

quote_referencestring nullable

For cross currency transfers, quote should be created and must be passed in transfer.

destination_amountnumber double
destination_currencystring nullable
memo_codestring nullable

Client driven code used to add more details to the transfer type.

verification_codestring nullable

Verification code. This field is currently not used and cvv2 validation during the transfer is not required

reason_codestring nullable

Transfer reason code used for foreign exchange

Response

Returns the newly created transfer

txn_guidstring uuid
amountnumber double required
currencystring required
descriptionstring nullable
destination_amountnumber double
destination_currencystring nullable
entry_datestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.