Function ACHFilesApiFactory

ACHFilesApi - factory interface

Export

ACHFilesApiFactory(configuration?, basePath?, axios?): {
    addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, options?: any): AxiosPromise<void>;
    buildFile(fileID: string, xRequestID?: string, options?: any): 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?: any): 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?: any): AxiosPromise<CreateFileResponse>;
    deleteACHFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<void>;
    deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<void>;
    flattenFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<FlattenFileResponse>;
    getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<Batch>;
    getFileBatches(fileID: string, xRequestID?: string, options?: any): AxiosPromise<Batch[]>;
    getFileByID(fileID: string, xRequestID?: string, options?: any): AxiosPromise<any>;
    getFileContents(fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options?: any): AxiosPromise<string>;
    getFiles(xRequestID?: string, options?: any): AxiosPromise<any[]>;
    ping(options?: any): AxiosPromise<void>;
    segmentFile(xRequestID?: string, body?: string, options?: any): AxiosPromise<SegmentedFiles>;
    segmentFileID(fileID: string, xRequestID?: string, body?: any, options?: any): 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?: any): AxiosPromise<Error>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, options?: any): AxiosPromise<void>;
    buildFile(fileID: string, xRequestID?: string, options?: any): 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?: any): 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?: any): AxiosPromise<CreateFileResponse>;
    deleteACHFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<void>;
    deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<void>;
    flattenFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<FlattenFileResponse>;
    getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<Batch>;
    getFileBatches(fileID: string, xRequestID?: string, options?: any): AxiosPromise<Batch[]>;
    getFileByID(fileID: string, xRequestID?: string, options?: any): AxiosPromise<any>;
    getFileContents(fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options?: any): AxiosPromise<string>;
    getFiles(xRequestID?: string, options?: any): AxiosPromise<any[]>;
    ping(options?: any): AxiosPromise<void>;
    segmentFile(xRequestID?: string, body?: string, options?: any): AxiosPromise<SegmentedFiles>;
    segmentFileID(fileID: string, xRequestID?: string, body?: any, options?: any): 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?: any): AxiosPromise<Error>;
}
- addBatchToFile:function
  - addBatchToFile(fileID, batch, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Append Batch to File
    
    Throws
    - Defined in api.ts:3323
- buildFile:function
  - buildFile(fileID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<any>
    Summary
    Build File
    
    Throws
    - Defined in api.ts:3334
- checkFile:function
  - checkFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<Error>
    Summary
    Validate File
    
    Throws
    - Defined in api.ts:3361
- 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?): 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'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: any
      Override http request option.
    Returns AxiosPromise<CreateFileResponse>
    Summary
    Create File
    
    Throws
    - Defined in api.ts:3392
- deleteACHFile:function
  - deleteACHFile(fileID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Delete File
    
    Throws
    - Defined in api.ts:3403
- deleteFileBatch:function
  - deleteFileBatch(fileID, batchID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Delete Batch
    
    Throws
    - Defined in api.ts:3415
- flattenFile:function
  - flattenFile(fileID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<FlattenFileResponse>
    Summary
    Flatten Batches
    
    Throws
    - Defined in api.ts:3426
- getFileBatch:function
  - getFileBatch(fileID, batchID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<Batch>
    Summary
    Get Batch
    
    Throws
    - Defined in api.ts:3438
- getFileBatches:function
  - getFileBatches(fileID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<Batch[]>
    Summary
    Get Batches
    
    Throws
    - Defined in api.ts:3449
- getFileByID:function
  - getFileByID(fileID, xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<any>
    Summary
    Retrieve File
    
    Throws
    - Defined in api.ts:3460
- getFileContents:function
  - getFileContents(fileID, xRequestID?, xLineEnding?, options?): 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'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: any
      Override http request option.
    Returns AxiosPromise<string>
    Summary
    Get File Contents
    
    Throws
    - Defined in api.ts:3472
- getFiles:function
  - getFiles(xRequestID?, options?): 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's logs
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<any[]>
    Summary
    List Files
    
    Throws
    - Defined in api.ts:3482
- ping:function
  - ping(options?): AxiosPromise<void>
  - Check if the ACH service is running.
    Parameters
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Ping ACH service
    
    Throws
    - Defined in api.ts:3491
- segmentFile:function
  - segmentFile(xRequestID?, body?, options?): 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's logs
    - Optionalbody: string
      ACH file (in Nacha or JSON formatting) along with optional segment configuration
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<SegmentedFiles>
    Summary
    Segment File
    
    Throws
    - Defined in api.ts:3502
- segmentFileID:function
  - segmentFileID(fileID, xRequestID?, body?, options?): 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's logs
    - Optionalbody: any
      Optional configuration for segmenting files
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<SegmentedFiles>
    Summary
    Segment FileID
    
    Throws
    - Defined in api.ts:3514
- validateFile:function
  - validateFile(fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, validateOpts?, options?): 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's logs
    - OptionalvalidateOpts: ValidateOpts
    - Optionaloptions: any
      Override http request option.
    Returns AxiosPromise<Error>
    Summary
    Validate File (Custom)
    
    Throws
    - Defined in api.ts:3542
- Defined in api.ts:3311

Function ACHFilesApiFactory

Export

Parameters

addBatchToFile:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

buildFile:function

Parameters

Returns AxiosPromise<any>

Summary

Throws

checkFile:function

Parameters

Returns AxiosPromise<Error>

Summary

Throws

createFile:function

Parameters

Returns AxiosPromise<CreateFileResponse>

Summary

Throws

deleteACHFile:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

deleteFileBatch:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

flattenFile:function

Parameters

Returns AxiosPromise<FlattenFileResponse>

Summary

Throws

getFileBatch:function

Parameters

Returns AxiosPromise<Batch>

Summary

Throws

getFileBatches:function

Parameters

Returns AxiosPromise<Batch[]>

Summary

Throws

getFileByID:function

Parameters

Returns AxiosPromise<any>

Summary

Throws

getFileContents:function

Parameters

Returns AxiosPromise<string>

Summary

Throws

getFiles:function

Parameters

Returns AxiosPromise<any[]>

Summary

Throws

ping:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

segmentFile:function

Parameters

Returns AxiosPromise<SegmentedFiles>

Summary

Throws

segmentFileID:function

Parameters

Returns AxiosPromise<SegmentedFiles>

Summary

Throws

validateFile:function

Parameters