A transfer is the action of moving funds. Funds may be transferred between two Helix accounts, or one Helix account and an external account. Funds may not be transferred between two external accounts.

📘

One transfer typically creates exactly one transaction. However, if a fee (such as a RegD fee) or some other kind of surcharge applies, more than one transaction may be created.


transfer Object

Property

Data Type (length)

Description

amount

decimal

The amount of funds to transfer

customerId

integer

Customer who owns the fromId and toId bank accounts

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.

nachaDescription

deprecated

Use description instead.

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.

toId

integer

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