Class ACHFilesApi

ACHFilesApi - object-oriented interface

Export

ACHFilesApi

Hierarchy (view full)

BaseAPI
- ACHFilesApi

Index

Constructors

constructor

new ACHFilesApi(configuration?, basePath?, axios?): ACHFilesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ACHFilesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

addBatchToFile

addBatchToFile(fileID, batch, xRequestID?, options?): Promise<AxiosResponse<void>>
Append a Batch record to the specified File.
Parameters
- fileID: string
  File ID
- batch: Batch
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Summary
Append Batch to File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3565

buildFile

buildFile(fileID, xRequestID?, options?): Promise<AxiosResponse<any>>
Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<any>>
Summary
Build File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3578

checkFile

checkFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, options?): Promise<AxiosResponse<Error>>
Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
Parameters
- fileID: string
  File ID
- OptionalskipAll: boolean
  Optional parameter to disable all validation checks for a File
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Error>>
Summary
Validate File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3607

createFile

createFile(fileID, body, xRequestID?, skipAll?, requireABAOrigin?, bypassOrigin?, bypassOriginValidation?, bypassDestination?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, unorderedBatchNumbers?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, options?): Promise<AxiosResponse<CreateFileResponse>>
Create a new File object from either the plaintext or JSON representation.
Parameters
- fileID: string
  File ID
- body: string
  Content of the ACH file (in json or raw text)
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- OptionalskipAll: boolean
  Optional parameter to disable all validation checks for a File
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassDestination: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateFileResponse>>
Summary
Create File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3640

deleteACHFile

deleteACHFile(fileID, xRequestID?, options?): Promise<AxiosResponse<void>>
Permanently deletes a File and associated Batches. It cannot be undone.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Summary
Delete File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3653

deleteFileBatch

deleteFileBatch(fileID, batchID, xRequestID?, options?): Promise<AxiosResponse<void>>
Delete a Batch from a File.
Parameters
- fileID: string
  File ID
- batchID: string
  Batch ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Summary
Delete Batch

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3667

flattenFile

flattenFile(fileID, xRequestID?, options?): Promise<AxiosResponse<FlattenFileResponse>>
Consolidate Batches and Entries into the minimum number of Batches needed.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FlattenFileResponse>>
Summary
Flatten Batches

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3680

getFileBatch

getFileBatch(fileID, batchID, xRequestID?, options?): Promise<AxiosResponse<Batch>>
Get a specific Batch on a File.
Parameters
- fileID: string
  File ID
- batchID: string
  Batch ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Batch>>
Summary
Get Batch

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3694

getFileBatches

getFileBatches(fileID, xRequestID?, options?): Promise<AxiosResponse<Batch[]>>
Get the Batches on a File.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Batch[]>>
Summary
Get Batches

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3707

getFileByID

getFileByID(fileID, xRequestID?, options?): Promise<AxiosResponse<any>>
Get the details of an existing File using the unique File identifier that was returned upon creation.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<any>>
Summary
Retrieve File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3720

getFileContents

getFileContents(fileID, xRequestID?, xLineEnding?, options?): Promise<AxiosResponse<string>>
Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- OptionalxLineEnding: "LF" | "CRLF"
  Optional Line Ending allows application developer to alter line ending of the file data returned. Supported choices are LF (Line Feed) and CRLF (Carriage Return Line Feed).
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string>>
Summary
Get File Contents

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3734

getFiles

getFiles(xRequestID?, options?): Promise<AxiosResponse<any[]>>
List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
Parameters
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<any[]>>
Summary
List Files

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3746

ping

ping(options?): Promise<AxiosResponse<void>>
Check if the ACH service is running.
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Summary
Ping ACH service

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3757

segmentFile

segmentFile(xRequestID?, body?, options?): Promise<AxiosResponse<SegmentedFiles>>
Split one File into two. One with only debits and one with only credits.
Parameters
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionalbody: string
  ACH file (in Nacha or JSON formatting) along with optional segment configuration
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SegmentedFiles>>
Summary
Segment File

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3770

segmentFileID

segmentFileID(fileID, xRequestID?, body?, options?): Promise<AxiosResponse<SegmentedFiles>>
Split one FileID into two. One with only debits and one with only credits.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionalbody: any
  Optional configuration for segmenting files
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SegmentedFiles>>
Summary
Segment FileID

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3784

validateFile

validateFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, validateOpts?, options?): Promise<AxiosResponse<Error>>
Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
Parameters
- fileID: string
  File ID
- OptionalskipAll: boolean
  Optional parameter to disable all validation checks for a File
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- OptionalvalidateOpts: ValidateOpts
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Error>>
Summary
Validate File (Custom)

Throws
Memberof
ACHFilesApi
- Defined in api.ts:3814

Class ACHFilesApi

Export

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ACHFilesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

addBatchToFile

Parameters

Returns Promise<AxiosResponse<void>>

Summary

Throws

Memberof

buildFile

Parameters

Returns Promise<AxiosResponse<any>>

Summary

Throws

Memberof

checkFile

Parameters

Returns Promise<AxiosResponse<Error>>

Summary

Throws

Memberof

createFile

Parameters

Returns Promise<AxiosResponse<CreateFileResponse>>

Summary

Throws

Memberof

deleteACHFile

Parameters

Returns Promise<AxiosResponse<void>>

Summary

Throws

Memberof

deleteFileBatch

Parameters

Returns Promise<AxiosResponse<void>>

Summary

Throws

Memberof

flattenFile

Parameters

Returns Promise<AxiosResponse<FlattenFileResponse>>

Summary

Throws

Memberof

getFileBatch

Parameters

Returns Promise<AxiosResponse<Batch>>

Summary

Throws

Memberof

getFileBatches

Parameters

Returns Promise<AxiosResponse<Batch[]>>

Summary

Throws

Memberof

getFileByID

Parameters

Returns Promise<AxiosResponse<any>>

Summary

Throws

Memberof

getFileContents

Parameters

Returns Promise<AxiosResponse<string>>

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration