amount

decimal

The amount of funds to transfer

customerId

integer

The Helix-assigned unique ID for the customer initiating the transfer.

description

string (255)

A client-specified description which will appear in the description property on the transaction object if the transfer is successful.

fromId

integer

The accountId or externalAccountId from which funds are being withdrawn.
Note: this is not accountNumber.

purposeCode

string (10)

The alphanumeric identifier describing the purpose of the transaction, is provided to the third-party fraud and risk vendor. These values are agreed upon by the bank of record and client during onboarding

tag

string (50)

A program-wide unique identifier in your system for this transfer which may be useful for search purposes. You will be able to search via this value in the Helix Admin Console. Must be unique for all transfers within your program. If transferring funds between two different customers' accounts, this is the tag that will be associated with the transaction on the sending (fromId) account.

toId

integer

The accountId or externalAccountId where funds are being sent/deposited.
Note: this is not accountNumber.

toCustomerId *

integer

The Helix-assigned unique ID for the customer who owns the account receiving funds (if different from the customer sending funds)

toCustomerTag *

string (50)

The tag property of the customer who owns the account receiving funds (if different from the customer sending funds)

toTransactionTag *

string (50)

If transferring funds between two different customers' accounts, this is the tag that will be associated with the transaction on the receiving (toId) account. This value must be unique across all transactions within your program.