Class ACHFilesApi

ACHFilesApi - object-oriented interface

Export

ACHFilesApi

Hierarchy (View Summary)

BaseAPI
- ACHFilesApi

Index

Constructors

constructor

new ACHFilesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: Configuration | undefined

Methods

addBatchToFile

addBatchToFile(
    fileID: string,
    batch: Batch,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<void, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4458

buildFile

buildFile(
    fileID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<BuildFileResponse, any, {}, 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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<BuildFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4471

checkFile

checkFile(
    fileID: string,
    skipAll?: boolean,
    allowEmptyIndividualName?: boolean,
    allowInvalidAmounts?: boolean,
    allowInvalidCheckDigit?: boolean,
    allowMissingFileControl?: boolean,
    allowMissingFileHeader?: boolean,
    allowSpecialCharacters?: boolean,
    allowUnorderedBatchNumbers?: boolean,
    allowZeroBatches?: boolean,
    bypassBatchValidation?: boolean,
    bypassCompanyIdentificationMatch?: boolean,
    bypassDestination?: boolean,
    bypassDestinationValidation?: boolean,
    bypassOrigin?: boolean,
    bypassOriginValidation?: boolean,
    customReturnCodes?: boolean,
    customTraceNumbers?: boolean,
    preserveSpaces?: boolean,
    requireABAOrigin?: boolean,
    skipFileCreationValidation?: boolean,
    skipBatchHeaderCompanyValidation?: boolean,
    unequalAddendaCounts?: boolean,
    unequalServiceClassCode?: boolean,
    unorderedBatchNumbers?: boolean,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<ValidateFileResponse, any, {}, any>>
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
- OptionalallowEmptyIndividualName: boolean
  Optional paramater to skip verifying IndividualName fields are populated for SEC codes that require the field to be non-blank (and non-zero)
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowSpecialCharacters: boolean
  Optional parameter to permit a wider range of UTF-8 characters in alphanumeric fields
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassBatchValidation: boolean
  Optional parameter to skip validation for batches in a file and only validate file header and control info
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestination: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalskipFileCreationValidation: boolean
  Optional parameter to skip validation of the FileCreationTime and FileCreationDate fields in a file header
- OptionalskipBatchHeaderCompanyValidation: boolean
  Optional parameter to bypass validation of Company fields in a BatchHeader
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<ValidateFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4508

createFile

createFile(
    fileID: string,
    body: string,
    xRequestID?: string,
    skipAll?: boolean,
    allowEmptyIndividualName?: boolean,
    allowInvalidAmounts?: boolean,
    allowInvalidCheckDigit?: boolean,
    allowMissingFileControl?: boolean,
    allowMissingFileHeader?: boolean,
    allowSpecialCharacters?: boolean,
    allowUnorderedBatchNumbers?: boolean,
    allowZeroBatches?: boolean,
    bypassBatchValidation?: boolean,
    bypassCompanyIdentificationMatch?: boolean,
    bypassDestination?: boolean,
    bypassDestinationValidation?: boolean,
    bypassOrigin?: boolean,
    bypassOriginValidation?: boolean,
    customReturnCodes?: boolean,
    customTraceNumbers?: boolean,
    preserveSpaces?: boolean,
    requireABAOrigin?: boolean,
    skipBatchHeaderCompanyValidation?: boolean,
    skipFileCreationValidation?: boolean,
    unequalAddendaCounts?: boolean,
    unequalServiceClassCode?: boolean,
    unorderedBatchNumbers?: boolean,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<CreateFileResponse, any, {}, any>>
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
- OptionalallowEmptyIndividualName: boolean
  Optional paramater to skip verifying IndividualName fields are populated for SEC codes that require the field to be non-blank (and non-zero)
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowSpecialCharacters: boolean
  Optional parameter to permit a wider range of UTF-8 characters in alphanumeric fields
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassBatchValidation: boolean
  Optional parameter to skip validation for batches in a file and only validate file header and control info
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestination: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalskipBatchHeaderCompanyValidation: boolean
  Optional parameter to bypass validation of Company fields in a BatchHeader
- OptionalskipFileCreationValidation: boolean
  Optional parameter to skip validation of the FileCreationTime and FileCreationDate fields in a file header
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<CreateFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4546

createNewFile

createNewFile(
    fileID: string,
    body: string,
    xRequestID?: string,
    skipAll?: boolean,
    allowEmptyIndividualName?: boolean,
    allowInvalidAmounts?: boolean,
    allowInvalidCheckDigit?: boolean,
    allowMissingFileControl?: boolean,
    allowMissingFileHeader?: boolean,
    allowSpecialCharacters?: boolean,
    allowUnorderedBatchNumbers?: boolean,
    allowZeroBatches?: boolean,
    bypassBatchValidation?: boolean,
    bypassCompanyIdentificationMatch?: boolean,
    bypassDestination?: boolean,
    bypassDestinationValidation?: boolean,
    bypassOrigin?: boolean,
    bypassOriginValidation?: boolean,
    customReturnCodes?: boolean,
    customTraceNumbers?: boolean,
    preserveSpaces?: boolean,
    requireABAOrigin?: boolean,
    skipBatchHeaderCompanyValidation?: boolean,
    skipFileCreationValidation?: boolean,
    unequalAddendaCounts?: boolean,
    unequalServiceClassCode?: boolean,
    unorderedBatchNumbers?: boolean,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<CreateFileResponse, any, {}, any>>
Create a new File object from either the plaintext or JSON representation. This endpoint is the same as POST /files/{fileID} but it's documented to accept a string/generic body which helps some generated clients. (e.g. Java) See https://github.com/moov-io/ach/issues/1650 for more details.
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
- OptionalallowEmptyIndividualName: boolean
  Optional paramater to skip verifying IndividualName fields are populated for SEC codes that require the field to be non-blank (and non-zero)
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowSpecialCharacters: boolean
  Optional parameter to permit a wider range of UTF-8 characters in alphanumeric fields
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassBatchValidation: boolean
  Optional parameter to skip validation for batches in a file and only validate file header and control info
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestination: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalskipBatchHeaderCompanyValidation: boolean
  Optional parameter to bypass validation of Company fields in a BatchHeader
- OptionalskipFileCreationValidation: boolean
  Optional parameter to skip validation of the FileCreationTime and FileCreationDate fields in a file header
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<CreateFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4584

deleteACHFile

deleteACHFile(
    fileID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<void, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4597

deleteFileBatch

deleteFileBatch(
    fileID: string,
    batchID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<void, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4611

flattenFile

flattenFile(
    fileID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<FlattenFileResponse, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<FlattenFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4624

getFileBatch

getFileBatch(
    fileID: string,
    batchID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<Batch, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<Batch, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4638

getFileBatches

getFileBatches(
    fileID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<Batch[], any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<Batch[], any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4651

getFileByID

getFileByID(
    fileID: string,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<any, any, {}, 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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<any, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4664

getFileContents

getFileContents(
    fileID: string,
    xRequestID?: string,
    xLineEnding?: "LF" | "CRLF",
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<string, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<string, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4678

getFiles

getFiles(
xRequestID?: string,
options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<any[], any, {}, 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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<any[], any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4690

mergeFiles

mergeFiles(
    mergeFilesRequest: MergeFilesRequest,
    xRequestID?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<MergeFilesResponse, any, {}, any>>
Combine multiple fileIDs and files together. Returned is the results of merging
Parameters
- mergeFilesRequest: MergeFilesRequest
  JSON object containing FileIDs and ACH files (in JSON format)
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<MergeFilesResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4703

ping

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

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4714

reverseFile

reverseFile(
    fileID: string,
    xRequestID?: string,
    reverseFileRequest?: ReverseFileRequest,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<ReverseFileResponse, any, {}, any>>
Creates a new file that is a REVERSAL of the given fileID.
Parameters
- fileID: string
  File ID
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- OptionalreverseFileRequest: ReverseFileRequest
  Optional configuration for reversing a file
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<ReverseFileResponse, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4728

segmentFile

segmentFile(
    xRequestID?: string,
    body?: string,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<SegmentedFiles, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<SegmentedFiles, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4741

segmentFileID

segmentFileID(
    fileID: string,
    xRequestID?: string,
    body?: any,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<SegmentedFiles, any, {}, any>>
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<any, any>
  Override http request option.
Returns Promise<AxiosResponse<SegmentedFiles, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4755

validateFile

validateFile(
    fileID: string,
    skipAll?: boolean,
    allowEmptyIndividualName?: boolean,
    allowInvalidAmounts?: boolean,
    allowInvalidCheckDigit?: boolean,
    allowMissingFileControl?: boolean,
    allowMissingFileHeader?: boolean,
    allowSpecialCharacters?: boolean,
    allowUnorderedBatchNumbers?: boolean,
    allowZeroBatches?: boolean,
    bypassBatchValidation?: boolean,
    bypassCompanyIdentificationMatch?: boolean,
    bypassDestination?: boolean,
    bypassDestinationValidation?: boolean,
    bypassOrigin?: boolean,
    bypassOriginValidation?: boolean,
    customReturnCodes?: boolean,
    customTraceNumbers?: boolean,
    preserveSpaces?: boolean,
    requireABAOrigin?: boolean,
    skipFileCreationValidation?: boolean,
    skipBatchHeaderCompanyValidation?: boolean,
    unequalAddendaCounts?: boolean,
    unequalServiceClassCode?: boolean,
    unorderedBatchNumbers?: boolean,
    xRequestID?: string,
    validateOpts?: ValidateOpts,
    options?: AxiosRequestConfig<any, any>,
): Promise<AxiosResponse<Error, any, {}, any>>
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
- OptionalallowEmptyIndividualName: boolean
  Optional paramater to skip verifying IndividualName fields are populated for SEC codes that require the field to be non-blank (and non-zero)
- OptionalallowInvalidAmounts: boolean
  Optional parameter to save all padding spaces
- OptionalallowInvalidCheckDigit: boolean
  Allow the CheckDigit field in EntryDetail to differ from the expected calculation
- OptionalallowMissingFileControl: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowMissingFileHeader: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalallowSpecialCharacters: boolean
  Optional parameter to permit a wider range of UTF-8 characters in alphanumeric fields
- OptionalallowUnorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalallowZeroBatches: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassBatchValidation: boolean
  Optional parameter to skip validation for batches in a file and only validate file header and control info
- OptionalbypassCompanyIdentificationMatch: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestination: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassDestinationValidation: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalbypassOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalbypassOriginValidation: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalcustomReturnCodes: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalcustomTraceNumbers: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalpreserveSpaces: boolean
  Optional parameter to save all padding spaces
- OptionalrequireABAOrigin: boolean
  Optional parameter to configure ImmediateOrigin validation
- OptionalskipFileCreationValidation: boolean
  Optional parameter to skip validation of the FileCreationTime and FileCreationDate fields in a file header
- OptionalskipBatchHeaderCompanyValidation: boolean
  Optional parameter to bypass validation of Company fields in a BatchHeader
- OptionalunequalAddendaCounts: boolean
  Optional parameter to configure UnequalAddendaCounts validation
- OptionalunequalServiceClassCode: boolean
  Optional parameter to configure ImmediateDestination validation
- OptionalunorderedBatchNumbers: boolean
  Allow a file to be read with unordered batch numbers.
- OptionalxRequestID: string
  Optional Request ID allows application developer to trace requests through the system's logs
- OptionalvalidateOpts: ValidateOpts
- Optionaloptions: AxiosRequestConfig<any, any>
  Override http request option.
Returns Promise<AxiosResponse<Error, any, {}, any>>

Throws

Memberof
ACHFilesApi
- Defined in api.ts:4793

Class ACHFilesApi

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ACHFilesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

addBatchToFile

Parameters

Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof

buildFile

Parameters

Returns Promise<AxiosResponse<BuildFileResponse, any, {}, any>>

Throws

Memberof

checkFile

Parameters

Returns Promise<AxiosResponse<ValidateFileResponse, any, {}, any>>

Throws

Memberof

createFile

Parameters

Returns Promise<AxiosResponse<CreateFileResponse, any, {}, any>>

Throws

Memberof

createNewFile

Parameters

Returns Promise<AxiosResponse<CreateFileResponse, any, {}, any>>

Throws

Memberof

deleteACHFile

Parameters

Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof

deleteFileBatch

Parameters

Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

Memberof

flattenFile

Parameters

Returns Promise<AxiosResponse<FlattenFileResponse, any, {}, any>>

Throws

Memberof

getFileBatch

Parameters

Returns Promise<AxiosResponse<Batch, any, {}, any>>

Throws

Memberof

getFileBatches

Parameters

Returns Promise<AxiosResponse<Batch[], any, {}, any>>

Throws

Memberof

getFileByID

Parameters

Returns Promise<AxiosResponse<any, any, {}, any>>

Throws

Memberof

getFileContents

Parameters

Returns Promise<AxiosResponse<string, any, {}, any>>

Throws

Memberof

getFiles

Parameters

Returns Promise<AxiosResponse<any[], any, {}, any>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration