Function ACHFilesApiFp

Returns {
    addBatchToFile(
        fileID: string,
        batch: Batch,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    buildFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BuildFileResponse>,
    >;
    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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ValidateFileResponse>,
    >;
    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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFileResponse>,
    >;
    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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFileResponse>,
    >;
    deleteACHFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    deleteFileBatch(
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    flattenFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FlattenFileResponse>,
    >;
    getFileBatch(
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>,
    >;
    getFileBatches(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>,
    >;
    getFileByID(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    getFileContents(
        fileID: string,
        xRequestID?: string,
        xLineEnding?: "LF" | "CRLF",
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    getFiles(
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>,
    >;
    mergeFiles(
        mergeFilesRequest: MergeFilesRequest,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MergeFilesResponse>,
    >;
    ping(
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    reverseFile(
        fileID: string,
        xRequestID?: string,
        reverseFileRequest?: ReverseFileRequest,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReverseFileResponse>,
    >;
    segmentFile(
        xRequestID?: string,
        body?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SegmentedFiles>,
    >;
    segmentFileID(
        fileID: string,
        xRequestID?: string,
        body?: any,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SegmentedFiles>,
    >;
    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<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>,
    >;
}

• addBatchToFile: function

  • addBatchToFile(
        fileID: string,
        batch: Batch,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• buildFile: function

  • buildFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BuildFileResponse>,
    >

    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<any, any>

      Override http request option.

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

    Throws

• checkFile: function

  • 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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ValidateFileResponse>,
    >

    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&#39;s logs

    • Optionaloptions: AxiosRequestConfig<any, any>

      Override http request option.

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

    Throws

• createFile: function

  • 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<
        (
            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

    • 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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFileResponse>,
    >

    Throws

• createNewFile: function

  • 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<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFileResponse>,
    >

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

    Throws

• deleteACHFile: function

  • deleteACHFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• deleteFileBatch: function

  • deleteFileBatch(
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• flattenFile: function

  • flattenFile(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• getFileBatch: function

  • getFileBatch(
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• getFileBatches: function

  • getFileBatches(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• getFileByID: function

  • getFileByID(
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• getFileContents: function

  • getFileContents(
        fileID: string,
        xRequestID?: string,
        xLineEnding?: "LF" | "CRLF",
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• getFiles: function

  • getFiles(
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• mergeFiles: function

  • mergeFiles(
        mergeFilesRequest: MergeFilesRequest,
        xRequestID?: string,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MergeFilesResponse>,
    >

    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&#39;s logs

    • Optionaloptions: AxiosRequestConfig<any, any>

      Override http request option.

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

    Throws

• ping: function

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

    Check if the ACH service is running.

    Parameters

    • Optionaloptions: AxiosRequestConfig<any, any>

      Override http request option.

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

    Throws

• reverseFile: function

  • reverseFile(
        fileID: string,
        xRequestID?: string,
        reverseFileRequest?: ReverseFileRequest,
        options?: AxiosRequestConfig<any, any>,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReverseFileResponse>,
    >

    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&#39;s logs

    • OptionalreverseFileRequest: ReverseFileRequest

      Optional configuration for reversing a file

    • Optionaloptions: AxiosRequestConfig<any, any>

      Override http request option.

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

    Throws

• segmentFile: function

  • segmentFile(
        xRequestID?: string,
        body?: string,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• segmentFileID: function

  • segmentFileID(
        fileID: string,
        xRequestID?: string,
        body?: any,
        options?: AxiosRequestConfig<any, any>,
    ): 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<any, any>

      Override http request option.

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

    Throws

• validateFile: function

  • 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<
        (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

    • 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&#39;s logs

    • OptionalvalidateOpts: ValidateOpts
    • Optionaloptions: AxiosRequestConfig<any, any>

      Override http request option.

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

    Throws