v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
ACH

Fetch an ACH

get/ach/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Response

The ach

account_idstring

ID of the Account originating the transfer. Filterable.

addendastring[]

Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code CCD and WEB

amountstring

Amount of money to transfer, with two decimal precision

bank_idstring

ID of the bank with which the object is associated

bankdataobject

Optional arbitrary data that can be attached for the bank's use

batch_keystring

Batch configuration to use for payment

counterparty_idstring

ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.

descriptionstring

Optional description (maximum of 10 characters)

directionstring

Direction of funds flow. One of credit (send money to your counterparty) or debit (receive money from your counterparty). Filterable.

effective_datestring

The official effective date of the transaction, according to the ACH network. Filterable.

errorstring

If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, "R01" would indicate insufficient funds

idstring

Unique identifier for object

noc_change_codestring

If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, "C02" would indicate incorrect routing number

noc_corrected_datastring

If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number

org_idstring

ID of your organization. Filterable.

originator_namestring

Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks

scheduled_settlementstring

A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)

sec_codestring

One of ccd, ppd, tel, web, cie, arc, or boc. Specifies the transfer type, according to the ACH network

servicestring

Either standard or sameday. Specifies same-day or standard processing. Filterable.

statusstring

Current status of the ACH transfer. Read-only. Possible values: pending, processing, sent, returned, canceled, error. Filterable.

trace_numberstring

15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.

trace_suffixinteger
userdataobject

Arbitrary data the user can attach to the object