Send an ACH

Send an ACH

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Send ACH request

Send an ACH

amount · integer · required

Amount to transfer in ISO 4217 minor currency units

Required range: 1 <= x <= 9999999999

Example:

607

currency · string · required

ISO 4217 alphabetic currency code of the transfer amount

Example:

"USD"

customer_id · string<uuid> · required

The customer's unique identifier

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

dc_sign · enum<string> · required

The type of transaction (debit or credit). A debit is a transfer in and a credit is a transfer out of the originating account

Available options:

credit,

debit

Example:

"debit"

originating_account_id · string<uuid> · required

The unique identifier for an originating account

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

receiving_account_id · string<uuid> · required

The unique identifier for an receiving account

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

company_entry_description · string | null

Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose.

Maximum length: 10

Example:

"PAYROLL"

company_name · string

Overrides the 'Company Name' field in ACH batch header, which otherwise defaults to the configured partner name. The provided name will be prepended with the Bank's configured prefix and a *. It will then be truncated to 16 characters.

Maximum length: 16

Example:

"Asdf Finance"

effective_date · string<date> | null

Effective date transaction proccesses (is_same_day needs to be false or not present at all)

Example:

"2022-03-18"

external_data · object | null

Additional transfer metadata structured as key-value pairs

final_customer_id · string<uuid> | null

ID of the international customer that receives the final remittance transfer (required for OFAC enabled payments)

hold · object | null

Show child attributes

is_same_day · boolean | null

Send as same day ACH transaction (use only is_same_day without specific effective_date)

memo · string | null

Memo for the payment

reference_info · string | null

Will be sent to the ACH network and maps to Addenda record 05 - the recipient bank will receive this info

Example:

"Tempore atque et cum."

risk · object | null

Show child attributes

sec_code · enum<string> · default: WEB

Standard Entry Class Code:

• WEB: Internet initiated / Mobile Entry (default if empty)
• CCD: Corporate Credit or Debit
• PPD: Pre-arranged Payment or Deposit (only deposits currently supported)

Available options:

CCD,

PPD,

WEB

Response

201

application/json

Sent ACH response

Represents a sent ACH transaction.

account_no · string · required

Receiving account number

Example:

"122455799"

amount · integer · required

Transaction amount in cents

Example:

1560

bank_id · integer · required

Example:

1

effective_date · string<date> · required

Effective date of the transaction

Example:

"2022-03-25"

external_id · string<uuid> · required

Transaction ID in the ledger

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

id · string<uuid> · required

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

is_same_day · boolean · required

Was initiated as same-day ACH transaction

memo · string · required

partner_id · integer · required

Example:

2

source_account_no · string · required

Originating account number

Example:

"123638791329"

status · enum<string> · required

Available options:

CANCELED,

COMPLETE,

DECLINED,

INIT,

PENDING

trace_no · string · required

Trace number of the transaction

Example:

"123456780000069"

account_id · string<uuid>

Receiving account uuid. This links to the external account resource (represented by 'receiving_account_id' in the request to send outgoing ACH).

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

account_name · string

Receiving account name

Example:

"Bruce Wayne"

company_entry_description · string

Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose.

Example:

"PAYROLL"

company_name · string

Company Name field in ACH batch header.

Example:

"Asdf Finance"

hold · object

Show child attributes

incoming_ach_id · string<uuid>

ID of the linked incoming ACH entry. This is filled only for outgoing ACH entries that are returns and links to the originally received incoming entry.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

reference_info · string

Transaction reference info

return_data · object

Filled if the entry is a return.

Show child attributes

source_account_id · string<uuid>

Originating account uuid. This links to the customer account on Synctera platform (represented by 'originating_account_id' in the request to send outgoing ACH).

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

source_account_name · string

Originating account name

Example:

"Thomas Anderson"