Function ACHFilesApiAxiosParamCreator

ACHFilesApi - axios parameter creator

Export

ACHFilesApiAxiosParamCreator(configuration?): {
    addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    buildFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    deleteACHFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    flattenFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileBatches: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileByID: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileContents: ((fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFiles: ((xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    ping: ((options??: AxiosRequestConfig) => Promise<RequestArgs>);
    segmentFile: ((xRequestID?: string, body?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    segmentFileID: ((fileID: string, xRequestID?: string, body?: any, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
}
Parameters
- Optionalconfiguration: Configuration
Returns {
    addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    buildFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    deleteACHFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    flattenFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileBatches: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileByID: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFileContents: ((fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options??: AxiosRequestConfig) => Promise<RequestArgs>);
    getFiles: ((xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    ping: ((options??: AxiosRequestConfig) => Promise<RequestArgs>);
    segmentFile: ((xRequestID?: string, body?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    segmentFileID: ((fileID: string, xRequestID?: string, body?: any, options??: AxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
}
- addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Append a Batch record to the specified File.
  
  Summary
  Append Batch to File
  
  Throws
  - - (fileID, batch, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      batch: Batch
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- buildFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.
  
  Summary
  Build File
  
  Throws
  - - (fileID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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<RequestArgs>)
  Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
  
  Summary
  Validate File
  
  Throws
  - - (fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalskipAll: boolean
      Optional parameter to disable all validation checks for a File
      
      OptionalrequireABAOrigin: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassOriginValidation: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassDestinationValidation: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomTraceNumbers: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowZeroBatches: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileHeader: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileControl: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalbypassCompanyIdentificationMatch: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomReturnCodes: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalunequalServiceClassCode: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowUnorderedBatchNumbers: boolean
      Allow a file to be read with unordered batch numbers.
      
      OptionalallowInvalidCheckDigit: boolean
      Allow the CheckDigit field in EntryDetail to differ from the expected calculation
      
      OptionalunequalAddendaCounts: boolean
      Optional parameter to configure UnequalAddendaCounts validation
      
      OptionalpreserveSpaces: boolean
      Optional parameter to save all padding spaces
      
      OptionalallowInvalidAmounts: boolean
      Optional parameter to save all padding spaces
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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<RequestArgs>)
  Create a new File object from either the plaintext or JSON representation.
  
  Summary
  Create File
  
  Throws
  - - (fileID, body, xRequestID?, skipAll?, requireABAOrigin?, bypassOrigin?, bypassOriginValidation?, bypassDestination?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, unorderedBatchNumbers?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      body: string
      Content of the ACH file (in json or raw text)
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      OptionalskipAll: boolean
      Optional parameter to disable all validation checks for a File
      
      OptionalrequireABAOrigin: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassOrigin: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassOriginValidation: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassDestination: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalbypassDestinationValidation: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomTraceNumbers: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowZeroBatches: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileHeader: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileControl: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalbypassCompanyIdentificationMatch: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomReturnCodes: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalunequalServiceClassCode: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalunorderedBatchNumbers: boolean
      Allow a file to be read with unordered batch numbers.
      
      OptionalallowUnorderedBatchNumbers: boolean
      Allow a file to be read with unordered batch numbers.
      
      OptionalallowInvalidCheckDigit: boolean
      Allow the CheckDigit field in EntryDetail to differ from the expected calculation
      
      OptionalunequalAddendaCounts: boolean
      Optional parameter to configure UnequalAddendaCounts validation
      
      OptionalpreserveSpaces: boolean
      Optional parameter to save all padding spaces
      
      OptionalallowInvalidAmounts: boolean
      Optional parameter to save all padding spaces
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- deleteACHFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Permanently deletes a File and associated Batches. It cannot be undone.
  
  Summary
  Delete File
  
  Throws
  - - (fileID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Delete a Batch from a File.
  
  Summary
  Delete Batch
  
  Throws
  - - (fileID, batchID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      batchID: string
      Batch ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- flattenFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Consolidate Batches and Entries into the minimum number of Batches needed.
  
  Summary
  Flatten Batches
  
  Throws
  - - (fileID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Get a specific Batch on a File.
  
  Summary
  Get Batch
  
  Throws
  - - (fileID, batchID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      batchID: string
      Batch ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getFileBatches: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Get the Batches on a File.
  
  Summary
  Get Batches
  
  Throws
  - - (fileID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getFileByID: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Get the details of an existing File using the unique File identifier that was returned upon creation.
  
  Summary
  Retrieve File
  
  Throws
  - - (fileID, xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getFileContents: ((fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
  
  Summary
  Get File Contents
  
  Throws
  - - (fileID, xRequestID?, xLineEnding?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      OptionalxLineEnding: "LF" | "CRLF"
      Optional Line Ending allows application developer to alter line ending of the file data returned. Supported choices are LF (Line Feed) and CRLF (Carriage Return Line Feed).
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getFiles: ((xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.
  
  Summary
  List Files
  
  Throws
  - - (xRequestID?, options?): Promise<RequestArgs>
    - Parameters
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- ping: ((options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Check if the ACH service is running.
  
  Summary
  Ping ACH service
  
  Throws
  - - (options?): Promise<RequestArgs>
    - Parameters
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- segmentFile: ((xRequestID?: string, body?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Split one File into two. One with only debits and one with only credits.
  
  Summary
  Segment File
  
  Throws
  - - (xRequestID?, body?, options?): Promise<RequestArgs>
    - Parameters
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionalbody: string
      ACH file (in Nacha or JSON formatting) along with optional segment configuration
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- segmentFileID: ((fileID: string, xRequestID?: string, body?: any, options??: AxiosRequestConfig) => Promise<RequestArgs>)
  Split one FileID into two. One with only debits and one with only credits.
  
  Summary
  Segment FileID
  
  Throws
  - - (fileID, xRequestID?, body?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      Optionalbody: any
      Optional configuration for segmenting files
      
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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<RequestArgs>)
  Validates the existing File. You need only supply the unique File identifier that was returned upon creation.
  
  Summary
  Validate File (Custom)
  
  Throws
  - - (fileID, skipAll?, requireABAOrigin?, bypassOriginValidation?, bypassDestinationValidation?, customTraceNumbers?, allowZeroBatches?, allowMissingFileHeader?, allowMissingFileControl?, bypassCompanyIdentificationMatch?, customReturnCodes?, unequalServiceClassCode?, allowUnorderedBatchNumbers?, allowInvalidCheckDigit?, unequalAddendaCounts?, preserveSpaces?, allowInvalidAmounts?, xRequestID?, validateOpts?, options?): Promise<RequestArgs>
    - Parameters
      fileID: string
      File ID
      
      OptionalskipAll: boolean
      Optional parameter to disable all validation checks for a File
      
      OptionalrequireABAOrigin: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassOriginValidation: boolean
      Optional parameter to configure ImmediateOrigin validation
      
      OptionalbypassDestinationValidation: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomTraceNumbers: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowZeroBatches: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileHeader: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowMissingFileControl: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalbypassCompanyIdentificationMatch: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalcustomReturnCodes: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalunequalServiceClassCode: boolean
      Optional parameter to configure ImmediateDestination validation
      
      OptionalallowUnorderedBatchNumbers: boolean
      Allow a file to be read with unordered batch numbers.
      
      OptionalallowInvalidCheckDigit: boolean
      Allow the CheckDigit field in EntryDetail to differ from the expected calculation
      
      OptionalunequalAddendaCounts: boolean
      Optional parameter to configure UnequalAddendaCounts validation
      
      OptionalpreserveSpaces: boolean
      Optional parameter to save all padding spaces
      
      OptionalallowInvalidAmounts: boolean
      Optional parameter to save all padding spaces
      
      OptionalxRequestID: string
      Optional Request ID allows application developer to trace requests through the system's logs
      
      OptionalvalidateOpts: ValidateOpts
      Optionaloptions: AxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- Defined in api.ts:2146

Function ACHFilesApiAxiosParamCreator

Export

Parameters

addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

buildFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

Summary

Throws

Parameters

Returns Promise<RequestArgs>

Summary

Throws

Parameters

Returns Promise<RequestArgs>

deleteACHFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

flattenFile: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getFileBatches: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getFileByID: ((fileID: string, xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getFileContents: ((fileID: string, xRequestID?: string, xLineEnding?: "LF" | "CRLF", options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getFiles: ((xRequestID?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

ping: ((options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

segmentFile: ((xRequestID?: string, body?: string, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

segmentFileID: ((fileID: string, xRequestID?: string, body?: any, options??: AxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

Summary

Throws

Parameters

Returns Promise<RequestArgs>