Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationAppend a Batch record to the specified File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Append Batch to File
- -ACHFilesApi
-Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Build File
- -ACHFilesApi
-Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Validate File
- -ACHFilesApi
-Create a new File object from either the plaintext or JSON representation.
-File ID
-Content of the ACH file (in json or raw text)
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
-Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
-Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
-Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
-Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
-Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
-Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Create File
- -ACHFilesApi
-Permanently deletes a File and associated Batches. It cannot be undone.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Delete File
- -ACHFilesApi
-Delete a Batch from a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Delete Batch
- -ACHFilesApi
-Consolidate Batches and Entries into the minimum number of Batches needed.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Flatten Batches
- -ACHFilesApi
-Get a specific Batch on a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get Batch
- -ACHFilesApi
-Get the Batches on a File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get Batches
- -ACHFilesApi
-Get the details of an existing File using the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Retrieve File
- -ACHFilesApi
-Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get File Contents
- -ACHFilesApi
-List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-List Files
- -ACHFilesApi
-Split one File into two. One with only debits and one with only credits.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Segment File
- -ACHFilesApi
-Split one FileID into two. One with only debits and one with only credits.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: anyOptional configuration for segmenting files
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Segment FileID
- -ACHFilesApi
-Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfig<any>Override http request option.
-Validate File (Custom)
- -ACHFilesApi
-Generated using TypeDoc
ACHFilesApi - object-oriented interface
+ACHFilesApi
+Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationAppend a Batch record to the specified File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Append Batch to File
+ACHFilesApi
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Build File
+ACHFilesApi
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Validate File
+ACHFilesApi
+Create a new File object from either the plaintext or JSON representation.
+File ID
+Content of the ACH file (in json or raw text)
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
+Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
+Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
+Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
+Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
+Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
+Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
+Optional
options: AxiosRequestConfigOverride http request option.
+Create File
+ACHFilesApi
+Permanently deletes a File and associated Batches. It cannot be undone.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Delete File
+ACHFilesApi
+Delete a Batch from a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Delete Batch
+ACHFilesApi
+Consolidate Batches and Entries into the minimum number of Batches needed.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Flatten Batches
+ACHFilesApi
+Get a specific Batch on a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get Batch
+ACHFilesApi
+Get the Batches on a File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get Batches
+ACHFilesApi
+Get the details of an existing File using the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Retrieve File
+ACHFilesApi
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get File Contents
+ACHFilesApi
+List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+List Files
+ACHFilesApi
+Split one File into two. One with only debits and one with only credits.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
+Optional
options: AxiosRequestConfigOverride http request option.
+Segment File
+ACHFilesApi
+Split one FileID into two. One with only debits and one with only credits.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: anyOptional configuration for segmenting files
+Optional
options: AxiosRequestConfigOverride http request option.
+Segment FileID
+ACHFilesApi
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfigOverride http request option.
+Validate File (Custom)
+ACHFilesApi
+Generated using TypeDoc
Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationGenerated using TypeDoc
BaseAPI
+Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationGenerated using TypeDoc
Optional
msg: stringOptional
stackGenerated using TypeDoc
RequiredError
+Optional
msg: stringOptional
stackGenerated using TypeDoc
Optional
accessparameter for oauth2 security
-Optional
name: stringOptional
scopes: string[]Optional
name: stringOptional
scopes: string[]security name
- -oauth2 scope
- +Optional
accessparameter for oauth2 security
+Optional
name: stringOptional
scopes: string[]Optional
name: stringOptional
scopes: string[]security name
+oauth2 scope
Configuration
-Optional
apiparameter for apiKey security
-security name
- +Optional
apiparameter for apiKey security
+security name
Configuration
-Optional
basebase options for axios calls
-Configuration
-Optional
baseoverride base path
-Configuration
-Optional
formThe FormData constructor that will be used to create multipart form data +
Optional
basebase options for axios calls
+Configuration
+Optional
baseoverride base path
+Configuration
+Optional
formThe FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.
-Optional
passwordparameter for basic security
-Configuration
-Optional
usernameparameter for basic security
-Configuration
-Optional
passwordparameter for basic security
+Configuration
+Optional
usernameparameter for basic security
+Configuration
+Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
-MIME (Multipurpose Internet Mail Extensions)
-True if the given MIME is JSON, false otherwise.
- -Generated using TypeDoc
MIME (Multipurpose Internet Mail Extensions)
+True if the given MIME is JSON, false otherwise.
+Generated using TypeDoc
ACHFilesApi - axios parameter creator
-Optional
configuration: ConfigurationAppend a Batch record to the specified File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Append Batch to File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Build File
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Validate File
- -Create a new File object from either the plaintext or JSON representation.
-File ID
-Content of the ACH file (in json or raw text)
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
-Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
-Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
-Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
-Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
-Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
-Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Create File
- -Permanently deletes a File and associated Batches. It cannot be undone.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Delete File
- -Delete a Batch from a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Delete Batch
- -Consolidate Batches and Entries into the minimum number of Batches needed.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Flatten Batches
- -Get a specific Batch on a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Get Batch
- -Get the Batches on a File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Get Batches
- -Get the details of an existing File using the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Retrieve File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Get File Contents
- -List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-List Files
- -Check if the ACH service is running.
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Ping ACH service
- -Split one File into two. One with only debits and one with only credits.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Segment File
- -Split one FileID into two. One with only debits and one with only credits.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: anyOptional configuration for segmenting files
-Optional
options: AxiosRequestConfig<any> = {}Override http request option.
-Segment FileID
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfig<any> = {}Override http request option.
-Validate File (Custom)
- -Generated using TypeDoc
ACHFilesApi - axios parameter creator
+Optional
configuration: ConfigurationAppend a Batch record to the specified File.
+Append Batch to File
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
+Build File
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+Validate File
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Create a new File object from either the plaintext or JSON representation.
+Create File
+File ID
+Content of the ACH file (in json or raw text)
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
+Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
+Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
+Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
+Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
+Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
+Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Permanently deletes a File and associated Batches. It cannot be undone.
+Delete File
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Delete a Batch from a File.
+Delete Batch
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Consolidate Batches and Entries into the minimum number of Batches needed.
+Flatten Batches
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Get a specific Batch on a File.
+Get Batch
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Get the Batches on a File.
+Get Batches
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Get the details of an existing File using the unique File identifier that was returned upon creation.
+Retrieve File
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
+Get File Contents
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
+List Files
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Check if the ACH service is running.
+Ping ACH service
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Split one File into two. One with only debits and one with only credits.
+Segment File
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Split one FileID into two. One with only debits and one with only credits.
+Segment FileID
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: anyOptional configuration for segmenting files
+Optional
options: AxiosRequestConfig = {}Override http request option.
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+Validate File (Custom)
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfig = {}Override http request option.
+Generated using TypeDoc
ACHFilesApi - factory interface
-Optional
configuration: ConfigurationOptional
basePath: stringOptional
axios: AxiosInstanceAppend a Batch record to the specified File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Append Batch to File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Build File
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Validate File
- -Create a new File object from either the plaintext or JSON representation.
-File ID
-Content of the ACH file (in json or raw text)
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
-Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
-Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
-Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
-Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
-Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
-Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
-Optional
options: anyOverride http request option.
-Create File
- -Permanently deletes a File and associated Batches. It cannot be undone.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Delete File
- -Delete a Batch from a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Delete Batch
- -Consolidate Batches and Entries into the minimum number of Batches needed.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Flatten Batches
- -Get a specific Batch on a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Get Batch
- -Get the Batches on a File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Get Batches
- -Get the details of an existing File using the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Retrieve File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-Get File Contents
- -List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: anyOverride http request option.
-List Files
- -Split one File into two. One with only debits and one with only credits.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
-Optional
options: anyOverride http request option.
-Segment File
- -Split one FileID into two. One with only debits and one with only credits.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: anyOptional configuration for segmenting files
-Optional
options: anyOverride http request option.
-Segment FileID
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
validateOpts: ValidateOptsOptional
options: anyOverride http request option.
-Validate File (Custom)
- -Generated using TypeDoc
ACHFilesApi - factory interface
+Optional
configuration: ConfigurationOptional
basePath: stringOptional
axios: AxiosInstanceAppend a Batch record to the specified File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Append Batch to File
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Build File
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Validate File
+Create a new File object from either the plaintext or JSON representation.
+File ID
+Content of the ACH file (in json or raw text)
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
+Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
+Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
+Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
+Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
+Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
+Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
+Optional
options: anyOverride http request option.
+Create File
+Permanently deletes a File and associated Batches. It cannot be undone.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Delete File
+Delete a Batch from a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Delete Batch
+Consolidate Batches and Entries into the minimum number of Batches needed.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Flatten Batches
+Get a specific Batch on a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Get Batch
+Get the Batches on a File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Get Batches
+Get the details of an existing File using the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Retrieve File
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+Get File Contents
+List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: anyOverride http request option.
+List Files
+Split one File into two. One with only debits and one with only credits.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
+Optional
options: anyOverride http request option.
+Segment File
+Split one FileID into two. One with only debits and one with only credits.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: anyOptional configuration for segmenting files
+Optional
options: anyOverride http request option.
+Segment FileID
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
validateOpts: ValidateOptsOptional
options: anyOverride http request option.
+Validate File (Custom)
+Generated using TypeDoc
ACHFilesApi - functional programming interface
-Optional
configuration: ConfigurationAppend a Batch record to the specified File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Append Batch to File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Build File
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Validate File
- -Create a new File object from either the plaintext or JSON representation.
-File ID
-Content of the ACH file (in json or raw text)
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
-Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
-Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
-Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
-Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
-Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
-Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
-Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
-Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
-Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
-Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Create File
- -Permanently deletes a File and associated Batches. It cannot be undone.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Delete File
- -Delete a Batch from a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Delete Batch
- -Consolidate Batches and Entries into the minimum number of Batches needed.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Flatten Batches
- -Get a specific Batch on a File.
-File ID
-Batch ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get Batch
- -Get the Batches on a File.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get Batches
- -Get the details of an existing File using the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Retrieve File
- -Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Get File Contents
- -List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
options: AxiosRequestConfig<any>Override http request option.
-List Files
- -Check if the ACH service is running.
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Ping ACH service
- -Split one File into two. One with only debits and one with only credits.
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Segment File
- -Split one FileID into two. One with only debits and one with only credits.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
body: anyOptional configuration for segmenting files
-Optional
options: AxiosRequestConfig<any>Override http request option.
-Segment FileID
- -Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
-File ID
-Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
-Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfig<any>Override http request option.
-Validate File (Custom)
- -Generated using TypeDoc
ACHFilesApi - functional programming interface
+Optional
configuration: ConfigurationAppend a Batch record to the specified File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Append Batch to File
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Build File
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Validate File
+Create a new File object from either the plaintext or JSON representation.
+File ID
+Content of the ACH file (in json or raw text)
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
skipAll: booleanOptional parameter to disable all validation checks for a File
+Optional
requireABAOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassOrigin: booleanOptional parameter to configure ImmediateOrigin validation
+Optional
bypassDestination: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customTraceNumbers: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowZeroBatches: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileHeader: booleanOptional parameter to configure ImmediateDestination validation
+Optional
allowMissingFileControl: booleanOptional parameter to configure ImmediateDestination validation
+Optional
bypassCompanyIdentificationMatch: booleanOptional parameter to configure ImmediateDestination validation
+Optional
customReturnCodes: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unequalServiceClassCode: booleanOptional parameter to configure ImmediateDestination validation
+Optional
unorderedBatchNumbers: booleanAllow a file to be read with unordered batch numbers.
+Optional
allowInvalidCheckDigit: booleanAllow the CheckDigit field in EntryDetail to differ from the expected calculation
+Optional
unequalAddendaCounts: booleanOptional parameter to configure UnequalAddendaCounts validation
+Optional
preserveSpaces: booleanOptional parameter to save all padding spaces
+Optional
allowInvalidAmounts: booleanOptional parameter to save all padding spaces
+Optional
options: AxiosRequestConfigOverride http request option.
+Create File
+Permanently deletes a File and associated Batches. It cannot be undone.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Delete File
+Delete a Batch from a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Delete Batch
+Consolidate Batches and Entries into the minimum number of Batches needed.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Flatten Batches
+Get a specific Batch on a File.
+File ID
+Batch ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get Batch
+Get the Batches on a File.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get Batches
+Get the details of an existing File using the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Retrieve File
+Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+Get File Contents
+List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
options: AxiosRequestConfigOverride http request option.
+List Files
+Split one File into two. One with only debits and one with only credits.
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: stringACH file (in Nacha or JSON formatting) along with optional segment configuration
+Optional
options: AxiosRequestConfigOverride http request option.
+Segment File
+Split one FileID into two. One with only debits and one with only credits.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
body: anyOptional configuration for segmenting files
+Optional
options: AxiosRequestConfigOverride http request option.
+Segment FileID
+Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
+File ID
+Optional
xRequestID: stringOptional Request ID allows application developer to trace requests through the system's logs
+Optional
validateOpts: ValidateOptsOptional
options: AxiosRequestConfigOverride http request option.
+Validate File (Custom)
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Optional
configuration: ConfigurationGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated Typescript SDK for the moov-io/ach service.
+Generated Typescript SDK for the moov-io/ach service.
Install in your Node.js or Typescript project using npm:
npm install ach-node-sdk
@@ -38,45 +24,4 @@ Run the following for generating the documentation.
make docs
-Generated using TypeDoc
Generated using TypeDoc
ADVBatchControl
-The routing number is used to identify the DFI originating entries within a given branch.
-ADVBatchControl
-Alphanumeric code used to identify an ACH Operator
-ADVBatchControl
-BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
-ADVBatchControl
-EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
-ADVBatchControl
-Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
-ADVBatchControl
-Optional
idBatch ID
-ADVBatchControl
-Same as ServiceClassCode in BatchHeader record
-ADVBatchControl
-Contains accumulated Entry credit totals within the batch.
-ADVBatchControl
-Contains accumulated Entry debit totals within the batch.
-ADVBatchControl
-Generated using TypeDoc
ADVBatchControl
+The routing number is used to identify the DFI originating entries within a given branch.
+ADVBatchControl
+Alphanumeric code used to identify an ACH Operator
+ADVBatchControl
+BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
+ADVBatchControl
+EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
+ADVBatchControl
+Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
+ADVBatchControl
+Optional
idBatch ID
+ADVBatchControl
+Same as ServiceClassCode in BatchHeader record
+ADVBatchControl
+Contains accumulated Entry credit totals within the batch.
+ADVBatchControl
+Contains accumulated Entry debit totals within the batch.
+ADVBatchControl
+Generated using TypeDoc
ADVEntryDetail
-The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
-ADVEntryDetail
-RDFI's routing number without the last digit.
-ADVEntryDetail
-Optional
achInformation related to the ACH opreator
-ADVEntryDetail
-Routing number for ACH Operator
-ADVEntryDetail
-Optional
addenda99Addenda99 record for the ADV Entry Detail
-ADVEntryDetail
-Optional
addendaAddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
-ADVEntryDetail
-Suggested routing number to use
-ADVEntryDetail
-Number of cents you are debiting/crediting this account
-ADVEntryDetail
-Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
-ADVEntryDetail
-Last digit in RDFI routing number.
-ADVEntryDetail
-Optional
discretionaryDiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.
-ADVEntryDetail
-Optional
fileUnique identifier for the File
-ADVEntryDetail
-Optional
idEntry Detail ID
-ADVEntryDetail
-The name of the receiver, usually the name on the bank account
-ADVEntryDetail
-Optional
julianJulian Day of the year
-ADVEntryDetail
-SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
-ADVEntryDetail
-TransactionCode representing Accounting Entries: 81 - Credit for ACH debits originated | 82 - Debit for ACH credits originated | 83 - Credit for ACH credits received | 84 - Debit for ACH debits received | 85 - Credit for ACH credits in rejected batches | 86 - Debit for ACH debits in rejected batches | 87 - Summary credit for respondent ACH activity | 88 - Summary debit for respondent ACH activity
-ADVEntryDetail
-Generated using TypeDoc
ADVEntryDetail
+The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
+ADVEntryDetail
+RDFI's routing number without the last digit.
+ADVEntryDetail
+Optional
achInformation related to the ACH opreator
+ADVEntryDetail
+Routing number for ACH Operator
+ADVEntryDetail
+Optional
addenda99Addenda99 record for the ADV Entry Detail
+ADVEntryDetail
+Optional
addendaAddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
+ADVEntryDetail
+Suggested routing number to use
+ADVEntryDetail
+Number of cents you are debiting/crediting this account
+ADVEntryDetail
+Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
+ADVEntryDetail
+Last digit in RDFI routing number.
+ADVEntryDetail
+Optional
discretionaryDiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.
+ADVEntryDetail
+Optional
fileUnique identifier for the File
+ADVEntryDetail
+Optional
idEntry Detail ID
+ADVEntryDetail
+The name of the receiver, usually the name on the bank account
+ADVEntryDetail
+Optional
julianJulian Day of the year
+ADVEntryDetail
+SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
+ADVEntryDetail
+TransactionCode representing Accounting Entries: 81 - Credit for ACH debits originated | 82 - Debit for ACH credits originated | 83 - Credit for ACH credits received | 84 - Debit for ACH debits received | 85 - Credit for ACH credits in rejected batches | 86 - Debit for ACH debits in rejected batches | 87 - Summary credit for respondent ACH activity | 88 - Summary debit for respondent ACH activity
+ADVEntryDetail
+Generated using TypeDoc
ADVFileControl
-Count of Batches in the File
-ADVFileControl
-Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)
-ADVFileControl
-Total detail and addenda records in the file
-ADVFileControl
-Calculated in the same manner as the batch total but includes total from entire file
-ADVFileControl
-Optional
idADV File Control Record
-ADVFileControl
-Accumulated Batch credit totals within the file.
-ADVFileControl
-Accumulated Batch debit totals within the file.
-ADVFileControl
-Generated using TypeDoc
ADVFileControl
+Count of Batches in the File
+ADVFileControl
+Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)
+ADVFileControl
+Total detail and addenda records in the file
+ADVFileControl
+Calculated in the same manner as the batch total but includes total from entire file
+ADVFileControl
+Optional
idADV File Control Record
+ADVFileControl
+Accumulated Batch credit totals within the file.
+ADVFileControl
+Accumulated Batch debit totals within the file.
+ADVFileControl
+Generated using TypeDoc
Addenda02
-Optional
authorizationIndicates the code that a card authorization center has furnished to the merchant.
-Addenda02
-Optional
idClient-defined string used as a reference to this record.
-Addenda02
-Optional
referenceReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
-Addenda02
-Optional
referenceReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
-Addenda02
-Identifies the city in which the electronic terminal is located.
-Addenda02
-TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated.
-Addenda02
-Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E.
-Addenda02
-Identifies the state in which the electronic terminal is located.
-Addenda02
-Optional
traceEntry Detail Trace Number
-Addenda02
-Timestamp identifies the date on which the transaction occurred. (Format MMDD - M=Month, D=Day)
-Addenda02
-TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence.
-Addenda02
-02 - NACHA regulations
-Addenda02
-Generated using TypeDoc
Addenda02
+Optional
authorizationIndicates the code that a card authorization center has furnished to the merchant.
+Addenda02
+Optional
idClient-defined string used as a reference to this record.
+Addenda02
+Optional
referenceReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
+Addenda02
+Optional
referenceReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.
+Addenda02
+Identifies the city in which the electronic terminal is located.
+Addenda02
+TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated.
+Addenda02
+Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E.
+Addenda02
+Identifies the state in which the electronic terminal is located.
+Addenda02
+Optional
traceEntry Detail Trace Number
+Addenda02
+Timestamp identifies the date on which the transaction occurred. (Format MMDD - M=Month, D=Day)
+Addenda02
+TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence.
+Addenda02
+02 - NACHA regulations
+Addenda02
+Generated using TypeDoc
Addenda05
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda05
-Optional
idClient-defined string used as a reference to this record.
-Addenda05
-Text for describing the related payment
-Addenda05
-SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
-Addenda05
-05 - NACHA regulations
-Addenda05
-Generated using TypeDoc
Addenda05
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda05
+Optional
idClient-defined string used as a reference to this record.
+Addenda05
+Text for describing the related payment
+Addenda05
+SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.
+Addenda05
+05 - NACHA regulations
+Addenda05
+Generated using TypeDoc
Addenda10
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda10
-For inbound IAT payments this field should contain the USD amount or may be blank.
-Addenda10
-Optional
foreignTrace number
-Addenda10
-Optional
idClient-defined string used as a reference to this record.
-Addenda10
-Receiving Company Name/Individual Name
-Addenda10
-Optional
transactionDescribes the type of payment: 'ANN' = Annuity | 'BUS' = Business/Commercial | 'DEP' = Deposit | 'LOA' = Loan | 'MIS' = Miscellaneous | 'MOR' = Mortgage | 'PEN' = Pension | 'RLS' = Rent/Lease | 'REM' = Remittance2 | 'SAL' = Salary/Payroll | 'TAX' = Tax | 'TEL' = Telephone-Initiated Transaction | 'WEB' = Internet-Initiated Transaction | 'ARC' = Accounts Receivable Entry | 'BOC' = Back Office Conversion Entry | 'POP' = Point of Purchase Entry | 'RCK' = Re-presented Check Entry
-Addenda10
-10 - NACHA regulations
-Addenda10
-Generated using TypeDoc
Addenda10
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda10
+For inbound IAT payments this field should contain the USD amount or may be blank.
+Addenda10
+Optional
foreignTrace number
+Addenda10
+Optional
idClient-defined string used as a reference to this record.
+Addenda10
+Receiving Company Name/Individual Name
+Addenda10
+Optional
transactionDescribes the type of payment: 'ANN' = Annuity | 'BUS' = Business/Commercial | 'DEP' = Deposit | 'LOA' = Loan | 'MIS' = Miscellaneous | 'MOR' = Mortgage | 'PEN' = Pension | 'RLS' = Rent/Lease | 'REM' = Remittance2 | 'SAL' = Salary/Payroll | 'TAX' = Tax | 'TEL' = Telephone-Initiated Transaction | 'WEB' = Internet-Initiated Transaction | 'ARC' = Accounts Receivable Entry | 'BOC' = Back Office Conversion Entry | 'POP' = Point of Purchase Entry | 'RCK' = Re-presented Check Entry
+Addenda10
+10 - NACHA regulations
+Addenda10
+Generated using TypeDoc
Addenda11
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda11
-Optional
idClient-defined string used as a reference to this record.
-Addenda11
-Originator's name (your company name / name)
-Addenda11
-Originator's street address
-Addenda11
-11 - NACHA regulations
-Addenda11
-Generated using TypeDoc
Addenda11
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda11
+Optional
idClient-defined string used as a reference to this record.
+Addenda11
+Originator's name (your company name / name)
+Addenda11
+Originator's street address
+Addenda11
+11 - NACHA regulations
+Addenda11
+Generated using TypeDoc
Addenda12
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda12
-Optional
idClient-defined string used as a reference to this record.
-Addenda12
-Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).
-Addenda12
-Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).
-Addenda12
-12 - NACHA regulations
-Addenda12
-Generated using TypeDoc
Addenda12
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda12
+Optional
idClient-defined string used as a reference to this record.
+Addenda12
+Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).
+Addenda12
+Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).
+Addenda12
+12 - NACHA regulations
+Addenda12
+Generated using TypeDoc
Addenda13
-Originating DFI Branch Country Code: USb = United States //("b" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org.
-Addenda13
-Originating DFI Identification Number Qualifier. For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code
-Addenda13
-Optional
ODFIIdentificationOriginating DFI Identification. This field contains the routing number that identifies the U.S. ODFI initiating the entry. For Inbound IATs: This field contains the bank ID number of the Foreign Bank providing funding for the payment transaction.
-Addenda13
-Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction
-Addenda13
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda13
-Optional
idClient-defined string used as a reference to this record.
-Addenda13
-13 - NACHA regulations
-Addenda13
-Generated using TypeDoc
Addenda13
+Originating DFI Branch Country Code: USb = United States //("b" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org.
+Addenda13
+Originating DFI Identification Number Qualifier. For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code
+Addenda13
+Optional
ODFIIdentificationOriginating DFI Identification. This field contains the routing number that identifies the U.S. ODFI initiating the entry. For Inbound IATs: This field contains the bank ID number of the Foreign Bank providing funding for the payment transaction.
+Addenda13
+Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction
+Addenda13
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda13
+Optional
idClient-defined string used as a reference to this record.
+Addenda13
+13 - NACHA regulations
+Addenda13
+Generated using TypeDoc
Addenda14
-Receiving DFI Branch Country Code USb" = United States ("b" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org
-Addenda14
-Receiving DFI Identification Number Qualifier. The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code
-Addenda14
-This field contains the bank identification number of the DFI at which the Receiver maintains his account.
-Addenda14
-Name of the Receiver bank
-Addenda14
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda14
-Optional
idClient-defined string used as a reference to this record.
-Addenda14
-14 - NACHA regulations
-Addenda14
-Generated using TypeDoc
Addenda14
+Receiving DFI Branch Country Code USb" = United States ("b" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org
+Addenda14
+Receiving DFI Identification Number Qualifier. The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code
+Addenda14
+This field contains the bank identification number of the DFI at which the Receiver maintains his account.
+Addenda14
+Name of the Receiver bank
+Addenda14
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda14
+Optional
idClient-defined string used as a reference to this record.
+Addenda14
+14 - NACHA regulations
+Addenda14
+Generated using TypeDoc
Addenda15
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda15
-Optional
idClient-defined string used as a reference to this record.
-Addenda15
-Optional
receiverIDNumberReceiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver's statement.
-Addenda15
-Receiver's physical address
-Addenda15
-15 - NACHA regulations
-Addenda15
-Generated using TypeDoc
Addenda15
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda15
+Optional
idClient-defined string used as a reference to this record.
+Addenda15
+Optional
receiverIDNumberReceiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver's statement.
+Addenda15
+Receiver's physical address
+Addenda15
+15 - NACHA regulations
+Addenda15
+Generated using TypeDoc
Addenda16
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda16
-Optional
idClient-defined string used as a reference to this record.
-Addenda16
-Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).
-Addenda16
-Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).
-Addenda16
-16 - NACHA regulations
-Addenda16
-Generated using TypeDoc
Addenda16
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda16
+Optional
idClient-defined string used as a reference to this record.
+Addenda16
+Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).
+Addenda16
+Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).
+Addenda16
+16 - NACHA regulations
+Addenda16
+Generated using TypeDoc
Addenda17
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda17
-Optional
idClient-defined string used as a reference to this record.
-Addenda17
-Additional information related to the payment
-Addenda17
-SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
-Addenda17
-17 - NACHA regulations
-Addenda17
-Generated using TypeDoc
Addenda17
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda17
+Optional
idClient-defined string used as a reference to this record.
+Addenda17
+Additional information related to the payment
+Addenda17
+SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
+Addenda17
+17 - NACHA regulations
+Addenda17
+Generated using TypeDoc
Addenda18
-EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
-Addenda18
-Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org
-Addenda18
-Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank
-Addenda18
-Optional
foreignForeign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are: "01" = National Clearing System | "02" = BIC Code | "03" = IBAN Code
-Addenda18
-Name of the Foreign Correspondent Bank
-Addenda18
-Optional
idClient-defined string used as a reference to this record.
-Addenda18
-SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
-Addenda18
-18 - NACHA regulations
-Addenda18
-Generated using TypeDoc
Addenda18
+EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.
+Addenda18
+Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org
+Addenda18
+Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank
+Addenda18
+Optional
foreignForeign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are: "01" = National Clearing System | "02" = BIC Code | "03" = IBAN Code
+Addenda18
+Name of the Foreign Correspondent Bank
+Addenda18
+Optional
idClient-defined string used as a reference to this record.
+Addenda18
+SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.
+Addenda18
+18 - NACHA regulations
+Addenda18
+Generated using TypeDoc
Addenda98
-ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
-Addenda98
-Correct field value of what changeCode references
-Addenda98
-Optional
idClient-defined string used as a reference to this record.
-Addenda98
-The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
-Addenda98
-OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
-Addenda98
-Optional
traceEntry Detail Trace Number
-Addenda98
-98 - NACHA regulations
-Addenda98
-Generated using TypeDoc
Addenda98
+ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
+Addenda98
+Correct field value of what changeCode references
+Addenda98
+Optional
idClient-defined string used as a reference to this record.
+Addenda98
+The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
+Addenda98
+OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
+Addenda98
+Optional
traceEntry Detail Trace Number
+Addenda98
+98 - NACHA regulations
+Addenda98
+Generated using TypeDoc
Addenda98Refused
-ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
-Addenda98Refused
-Correct field value of what changeCode references
-Addenda98Refused
-Optional
idClient-defined string used as a reference to this record.
-Addenda98Refused
-The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
-Addenda98Refused
-OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
-Addenda98Refused
-The code specifying why the Notification of Change is being refused.
-Addenda98Refused
-Entry Detail Trace Number
-Addenda98Refused
-The last seven digits of the TraceNumber in the original Notification of Change.
-Addenda98Refused
-98 - NACHA regulations
-Addenda98Refused
-Generated using TypeDoc
Addenda98Refused
+ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.
+Addenda98Refused
+Correct field value of what changeCode references
+Addenda98Refused
+Optional
idClient-defined string used as a reference to this record.
+Addenda98Refused
+The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
+Addenda98Refused
+OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
+Addenda98Refused
+The code specifying why the Notification of Change is being refused.
+Addenda98Refused
+Entry Detail Trace Number
+Addenda98Refused
+The last seven digits of the TraceNumber in the original Notification of Change.
+Addenda98Refused
+98 - NACHA regulations
+Addenda98Refused
+Generated using TypeDoc
Addenda99
-Optional
addendaInformation related to the return
-Addenda99
-The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). (Format YYMMDD - Y=Year, M=Month, D=Day)
-Addenda99
-Optional
idClient-defined string used as a reference to this record.
-Addenda99
-Contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
-Addenda99
-OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
-Addenda99
-Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry.
-Addenda99
-Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
-Addenda99
-99 - NACHA regulations
-Addenda99
-Generated using TypeDoc
Addenda99
+Optional
addendaInformation related to the return
+Addenda99
+The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). (Format YYMMDD - Y=Year, M=Month, D=Day)
+Addenda99
+Optional
idClient-defined string used as a reference to this record.
+Addenda99
+Contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.
+Addenda99
+OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.
+Addenda99
+Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry.
+Addenda99
+Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
+Addenda99
+99 - NACHA regulations
+Addenda99
+Generated using TypeDoc
Addenda99Contested
-return code explaining the contested dishonorment
-Addenda99Contested
-Date original entry was returned
-Addenda99Contested
-Return reason code of the Dishonored Return
-Addenda99Contested
-Settlement date of the Dishonored Return
-Addenda99Contested
-Trace number from Dishonored Return
-Addenda99Contested
-Optional
idClient-defined string used as a reference to this record.
-Addenda99Contested
-Trace Number of the original entry being returned.
-Addenda99Contested
-Identification of the Original Receiving Depository Institution (ODFI)
-Addenda99Contested
-Original date of settlement
-Addenda99Contested
-Return reason code
-Addenda99Contested
-Return settlement date
-Addenda99Contested
-Return trace number
-Addenda99Contested
-Unique Trace Number for the contested dishonored return
-Addenda99Contested
-99 - NACHA regulations
-Addenda99Contested
-Generated using TypeDoc
Addenda99Contested
+return code explaining the contested dishonorment
+Addenda99Contested
+Date original entry was returned
+Addenda99Contested
+Return reason code of the Dishonored Return
+Addenda99Contested
+Settlement date of the Dishonored Return
+Addenda99Contested
+Trace number from Dishonored Return
+Addenda99Contested
+Optional
idClient-defined string used as a reference to this record.
+Addenda99Contested
+Trace Number of the original entry being returned.
+Addenda99Contested
+Identification of the Original Receiving Depository Institution (ODFI)
+Addenda99Contested
+Original date of settlement
+Addenda99Contested
+Return reason code
+Addenda99Contested
+Return settlement date
+Addenda99Contested
+Return trace number
+Addenda99Contested
+Unique Trace Number for the contested dishonored return
+Addenda99Contested
+99 - NACHA regulations
+Addenda99Contested
+Generated using TypeDoc
Addenda99Dishonored
-Optional
addendaAdditional data
-Addenda99Dishonored
-Return reason code of the Dishonored Return
-Addenda99Dishonored
-Optional
idClient-defined string used as a reference to this record.
-Addenda99Dishonored
-Trace Number of the original entry being returned.
-Addenda99Dishonored
-Identification of the Original Receiving Depository Institution (ODFI)
-Addenda99Dishonored
-Return reason code
-Addenda99Dishonored
-Return settlement date
-Addenda99Dishonored
-Return trace number
-Addenda99Dishonored
-Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
-Addenda99Dishonored
-99 - NACHA regulations
-Addenda99Dishonored
-Generated using TypeDoc
Addenda99Dishonored
+Optional
addendaAdditional data
+Addenda99Dishonored
+Return reason code of the Dishonored Return
+Addenda99Dishonored
+Optional
idClient-defined string used as a reference to this record.
+Addenda99Dishonored
+Trace Number of the original entry being returned.
+Addenda99Dishonored
+Identification of the Original Receiving Depository Institution (ODFI)
+Addenda99Dishonored
+Return reason code
+Addenda99Dishonored
+Return settlement date
+Addenda99Dishonored
+Return trace number
+Addenda99Dishonored
+Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
+Addenda99Dishonored
+99 - NACHA regulations
+Addenda99Dishonored
+Generated using TypeDoc
Batch
-Optional
advBatch
-Optional
advBatch
-Batch
-Batch
-Batch
-Optional
offsetBatch
-Generated using TypeDoc
Batch
+Optional
advBatch
+Optional
advBatch
+Batch
+Batch
+Batch
+Optional
offsetBatch
+Generated using TypeDoc
BatchControl
-The routing number is used to identify the DFI originating entries within a given branch.
-BatchControl
-BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
-BatchControl
-Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", and User Assigned Number "9".
-BatchControl
-EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
-BatchControl
-Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
-BatchControl
-Optional
idBatch ID
-BatchControl
-Optional
messageMAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank.
-BatchControl
-Same as ServiceClassCode in BatchHeaderRecord
-BatchControl
-Contains accumulated Entry credit totals within the batch.
-BatchControl
-Contains accumulated Entry debit totals within the batch.
-BatchControl
-Generated using TypeDoc
BatchControl
+The routing number is used to identify the DFI originating entries within a given branch.
+BatchControl
+BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
+BatchControl
+Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", and User Assigned Number "9".
+BatchControl
+EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
+BatchControl
+Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
+BatchControl
+Optional
idBatch ID
+BatchControl
+Optional
messageMAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank.
+BatchControl
+Same as ServiceClassCode in BatchHeaderRecord
+BatchControl
+Contains accumulated Entry credit totals within the batch.
+BatchControl
+Contains accumulated Entry debit totals within the batch.
+BatchControl
+Generated using TypeDoc
BatchHeader
-First 8 digits of the originating DFI transit routing number
-BatchHeader
-BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
-BatchHeader
-Optional
companyThe Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format.
-BatchHeader
-Optional
companyThe 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field
-BatchHeader
-Optional
companyA description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM,", "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.
-BatchHeader
-Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", or User Assigned Number "9".
-BatchHeader
-Company originating the entries in the batch
-BatchHeader
-Optional
effectiveDate on which the entries are to settle. (Format YYMMDD - Y=Year, M=Month, D=Day)
-BatchHeader
-Optional
idA client-defined ID used as a reference to this batch
-BatchHeader
-Optional
originatorODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.
-BatchHeader
-Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'
-BatchHeader
-Optional
settlementThe date the entries actually settled (this is inserted by the ACH operator)
-BatchHeader
-Identifies the payment type (product) found within an ACH batch using a 3-character code.
-BatchHeader
-Generated using TypeDoc
BatchHeader
+First 8 digits of the originating DFI transit routing number
+BatchHeader
+BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
+BatchHeader
+Optional
companyThe Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format.
+BatchHeader
+Optional
companyThe 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field
+BatchHeader
+Optional
companyA description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM,", "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.
+BatchHeader
+Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", or User Assigned Number "9".
+BatchHeader
+Company originating the entries in the batch
+BatchHeader
+Optional
effectiveDate on which the entries are to settle. (Format YYMMDD - Y=Year, M=Month, D=Day)
+BatchHeader
+Optional
idA client-defined ID used as a reference to this batch
+BatchHeader
+Optional
originatorODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.
+BatchHeader
+Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'
+BatchHeader
+Optional
settlementThe date the entries actually settled (this is inserted by the ACH operator)
+BatchHeader
+Identifies the payment type (product) found within an ACH batch using a 3-character code.
+BatchHeader
+Generated using TypeDoc
CreateFile
-Optional
IATBatchesCreateFile
-Optional
advCreateFile
-Optional
advCreateFile
-Optional
batchesCreateFile
-Optional
fileCreateFile
-CreateFile
-Optional
idFile ID
-CreateFile
-Generated using TypeDoc
CreateFile
+Optional
IATBatchesCreateFile
+Optional
advCreateFile
+Optional
advCreateFile
+Optional
batchesCreateFile
+Optional
fileCreateFile
+CreateFile
+Optional
idFile ID
+CreateFile
+Generated using TypeDoc
CreateFileResponse
-Optional
errorAn error message describing the problem intended for humans.
-CreateFileResponse
-Optional
fileCreateFileResponse
-Optional
idFile ID
-CreateFileResponse
-Generated using TypeDoc
Generated using TypeDoc
EntryDetail
-The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
-EntryDetail
-RDFI's routing number without the last digit.
-EntryDetail
-Optional
addenda02EntryDetail
-Optional
addenda05List of Addenda05 records
-EntryDetail
-Optional
addenda98EntryDetail
-Optional
addenda98EntryDetail
-Optional
addenda99EntryDetail
-Optional
addenda99EntryDetail
-Optional
addenda99EntryDetail
-Optional
addendaAddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
-EntryDetail
-Number of cents you are debiting/crediting this account
-EntryDetail
-Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
-EntryDetail
-Last digit in RDFI routing number.
-EntryDetail
-Optional
discretionaryDiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.
-EntryDetail
-Entry Detail ID
-EntryDetail
-Optional
identificationInternal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record
-EntryDetail
-The name of the receiver, usually the name on the bank account
-EntryDetail
-Optional
traceTraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and Addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For Addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record.
-EntryDetail
-Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account
-EntryDetail
-Generated using TypeDoc
EntryDetail
+The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
+EntryDetail
+RDFI's routing number without the last digit.
+EntryDetail
+Optional
addenda02EntryDetail
+Optional
addenda05List of Addenda05 records
+EntryDetail
+Optional
addenda98EntryDetail
+Optional
addenda98EntryDetail
+Optional
addenda99EntryDetail
+Optional
addenda99EntryDetail
+Optional
addenda99EntryDetail
+Optional
addendaAddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
+EntryDetail
+Number of cents you are debiting/crediting this account
+EntryDetail
+Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
+EntryDetail
+Last digit in RDFI routing number.
+EntryDetail
+Optional
discretionaryDiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.
+EntryDetail
+Entry Detail ID
+EntryDetail
+Optional
identificationInternal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record
+EntryDetail
+The name of the receiver, usually the name on the bank account
+EntryDetail
+Optional
traceTraceNumber is assigned by the ODFI or software vendor and used as part of identification. The format of trace numbers is the first 8 digits of the ODFI's routing number followed by 7 digits chosen by the ODFI or software vendor. Sequentual or random numbers can be chosen. The only requirement of Nacha is unique trace numbers within a batch and file. Trace Numbers are included in each Entry Detail Record, Corporate Entry Detail Record, and addenda Record. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record. Use TraceNumberField for a properly formatted string representation.
+EntryDetail
+Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account
+EntryDetail
+Generated using TypeDoc
FileControl
-Count of Batches in the File
-FileControl
-Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)
-FileControl
-Total detail and addenda records in the file
-FileControl
-Calculated in the same manner as the batch total but includes total from entire file
-FileControl
-Optional
idFile ID
-FileControl
-Accumulated Batch credit totals within the file.
-FileControl
-Accumulated Batch debit totals within the file.
-FileControl
-Generated using TypeDoc
FileControl
+Count of Batches in the File
+FileControl
+Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)
+FileControl
+Total detail and addenda records in the file
+FileControl
+Calculated in the same manner as the batch total but includes total from entire file
+FileControl
+Optional
idFile ID
+FileControl
+Accumulated Batch credit totals within the file.
+FileControl
+Accumulated Batch debit totals within the file.
+FileControl
+Generated using TypeDoc
FileHeader
-The File Creation Date is the date when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day)
-FileHeader
-The File Creation Time is the time when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute)
-FileHeader
-Optional
fileIDModifierIncremented value for each file for RDFIs.
-FileHeader
-Optional
idFile ID
-FileHeader
-Contains the Routing Number of the ACH Operator or receiving point to which the file is being sent.
-FileHeader
-The name of the ACH Operator or receiving point to which the file is being sent.
-FileHeader
-Contains the Routing Number of the ACH Operator or sending point that is sending the file.
-FileHeader
-The name of the ACH Operator or sending point that is sending the file.
-FileHeader
-Optional
referenceReserved field for information pertinent to the Originator.
-FileHeader
-Generated using TypeDoc
FileHeader
+The File Creation Date is the date when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day)
+FileHeader
+The File Creation Time is the time when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute)
+FileHeader
+Optional
fileIDModifierIncremented value for each file for RDFIs.
+FileHeader
+Optional
idFile ID
+FileHeader
+Contains the Routing Number of the ACH Operator or receiving point to which the file is being sent.
+FileHeader
+The name of the ACH Operator or receiving point to which the file is being sent.
+FileHeader
+Contains the Routing Number of the ACH Operator or sending point that is sending the file.
+FileHeader
+The name of the ACH Operator or sending point that is sending the file.
+FileHeader
+Optional
referenceReserved field for information pertinent to the Originator.
+FileHeader
+Generated using TypeDoc
FlattenFileResponse
-Optional
errorAn error message describing the problem intended for humans.
-FlattenFileResponse
-Optional
fileFlattenFileResponse
-Optional
idFile ID
-FlattenFileResponse
-Generated using TypeDoc
Generated using TypeDoc
IATBatch
-IATBatch
-IATBatch
-IATBatch
-Optional
idClient-defined string used as a reference to this record.
-IATBatch
-Generated using TypeDoc
IATBatch
+IATBatch
+IATBatch
+IATBatch
+Optional
idClient-defined string used as a reference to this record.
+IATBatch
+Generated using TypeDoc
IATBatchHeader
-Optional
IATIndicatorLeave Blank. Only used for corrected IAT entries
-IATBatchHeader
-Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US.
-IATBatchHeader
-ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter "USD", otherwise refer to International Organization for Standardization website for value: www.iso.org
-IATBatchHeader
-Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter 'USD', otherwise refer to International Organization for Standardization website for value: www.iso.org
-IATBatchHeader
-First 8 digits of the originating DFI transit routing number. For Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. (Format TTTTAAAA - T=Federal Reserve Routing Symbol, A=ABA Institution Identifier)
-IATBatchHeader
-BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
-IATBatchHeader
-Optional
companyA description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM," "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.
-IATBatchHeader
-Optional
effectiveEffectiveEntryDate the date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day)
-IATBatchHeader
-Code indicating currency conversion: 'FV' (Fixed-to-Variable) – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. | 'VF' (Variable-to-Fixed) – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. | 'FF' (Fixed-to-Fixed) – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled.
-IATBatchHeader
-Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction.
-IATBatchHeader
-Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate | 2 - Foreign Exchange Reference Number | 3 - Space Filled
-IATBatchHeader
-Optional
idID is a client-defined string used as a reference to this record.
-IATBatchHeader
-For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters
-IATBatchHeader
-Optional
originatorODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.
-IATBatchHeader
-Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'
-IATBatchHeader
-Optional
settlementThe date the entries actually settled (this is inserted by the ACH operator)
-IATBatchHeader
-StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record.
-IATBatchHeader
-Generated using TypeDoc
IATBatchHeader
+Optional
IATIndicatorLeave Blank. Only used for corrected IAT entries
+IATBatchHeader
+Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US.
+IATBatchHeader
+ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter "USD", otherwise refer to International Organization for Standardization website for value: www.iso.org
+IATBatchHeader
+Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter 'USD', otherwise refer to International Organization for Standardization website for value: www.iso.org
+IATBatchHeader
+First 8 digits of the originating DFI transit routing number. For Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. (Format TTTTAAAA - T=Federal Reserve Routing Symbol, A=ABA Institution Identifier)
+IATBatchHeader
+BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
+IATBatchHeader
+Optional
companyA description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM," "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.
+IATBatchHeader
+Optional
effectiveEffectiveEntryDate the date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day)
+IATBatchHeader
+Code indicating currency conversion: 'FV' (Fixed-to-Variable) – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. | 'VF' (Variable-to-Fixed) – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. | 'FF' (Fixed-to-Fixed) – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled.
+IATBatchHeader
+Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction.
+IATBatchHeader
+Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate | 2 - Foreign Exchange Reference Number | 3 - Space Filled
+IATBatchHeader
+Optional
idID is a client-defined string used as a reference to this record.
+IATBatchHeader
+For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters
+IATBatchHeader
+Optional
originatorODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.
+IATBatchHeader
+Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'
+IATBatchHeader
+Optional
settlementThe date the entries actually settled (this is inserted by the ACH operator)
+IATBatchHeader
+StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record.
+IATBatchHeader
+Generated using TypeDoc
IATEntryDetail
-The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
-IATEntryDetail
-Signifies if the record has been screened against OFAC records
-IATEntryDetail
-RDFI's routing number without the last digit.
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-IATEntryDetail
-Optional
addenda17IATEntryDetail
-Optional
addenda18IATEntryDetail
-Optional
addenda98IATEntryDetail
-Optional
addenda99IATEntryDetail
-AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
-IATEntryDetail
-Number of Addenda Records
-IATEntryDetail
-Number of cents you are debiting/crediting this account
-IATEntryDetail
-Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
-IATEntryDetail
-Last digit in RDFI routing number.
-IATEntryDetail
-Optional
idEntry Detail ID
-IATEntryDetail
-Signifies if the record has been screened against OFAC records by a secondary entry
-IATEntryDetail
-Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
-IATEntryDetail
-Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account
-IATEntryDetail
-Generated using TypeDoc
IATEntryDetail
+The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded
+IATEntryDetail
+Signifies if the record has been screened against OFAC records
+IATEntryDetail
+RDFI's routing number without the last digit.
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+IATEntryDetail
+Optional
addenda17IATEntryDetail
+Optional
addenda18IATEntryDetail
+Optional
addenda98IATEntryDetail
+Optional
addenda99IATEntryDetail
+AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.
+IATEntryDetail
+Number of Addenda Records
+IATEntryDetail
+Number of cents you are debiting/crediting this account
+IATEntryDetail
+Optional
categoryCategory defines if the entry is a Forward, Return, or NOC
+IATEntryDetail
+Last digit in RDFI routing number.
+IATEntryDetail
+Optional
idEntry Detail ID
+IATEntryDetail
+Signifies if the record has been screened against OFAC records by a secondary entry
+IATEntryDetail
+Optional
traceMatches the Entry Detail Trace Number of the entry being returned.
+IATEntryDetail
+Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account
+IATEntryDetail
+Generated using TypeDoc
ModelError
-An error message describing the problem intended for humans.
-ModelError
-Generated using TypeDoc
Generated using TypeDoc
ModelFile
-Optional
IATBatchesModelFile
-Optional
NotificationModelFile
-Optional
ReturnModelFile
-Optional
batchesModelFile
-Optional
fileADVControlModelFile
-ModelFile
-ModelFile
-Optional
idFile ID
-ModelFile
-Generated using TypeDoc
ModelFile
+Optional
IATBatchesModelFile
+Optional
NotificationModelFile
+Optional
ReturnModelFile
+Optional
batchesModelFile
+Optional
fileADVControlModelFile
+ModelFile
+ModelFile
+Optional
idFile ID
+ModelFile
+Generated using TypeDoc
Offset
-Account number used to offset records
-Offset
-Account type used in offset record
-Offset
-Memo for Offset EntryDetail record
-Offset
-ABA routing number
-Offset
-Generated using TypeDoc
Offset
+Account number used to offset records
+Offset
+Account type used in offset record
+Offset
+Memo for Offset EntryDetail record
+Offset
+ABA routing number
+Offset
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
SegmentedFiles
-Optional
creditSegmentedFiles
-Optional
creditFile ID
-SegmentedFiles
-Optional
debitSegmentedFiles
-Optional
debitFile ID
-SegmentedFiles
-Optional
errorAn error message describing the problem intended for humans.
-SegmentedFiles
-Generated using TypeDoc
SegmentedFiles
+Optional
creditSegmentedFiles
+Optional
creditFile ID
+SegmentedFiles
+Optional
debitSegmentedFiles
+Optional
debitFile ID
+SegmentedFiles
+Optional
errorAn error message describing the problem intended for humans.
+SegmentedFiles
+Generated using TypeDoc
ValidateOpts
-Optional
allowAllow the CheckDigit field in EntryDetail to differ from the expected calculation
-ValidateOpts
-Optional
allowAllow the file to be read without a FileControl record.
-ValidateOpts
-Optional
allowAllow the file to be read without a FileHeader record.
-ValidateOpts
-Optional
allowAllow the file to have zero batches.
-ValidateOpts
-Optional
bypassAllow batches in which the Company Identification field in the batch header and control do not match.
-ValidateOpts
-Optional
bypassSkip ImmediateDestination validation steps.
-ValidateOpts
-Optional
bypassSkip ImmediateOrigin validation steps.
-ValidateOpts
-Optional
customAllow for non-standard/deprecated return codes (e.g. R97)
-ValidateOpts
-Optional
customDisable Nacha specified checks of TraceNumbers.
-ValidateOpts
-Optional
requireABAOriginRequire that the FileHeader ImmediateOrigin routing number which checksum matches.
-ValidateOpts
-Optional
unequalSkip checking that Addenda Count fields match their expected and computed values.
-ValidateOpts
-Optional
unequalSkip equality checks for the ServiceClassCode in each pair of BatchHeader and BatchControl records.
-ValidateOpts
-Optional
unorderedAllow a file to be read with unordered batch numbers.
-ValidateOpts
-Generated using TypeDoc
ValidateOpts
+Optional
allowAllow the CheckDigit field in EntryDetail to differ from the expected calculation
+ValidateOpts
+Optional
allowAllow the file to be read without a FileControl record.
+ValidateOpts
+Optional
allowAllow the file to be read without a FileHeader record.
+ValidateOpts
+Optional
allowAllow the file to have zero batches.
+ValidateOpts
+Optional
bypassAllow batches in which the Company Identification field in the batch header and control do not match.
+ValidateOpts
+Optional
bypassSkip ImmediateDestination validation steps.
+ValidateOpts
+Optional
bypassSkip ImmediateOrigin validation steps.
+ValidateOpts
+Optional
customAllow for non-standard/deprecated return codes (e.g. R97)
+ValidateOpts
+Optional
customDisable Nacha specified checks of TraceNumbers.
+ValidateOpts
+Optional
requireABAOriginRequire that the FileHeader ImmediateOrigin routing number which checksum matches.
+ValidateOpts
+Optional
unequalSkip checking that Addenda Count fields match their expected and computed values.
+ValidateOpts
+Optional
unequalSkip equality checks for the ServiceClassCode in each pair of BatchHeader and BatchControl records.
+ValidateOpts
+Optional
unorderedAllow a file to be read with unordered batch numbers.
+ValidateOpts
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
ACH API +
ACH API Moov ACH (Automated Clearing House) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States.
The version of the OpenAPI document: v1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
-Optional
accessOptional
name: stringOptional
scopes: string[]Optional
name: stringOptional
scopes: string[]Optional
apiOptional
baseOptional
baseOptional
formOptional
passwordOptional
usernameGenerated using TypeDoc
Optional
accessOptional
name: stringOptional
scopes: string[]Optional
name: stringOptional
scopes: string[]Optional
apiOptional
baseOptional
baseOptional
formOptional
passwordOptional
usernameGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const
Readonly
Checking: "checking"Readonly
Savings: "savings"Generated using TypeDoc
Const
Readonly
Checking: "checking"Readonly
Savings: "savings"Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
ACHFilesApi - object-oriented interface
-Export