Skip to main content

An ACH bank transfer.

amount
number
required

Amount to push or pull.

Required range: x > 0.01
funding_source_token
string
required

Unique identifier of the ACH funding source for the external account.

Maximum string length: 36
type
enum<string>
required

Specifies whether the ACH transfer is a push (credit) or pull (debit).

Available options:
PUSH,
PULL
batch_number
string

Field required in older versions of the API, but no longer used.

channel
enum<string>
default:API

Mechanism by which the ACH transfer was initiated.

Available options:
API,
SYSTEM,
ADMIN
created_by
string

Identifier of the user or system that created the ACH transfer.

Maximum string length: 255
created_time
string<date-time>

Date and time when the ACH transfer was created, in UTC.

currency_code
string

Valid alpha-3 ISO 4217 currency code for the push or pull.

is_early_funded
boolean

true if a provisional credit has been applied to this transfer via POST /banktransfers/ach/earlyfunds.

last_modified_time
string<date-time>

Date and time when the ACH transfer was last modified, in UTC.

memo
string

Additional text describing the ACH transfer.

return_code
string

Standardized ACH return code for a returned transaction, generally sent by the RDFI (for example R01).

return_reason
string

Human-readable description correlating to return_code, such as Insufficient funds.

standard_entry_class_code
enum<string>

Three-letter code identifying the type of entry. * WEB — An internet-initiated entry * PPD — Prearranged Payment and Deposit * CCD — Cash Concentration and Disbursement

Available options:
WEB,
PPD,
CCD
statement_descriptor
string

Description of the transaction, as it appears on the receiver's bank statement.

Maximum string length: 10
status
enum<string>

Current state of the ACH transfer.

Available options:
INITIATED,
PENDING,
PROCESSING,
SUBMITTED,
RETURNED,
COMPLETED,
ERROR,
CANCELLED,
REVERSAL_PEND,
REVERSAL_COMP,
REVERSAL_DECL
token
string

Unique identifier of the ACH transfer.

Maximum string length: 36
transfer_speed
enum<string>
default:STANDARD

Specifies how quickly the ACH transfer was initiated.

Available options:
STANDARD,
SAME_DAY
transitions
object[]

Array of ACH transfer transition objects recording the transfer's status history.