Function ACHFilesApiFp

ACHFilesApi - functional programming interface

Export

  • ACHFilesApiFp(configuration?): {
        addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>;
        checkFile(fileID: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>;
        createFile(fileID: string, body: string, xRequestID?: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestination?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, unorderedBatchNumbers?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>)>;
        deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        flattenFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlattenFileResponse>)>;
        getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>)>;
        getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>)>;
        getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>;
        getFileContents(fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>;
        getFiles(xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>)>;
        ping(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        segmentFile(xRequestID?: string, body?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>;
        segmentFileID(fileID: string, xRequestID?: string, body?: any, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>;
        validateFile(fileID: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>;
    }

  • Parameters

    Returns {
        addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>;
        checkFile(fileID: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>;
        createFile(fileID: string, body: string, xRequestID?: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestination?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, unorderedBatchNumbers?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>)>;
        deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        flattenFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlattenFileResponse>)>;
        getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>)>;
        getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>)>;
        getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>;
        getFileContents(fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>;
        getFiles(xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>)>;
        ping(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        segmentFile(xRequestID?: string, body?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>;
        segmentFileID(fileID: string, xRequestID?: string, body?: any, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>;
        validateFile(fileID: string, skipAll?: boolean, requireABAOrigin?: boolean, bypassOriginValidation?: boolean, bypassDestinationValidation?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, allowUnorderedBatchNumbers?: boolean, allowInvalidCheckDigit?: boolean, unequalAddendaCounts?: boolean, preserveSpaces?: boolean, allowInvalidAmounts?: boolean, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>;
    }

    • addBatchToFile:function
      • addBatchToFile(fileID, batch, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Append Batch to File

        Throws

    • buildFile:function
      • buildFile(fileID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>

        Summary

        Build File

        Throws

    • checkFile:function
      • checkFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>

        Summary

        Validate File

        Throws

    • createFile:function
      • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>)>

        Summary

        Create File

        Throws

    • deleteACHFile:function
      • deleteACHFile(fileID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Delete File

        Throws

    • deleteFileBatch:function
      • deleteFileBatch(fileID, batchID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Delete Batch

        Throws

    • flattenFile:function
      • flattenFile(fileID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlattenFileResponse>)>

        Summary

        Flatten Batches

        Throws

    • getFileBatch:function
      • getFileBatch(fileID, batchID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>)>

        Summary

        Get Batch

        Throws

    • getFileBatches:function
      • getFileBatches(fileID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>)>

        Summary

        Get Batches

        Throws

    • getFileByID:function
      • getFileByID(fileID, xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>

        Summary

        Retrieve File

        Throws

    • getFileContents:function
      • getFileContents(fileID, xRequestID?, xLineEnding?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

        Summary

        Get File Contents

        Throws

    • getFiles:function
      • getFiles(xRequestID?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>)>

        Summary

        List Files

        Throws

    • ping:function
      • ping(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Check if the ACH service is running.

        Parameters

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Ping ACH service

        Throws

    • segmentFile:function
      • segmentFile(xRequestID?, body?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionalbody: string

          ACH file (in Nacha or JSON formatting) along with optional segment configuration

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>

        Summary

        Segment File

        Throws

    • segmentFileID:function
      • segmentFileID(fileID, xRequestID?, body?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • Optionalbody: any

          Optional configuration for segmenting files

        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>

        Summary

        Segment FileID

        Throws

    • validateFile:function
      • validateFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, validateOpts?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<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&#39;s logs

        • OptionalvalidateOpts: ValidateOpts
        • Optionaloptions: AxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>

        Summary

        Validate File (Custom)

        Throws

Settings

Member Visibility