openapi

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2022 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for openapi

Moov Image Cash Letter (ICL) implements an HTTP API for creating, parsing, and validating ImageCashLetter files.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to http://localhost:8083

Class Method HTTP request Description
ImageCashLetterFilesApi AddICLToFile Post /files/{fileID}/cashLetters Add cash letter to file
ImageCashLetterFilesApi CreateICLFile Post /files/create Create file
ImageCashLetterFilesApi DeleteICLFile Delete /files/{fileID} Delete file
ImageCashLetterFilesApi DeleteICLFromFile Delete /files/{fileID}/cashLetters/{cashLetterID} Delete cash letter from file
ImageCashLetterFilesApi GetICLFileByID Get /files/{fileID} Retrieve file
ImageCashLetterFilesApi GetICLFileContents Get /files/{fileID}/contents Get file contents
ImageCashLetterFilesApi GetICLFiles Get /files List files
ImageCashLetterFilesApi Ping Get /ping Ping ImageCashLetter service
ImageCashLetterFilesApi UpdateICLFile Post /files/{fileID} Update file header
ImageCashLetterFilesApi ValidateICLFile Get /files/{fileID}/validate Validate file

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ImageCashLetterFilesApi *ImageCashLetterFilesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the ImageCashLetter API API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig added in v0.4.0 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AddICLToFileOpts 

type AddICLToFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

AddICLToFileOpts Optional parameters for the method 'AddICLToFile'

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Bundle 

type Bundle struct {
	BundleHeader  BundleHeader  `json:"bundleHeader,omitempty"`
	Checks        []Checks      `json:"checks,omitempty"`
	Returns       []Returns     `json:"returns,omitempty"`
	BundleControl BundleControl `json:"bundleControl,omitempty"`
}

Bundle struct for Bundle

type BundleControl 

type BundleControl struct {
	// BundleControl ID
	ID string `json:"ID,omitempty"`
	// BundleItemsCount identifies the total number of items within the bundle.
	BundleItemsCount int32 `json:"bundleItemsCount"`
	// BundleTotalAmount identifies the total amount of item amounts within the bundle.
	BundleTotalAmount int32 `json:"bundleTotalAmount"`
	// MICRValidTotalAmount identifies the total amount of all Check Records within the bundle which contain 1 in the MICRValidIndicator.
	MicrValidTotalAmount int32 `json:"micrValidTotalAmount,omitempty"`
	// BundleImagesCount identifies the total number of ImageViewDetail Records  within the bundle.
	BundleImagesCount int32 `json:"bundleImagesCount,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// CreditTotalIndicator is a code that indicates whether Credit Items are included in the totals. If so, they will be included in this record’s BundleItemsCount, BundleTotalAmount, and BundleImagesCount. * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator int32 `json:"creditTotalIndicator,omitempty"`
}

BundleControl struct for BundleControl

type BundleHeader 

type BundleHeader struct {
	// BundleHeader ID
	ID string `json:"ID,omitempty"`
	// A code that identifies the type of bundle. It is the same value as the CollectionTypeIndicator in the CashLetterHeader within which the bundle is contained, unless the CollectionTypeIndicator in the CashLetterHeader is 99.  * `00` - Preliminary Forward Information * `01` - Forward Presentment * `02` - Forward Presentment - Same-Day Settlement * `03` - Return * `04` - Return Notification * `05` - Preliminary Return Notification * `06` - Final Return Notification
	CollectionTypeIndicator string `json:"collectionTypeIndicator,omitempty"`
	// DestinationRoutingNumber contains the routing and transit number of the institution that receives and processes the cash letter or the bundle.
	DestinationRoutingNumber string `json:"destinationRoutingNumber,omitempty"`
	// ECEInstitutionRoutingNumber contains the routing and transit number of the institution that that creates the bundle header.
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// BundleBusinessDate is the business date of the bundle.
	BundleBusinessDate time.Time `json:"bundleBusinessDate,omitempty"`
	// BundleCreationDate is the date that the bundle is created.
	BundleCreationDate time.Time `json:"bundleCreationDate,omitempty"`
	// BundleID is a number that identifies the bundle, assigned by the institution that creates the bundle.
	BundleID string `json:"bundleID,omitempty"`
	// BundleSequenceNumber is a number assigned by the institution that creates the bundle. Usually denotes the relative position of the bundle within the cash letter.
	BundleSequenceNumber string `json:"bundleSequenceNumber,omitempty"`
	// CycleNumber is a code assigned by the institution that creates the bundle.  Denotes the cycle under which the bundle is created.
	CycleNumber string `json:"cycleNumber,omitempty"`
	// ReturnLocationRoutingNumber is a bank routing number used by some processors. This will be blank in the resulting file if it is empty.
	ReturnLocationRoutingNumber string `json:"returnLocationRoutingNumber,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

BundleHeader struct for BundleHeader

type CashLetter 

type CashLetter struct {
	CashLetterHeader     CashLetterHeader       `json:"cashLetterHeader,omitempty"`
	CreditItems          []CreditItem           `json:"creditItems,omitempty"`
	Bundles              []Bundle               `json:"bundles,omitempty"`
	RoutingNumberSummary []RoutingNumberSummary `json:"routingNumberSummary,omitempty"`
	CashLetterControl    CashLetterControl      `json:"cashLetterControl,omitempty"`
}

CashLetter struct for CashLetter

type CashLetterControl 

type CashLetterControl struct {
	// CashLetterControl ID
	ID string `json:"ID,omitempty"`
	// CashLetterBundleCount identifies the total number of bundles within the cash letter.
	CashLetterBundleCount int32 `json:"cashLetterBundleCount,omitempty"`
	// CashLetterItemsCount identifies the total number of items within the cash letter.
	CashLetterItemsCount int32 `json:"cashLetterItemsCount"`
	// CashLetterTotalAmount identifies the total dollar value of all item amounts within the cash letter.
	CashLetterTotalAmount int32 `json:"cashLetterTotalAmount"`
	// CashLetterImagesCount identifies the total number of ImageViewDetail(s) within the CashLetter.
	CashLetterImagesCount int32 `json:"cashLetterImagesCount,omitempty"`
	// ECEInstitutionName identifies the short name of the institution that creates the CashLetterControl.
	ECEInstitutionName string `json:"eCEInstitutionName,omitempty"`
	// SettlementDate identifies the date that the institution that creates the cash letter expects settlement.
	SettlementDate time.Time `json:"settlementDate"`
	// CreditTotalIndicator is a code that indicates whether Credit Items are included in this record’s totals. If so, they will be included in TotalItemCount and FileTotalAmount. TotalRecordCount includes all records of all types regardless of the value of this field. * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator int32 `json:"creditTotalIndicator,omitempty"`
}

CashLetterControl struct for CashLetterControl

type CashLetterHeader 

type CashLetterHeader struct {
	// CashLetterHeader ID
	ID string `json:"ID,omitempty"`
	// CollectionTypeIndicator is a code that identifies the type of cash letter.  * `00` - Preliminary Forward Information * `01` - Forward Presentment * `02` - Forward Presentment - Same-Day Settlement * `03` - Return * `04` - Return Notification * `05` - Preliminary Return Notification * `06` - Final Return Notification * `20` - No Detail * `99` - Bundles not the same collection type. Use of the value is only allowed by clearing arrangement.
	CollectionTypeIndicator string `json:"collectionTypeIndicator,omitempty"`
	// DestinationRoutingNumber is the routing and transit number of the institution that receives and processes the cash letter or the bundle.
	DestinationRoutingNumber string `json:"destinationRoutingNumber,omitempty"`
	// ECEInstitutionRoutingNumber is the routing and transit number of the institution that creates the Cash Letter Header record.
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// cashLetterBusinessDate is the business date of the cash letter.
	CashLetterBusinessDate time.Time `json:"cashLetterBusinessDate,omitempty"`
	// cashLetterCreationDate is the date that the cash letter is created.
	CashLetterCreationDate time.Time `json:"cashLetterCreationDate,omitempty"`
	// CashLetterCreationTime is the time that the cash letter is created.
	CashLetterCreationTime time.Time `json:"cashLetterCreationTime,omitempty"`
	// RecordTypeIndicator is a code that indicates the presence of records or the type of records contained in the cash letter. If an image is associated with any Check or Return, the cash letter must have a RecordTypeIndicator of I or F.  * `N` - No electronic check records or image records (Type 2x’s, 3x’s, 5x’s); e.g., an empty cash letter. * `E` - Cash letter contains electronic check records with no images (Type 2x’s and 3x’s only). * `I` - Cash letter contains electronic check records (Type 2x’s, 3x’s) and image records (Type 5x’s). * `F` - Cash letter contains electronic check records (Type 2x’s and 3x’s) and image records (Type 5x’s) that correspond to a previously sent cash letter (i.e., E file).
	RecordTypeIndicator string `json:"recordTypeIndicator,omitempty"`
	// DocumentationTypeIndicator is a code that indicates the type of documentation that supports all check records in the cash letter.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately * `Z` - Not Same Type–Documentation associated with each item in Cash Letter will be different.
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// CashLetterID uniquely identifies the cash letter. It is assigned by the institution that creates the cash letter and must be unique within a Cash Letter Business Date.
	CashLetterID string `json:"cashLetterID,omitempty"`
	// OriginatorContactName is the name of a contact at the institution that creates the cash letter.
	OriginatorContactName string `json:"originatorContactName,omitempty"`
	// OriginatorContactPhoneNumber is the phone number of the contact at the institution that creates the cash letter.
	OriginatorContactPhoneNumber string `json:"originatorContactPhoneNumber,omitempty"`
	// fedWorkType is any valid code specified by the Federal Reserve Bank.
	FedWorkType string `json:"fedWorkType,omitempty"`
	// ReturnsIndicator identifies type of returns.  * ` ` - Original Message * `E` - Administrative - items being returned that are handled by the bank and usually do not directly affect the customer or its account. * `R` - Customer–items being returned that directly affect a customer’s account. * `J` - Reject Return
	ReturnsIndicator string `json:"returnsIndicator,omitempty"`
	// UserField is a field used at the discretion of users of the standard
	UserField string `json:"userField,omitempty"`
}

CashLetterHeader struct for CashLetterHeader

type CheckDetailAddendumA 

type CheckDetailAddendumA struct {
	// CheckDetailAddendumA ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each CheckDetailAddendumA was created. CheckDetailAddendumA shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// ReturnLocationRoutingNumber is a valid routing and transit number indicating where returns, final return notifications, and preliminary return notifications are sent, usually the BOFD.
	ReturnLocationRoutingNumber string `json:"returnLocationRoutingNumber"`
	// BOFDEndorsementDate is the date of endorsement.
	BOFDEndorsementDate time.Time `json:"bOFDEndorsementDate,omitempty"`
	// BOFDItemSequenceNumber is a number that identifies the item in the CheckDetailAddendumA.
	BOFDItemSequenceNumber string `json:"bOFDItemSequenceNumber,omitempty"`
	// BOFDAccountNumber is a number that identifies the depository account at the Bank of First Deposit.
	BOFDAccountNumber string `json:"bOFDAccountNumber,omitempty"`
	// BOFDBranchCode is a code that identifies the branch at the Bank of First Deposit.
	BOFDBranchCode string `json:"bOFDBranchCode,omitempty"`
	// PayeeName is the name of the payee from the check.
	PayeeName string `json:"payeeName,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// BOFDConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of the institution that created this record.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	BOFDConversionIndicator string `json:"bOFDConversionIndicator,omitempty"`
	// BOFDCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumA Record for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	BOFDCorrectionIndicator int32 `json:"BOFDCorrectionIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

CheckDetailAddendumA struct for CheckDetailAddendumA

type CheckDetailAddendumB 

type CheckDetailAddendumB struct {
	// CheckDetailAddendumB ID
	ID string `json:"ID,omitempty"`
	// ImageReferenceKeyIndicator identifies whether ImageReferenceKeyLength contains a variable value within the allowable range, or contains a defined value and the content is ItemReferenceKey.  * `0` - ImageReferenceKeyIndicator has a Defined Value of 0034 and ImageReferenceKey contains the Image Reference Key. * `1`- ImageReferenceKeyIndicator contains a value other than 0034; or ImageReferenceKeyIndicator contains Value 0034, which is not a Defined Value, and the content of ImageReferenceKey has no special significance with regards to an Image Reference Key; or ImageReferenceKeyIndicator is 0000, meaning the ImageReferenceKey is not present.
	ImageReferenceKeyIndicator int32 `json:"imageReferenceKeyIndicator,omitempty"`
	// microfilmArchiveSequenceNumber is a number that identifies the item in the microfilm archive system; it may be different than the Check.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.
	MicrofilmArchiveSequenceNumber string `json:"microfilmArchiveSequenceNumber"`
	// ImageReferenceKeyLength is the number of characters in the ImageReferenceKey.  * `0034` - ImageReferenceKey contains the ImageReferenceKey (ImageReferenceKeyIndicator is 0). * `0000` - ImageReferenceKey not present (ImageReferenceKeyIndicator is 1). * `0001` - 9999: May include Value 0034, and ImageReferenceKey has no special significance to Image Reference Key (ImageReferenceKey is 1).
	LengthImageReferenceKey string `json:"lengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is used to find the image of the item in the image data system.  Size is variable based on lengthImageReferenceKey. The position within the file is variable based on the lengthImageReferenceKey.
	ImageReferenceKey string `json:"imageReferenceKey,omitempty"`
	// Descript describes the transaction.  The position within the file is variable based on the lengthImageReferenceKey.
	Descript string `json:"descript,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

CheckDetailAddendumB struct for CheckDetailAddendumB

type CheckDetailAddendumC 

type CheckDetailAddendumC struct {
	// CheckDetailAddendumC ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each CheckDetailAddendumC was created. CheckDetailAddendumC shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// EndorsingBankRoutingNumber is a valid routing and transit number indicating the bank that endorsed the check.
	EndorsingBankRoutingNumber string `json:"endorsingBankRoutingNumber"`
	// BOFDEndorsementBusinessDate is the date of endorsement.
	BOFDEndorsementBusinessDate time.Time `json:"bOFDEndorsementBusinessDate,omitempty"`
	// EndorsingItemSequenceNumber is a number that identifies the item at the endorsing bank.
	EndorsingBankSequenceNumber string `json:"endorsingBankSequenceNumber,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// EndorsingBankConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of the institution identified in the EndorsingBankRoutingNumber.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	EndorsingBankConversionIndicator string `json:"endorsingBankConversionIndicator,omitempty"`
	// EndorsingBankCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumC Record for fields other than Payor Bank Routing Number and Amount.  * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	EndorsingBankCorrectionIndicator int32 `json:"endorsingBankCorrectionIndicator,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// * `0` - Depository Bank (BOFD) - this value is used when the CheckDetailAddendumC Record reflects the Return * `Processing Bank in lieu of BOFD. * `1` - Other Collecting Bank * `2` - Other Returning Bank * `3` - Payor Bank
	EndorsingBankIdentifier int32 `json:"endorsingBankIdentifier,omitempty"`
}

CheckDetailAddendumC struct for CheckDetailAddendumC

type Checks 

type Checks struct {
	// Check ID
	ID string `json:"ID,omitempty"`
	// AuxiliaryOnUs identifies a code used on commercial checks at the discretion of the payor bank.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// PayorBankRoutingNumber identifies the institution by or through which the item is payable. Must be a valid routing and transit number issued by the ABA’s Routing Number Registrar. Shall represent the first 8 digits of a 9-digit routing number or 8 numeric digits of a 4 dash 4 routing number. A valid routing number consists of 2 fields: the eight-digit Payor Bank Routing Number and the one-digit Payor Bank Routing Number Check Digit.
	PayorBankRoutingNumber string `json:"payorBankRoutingNumber,omitempty"`
	// PayorBankCheckDigit identifies the routing number check digit.  The combination of Payor Bank Routing Number and Payor Bank Routing Number Check Digit must be a mod-checked routing number with a valid check digit.
	PayorBankCheckDigit string `json:"payorBankCheckDigit,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00.
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// ECEInstitutionItemSequenceNumber identifies a number assigned by the institution that creates the Check. Field must contain a numeric value. It cannot be all blanks.
	ECEInstitutionItemSequenceNumber string `json:"eCEInstitutionItemSequenceNumber,omitempty"`
	// DocumentationTypeIndicator identifies a code that indicates the type of documentation that supports the check record.  This field is superseded by the Cash Letter Documentation Type Indicator in the Cash Letter Header Record for all Defined Values except ‘Z’ Not Same Type. In the case of Defined Value of ‘Z’, the Documentation Type Indicator in this record takes precedent.  Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// ReturnAcceptanceIndicator is a code that indicates whether the institution that creates the Check will or will not support electronic return processing.  * `0` - Will not accept any electronic information * `1` - Will accept preliminary return notifications, returns, and final return notifications * `2` - Will accept preliminary return notifications and returns * `3` - Will accept preliminary return notifications and final return notifications * `4` - Will accept returns and final return notifications * `5` - Will accept preliminary return notifications only * `6` - Will accept returns only * `7` - Will accept final return notifications only * `8` - Will accept preliminary return notifications, returns, final return notifications, and image returns * `9` - Will accept preliminary return notifications, returns and image returns * `A` - Will accept preliminary return notifications, final return notifications and image returns * `B` - Will accept returns, final return notifications and image returns * `C` - Will accept preliminary return notifications and image returns * `D` - Will accept returns and image returns * `E` - Will accept final return notifications and image returns * `F` - Will accept image returns only
	ReturnAcceptanceIndicator string `json:"returnAcceptanceIndicator,omitempty"`
	// MICRValidIndicator is a code that indicates whether any character in the Magnetic Ink Character Recognition (MICR) property is unreadable, or the OnUs property is missing from the Check. * `1` - Good read * `2` - Good read, missing field * `3` - Read error encountered * `4` - Missing field and read error encountered
	MICRValidIndicator int32 `json:"mICRValidIndicator,omitempty"`
	// BOFDIndicator is a code that indicates whether the ECE institution indicated on the Bundle Header Record (Type 20) is the Bank of First Deposit (BOFD). This field shall be consistent with values contained in the Check Detail Addendum A Record (Type 26) and Check Detail Addendum C Record (Type 28). * `Y` - ECE institution is BOFD * `N` - ECE institution is not BOFD * `U` - ECE institution relationship to BOFD is undetermined
	BOFDIndicator string `json:"bOFDIndicator,omitempty"`
	// AddendumCount is a number of Check Detail Record Addenda to follow. This represents the number of CheckDetailAddendumA, CheckDetailAddendumB, and CheckDetailAddendumC types. It matches the total number of addendum records associated with this item. The standard supports up to 99 addendum records.
	AddendumCount int32 `json:"addendumCount,omitempty"`
	// CorrectionIndicator identifies whether and how the MICR line was repaired, for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	CorrectionIndicator int32 `json:"correctionIndicator,omitempty"`
	// ArchiveTypeIndicator is a code that indicates the type of archive that supports this Check. Access method, availability, and time frames shall be defined by clearing arrangements.  * `A` - Microfilm * `B` - Image * `C` - Paper * `D` - Microfilm and image * `E` - Microfilm and paper * `F` - Image and paper * `G` - Microfilm, image and paper * `H` - Electronic Check Instrument * `I` - None
	ArchiveTypeIndicator string                 `json:"archiveTypeIndicator,omitempty"`
	CheckDetailAddendumA []CheckDetailAddendumA `json:"checkDetailAddendumA,omitempty"`
	CheckDetailAddendumB []CheckDetailAddendumB `json:"checkDetailAddendumB,omitempty"`
	CheckDetailAddendumC []CheckDetailAddendumC `json:"checkDetailAddendumC,omitempty"`
	ImageViewDetail      []ImageViewDetail      `json:"imageViewDetail,omitempty"`
	ImageViewData        []ImageViewData        `json:"imageViewData,omitempty"`
	ImageViewAnalysis    []ImageViewAnalysis    `json:"imageViewAnalysis,omitempty"`
}

Checks struct for Checks

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

type CreateICLFileOpts 

type CreateICLFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

CreateICLFileOpts Optional parameters for the method 'CreateICLFile'

type CreateIclFile added in v0.4.0 

type CreateIclFile struct {
	// File ID
	ID          string         `json:"ID,omitempty"`
	FileHeader  IclFileHeader  `json:"fileHeader"`
	CashLetters []CashLetter   `json:"cashLetters,omitempty"`
	Bundles     []Bundle       `json:"bundles,omitempty"`
	FileControl IclFileControl `json:"fileControl,omitempty"`
}

CreateIclFile struct for CreateIclFile

type CreditItem 

type CreditItem struct {
	// CreditItem ID
	ID string `json:"ID,omitempty"`
	// AuxiliaryOnUs identifies a code used at the discretion of the creating bank. The handling of dashes and spaces shall be determined between the exchange partners.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// PostingBankRoutingNumber is a routing number assigned by the posting bank to identify this credit.
	PostingBankRoutingNumber string `json:"postingBankRoutingNumber,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00.
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// CreditItemSequenceNumber identifies a number assigned by the institution that creates the CreditItem.
	CreditItemSequenceNumber string `json:"creditItemSequenceNumber,omitempty"`
	// DocumentationTypeIndicator is a code used to indicate the type of documentation that supports this record. Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// AccountTypeCode is a code that indicates the type of account to which this CreditItem is associated.  * `0` - Unknown * `1` - DDA account * `2` - General Ledger account * `3` - Savings account * `4` - Money Market account * `5` - Other Account
	AcccountTypeCode string `json:"acccountTypeCode,omitempty"`
	// SourceWorkCode is a code used to identify the source of the work associated with this CreditItem.  * `00` - Unknown * `01` - Internal–ATM * `02` - Internal–Branch * `03` - Internal–Other * `04` - External–Bank to Bank (Correspondent) * `05` - External–Business to Bank (Customer) * `06` - External–Business to Bank Remote Capture * `07` - External–Processor to Bank * `08` - External–Bank to Processor * `09` - Lockbox * `10` - International–Internal * `11` - International–External * `21–50` - User Defined
	SourceWorkCode string `json:"sourceWorkCode,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

CreditItem struct for CreditItem

type DeleteICLFileOpts 

type DeleteICLFileOpts struct {
	XRequestID optional.String
}

DeleteICLFileOpts Optional parameters for the method 'DeleteICLFile'

type DeleteICLFromFileOpts 

type DeleteICLFromFileOpts struct {
	XRequestID optional.String
}

DeleteICLFromFileOpts Optional parameters for the method 'DeleteICLFromFile'

type Error 

type Error struct {
	// An error message describing the problem intended for humans.
	Error string `json:"error"`
}

Error struct for Error

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetICLFileByIDOpts 

type GetICLFileByIDOpts struct {
	XRequestID optional.String
}

GetICLFileByIDOpts Optional parameters for the method 'GetICLFileByID'

type GetICLFileContentsOpts 

type GetICLFileContentsOpts struct {
	XRequestID optional.String
}

GetICLFileContentsOpts Optional parameters for the method 'GetICLFileContents'

type GetICLFilesOpts 

type GetICLFilesOpts struct {
	XRequestID optional.String
}

GetICLFilesOpts Optional parameters for the method 'GetICLFiles'

type IclFile added in v0.4.0 

type IclFile struct {
	// File ID
	ID          string         `json:"ID,omitempty"`
	FileHeader  IclFileHeader  `json:"fileHeader,omitempty"`
	CashLetters []CashLetter   `json:"cashLetters,omitempty"`
	Bundles     []Bundle       `json:"bundles,omitempty"`
	FileControl IclFileControl `json:"fileControl,omitempty"`
}

IclFile struct for IclFile

type IclFileControl added in v0.4.0 

type IclFileControl struct {
	// FileControl ID
	ID string `json:"ID,omitempty"`
	// CashLetterCount identifies the total number of cash letters within the file.
	CashLetterCount int32 `json:"cashLetterCount"`
	// TotalRecordCount identifies the total number of records of all types sent in the file, including the FileControl.
	TotalRecordCount int32 `json:"totalRecordCount"`
	// totalItemCount identifies the total number of Items sent within the file.
	TotalItemCount int32 `json:"totalItemCount"`
	// FileTotalAmount identifies the total Item amount of the complete file.
	FileTotalAmount int32 `json:"fileTotalAmount"`
	// immediateOriginContactName identifies a contact at the institution that creates the file.
	ImmediateOriginContactName string `json:"immediateOriginContactName,omitempty"`
	// ImmediateOriginContactPhoneNumber identifies the phone number of the contact at the institution that creates the file.
	ImmediateOriginContactPhoneNumber string `json:"immediateOriginContactPhoneNumber,omitempty"`
	// CreditTotalIndicator is a code that indicates whether Credit Items are included in this record’s totals. If so, they will be included in TotalItemCount and FileTotalAmount. TotalRecordCount includes all records of all types regardless of the value of this field. * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator int32 `json:"creditTotalIndicator,omitempty"`
}

IclFileControl struct for IclFileControl

type IclFileHeader added in v0.4.0 

type IclFileHeader struct {
	// FileHeader ID
	ID string `json:"ID,omitempty"`
	// StandardLevel identifies the standard level of the file.  * `03` - DSTU X9.37-2003 * `30` - X9.100-187-2008 * `35` - X9.100-187-2013 and X9.100-187-2016
	StandardLevel string `json:"standardLevel"`
	// TestIndicator identifies whether the file is a test or production file.  * `T` - Test File * `P` - Production File
	TestIndicator string `json:"testIndicator,omitempty"`
	// ImmediateDestination is the routing and transit number of the Federal Reserve Bank (FRB) or receiver to which the file is being sent.
	ImmediateDestination string `json:"immediateDestination"`
	// ImmediateOrigin is the routing and transit number of the Federal Reserve Bank (FRB) or originator from which the file is being sent.
	ImmediateOrigin string `json:"immediateOrigin"`
	// FileCreationDate is the date the immediate origin institution creates the file.
	FileCreationDate time.Time `json:"fileCreationDate"`
	// FileCreationTime is the time the immediate origin institution creates the file.
	FileCreationTime time.Time `json:"fileCreationTime"`
	// ResendIndicator indicates whether the file has been previously transmitted. (Y - Yes, N - No)
	ResendIndicator string `json:"resendIndicator"`
	// ImmediateDestinationName identifies the short name of the institution that receives the file.
	ImmediateDestinationName string `json:"immediateDestinationName,omitempty"`
	// immediateOriginName identifies the short name of the institution that sends the file.
	ImmediateOriginName string `json:"immediateOriginName,omitempty"`
	// FileIDModifier is a code that permits multiple files, created on the same date, at the same time, and sent between the same institutions, to be distinguished from one another. If FileHeader ImmediateDestination, ImmediateOrigin, FileCreationDate, and FileCreationTime in a previous file are equal to the same fields in this file, FileIDModifier must be defined.
	FileIDModifier string `json:"fileIDModifier,omitempty"`
	// CountryCode is a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the payer bank is located.
	CountryCode string `json:"countryCode,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// CompanionDocumentIndicator indicates the Companion Document being used. It shall be present only under clearing arrangements, where Companion Document usage and values are defined. Values: * 0–9 - Reserved for United States use * A–J - Reserved for Canadian use * Other - Defined by clearing arrangements
	CompanionDocumentIndicator string `json:"companionDocumentIndicator,omitempty"`
}

IclFileHeader struct for IclFileHeader

type ImageCashLetterFilesApiService 

type ImageCashLetterFilesApiService service

ImageCashLetterFilesApiService ImageCashLetterFilesApi service

func (*ImageCashLetterFilesApiService) AddICLToFile 

func (a *ImageCashLetterFilesApiService) AddICLToFile(ctx _context.Context, fileID string, cashLetter CashLetter, localVarOptionals *AddICLToFileOpts) (*_nethttp.Response, error)

AddICLToFile Add cash letter to file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param cashLetter
  • @param optional nil or *AddICLToFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "XIdempotencyKey" (optional.String) - Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests.

func (*ImageCashLetterFilesApiService) CreateICLFile 

func (a *ImageCashLetterFilesApiService) CreateICLFile(ctx _context.Context, createIclFile CreateIclFile, localVarOptionals *CreateICLFileOpts) (IclFile, *_nethttp.Response, error)

CreateICLFile Create file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createIclFile Content of the ImageCashLetter file (in json or raw text)
  • @param optional nil or *CreateICLFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "XIdempotencyKey" (optional.String) - Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests.

@return IclFile

func (*ImageCashLetterFilesApiService) DeleteICLFile 

func (a *ImageCashLetterFilesApiService) DeleteICLFile(ctx _context.Context, fileID string, localVarOptionals *DeleteICLFileOpts) (*_nethttp.Response, error)

DeleteICLFile Delete file Permanently deletes a File and associated CashLetters and Bundles. It cannot be undone.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param optional nil or *DeleteICLFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*ImageCashLetterFilesApiService) DeleteICLFromFile 

func (a *ImageCashLetterFilesApiService) DeleteICLFromFile(ctx _context.Context, fileID string, cashLetterID string, localVarOptionals *DeleteICLFromFileOpts) (*_nethttp.Response, error)

DeleteICLFromFile Delete cash letter from file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param cashLetterID CashLetter ID
  • @param optional nil or *DeleteICLFromFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*ImageCashLetterFilesApiService) GetICLFileByID 

func (a *ImageCashLetterFilesApiService) GetICLFileByID(ctx _context.Context, fileID string, localVarOptionals *GetICLFileByIDOpts) (IclFile, *_nethttp.Response, error)

GetICLFileByID Retrieve file Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param optional nil or *GetICLFileByIDOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return IclFile

func (*ImageCashLetterFilesApiService) GetICLFileContents 

func (a *ImageCashLetterFilesApiService) GetICLFileContents(ctx _context.Context, fileID string, localVarOptionals *GetICLFileContentsOpts) (string, *_nethttp.Response, error)

GetICLFileContents Get file contents Assembles the existing file records (Cash Letters, Bundles, and Controls), computes sequence numbers and totals. Returns plaintext file.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param optional nil or *GetICLFileContentsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return string

func (*ImageCashLetterFilesApiService) GetICLFiles 

func (a *ImageCashLetterFilesApiService) GetICLFiles(ctx _context.Context, localVarOptionals *GetICLFilesOpts) ([]IclFile, *_nethttp.Response, error)

GetICLFiles List files

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetICLFilesOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return []IclFile

func (*ImageCashLetterFilesApiService) Ping added in v0.4.0 

func (a *ImageCashLetterFilesApiService) Ping(ctx _context.Context) (*_nethttp.Response, error)

Ping Ping ImageCashLetter service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*ImageCashLetterFilesApiService) UpdateICLFile 

func (a *ImageCashLetterFilesApiService) UpdateICLFile(ctx _context.Context, fileID string, iclFileHeader IclFileHeader, localVarOptionals *UpdateICLFileOpts) (IclFile, *_nethttp.Response, error)

UpdateICLFile Update file header Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param iclFileHeader
  • @param optional nil or *UpdateICLFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "XIdempotencyKey" (optional.String) - Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests.

@return IclFile

func (*ImageCashLetterFilesApiService) ValidateICLFile 

func (a *ImageCashLetterFilesApiService) ValidateICLFile(ctx _context.Context, fileID string, localVarOptionals *ValidateICLFileOpts) (IclFile, *_nethttp.Response, error)

ValidateICLFile Validate file Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileID File ID
  • @param optional nil or *ValidateICLFileOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return IclFile

type ImageViewAnalysis 

type ImageViewAnalysis struct {
	// ImageViewAnalysis ID
	ID string `json:"ID,omitempty"`
	// GlobalImageQuality is a code that indicates whether the image view was tested for any of the conditions related to image quality defined in the Image Quality Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	GlobalImageQuality int32 `json:"globalImageQuality,omitempty"`
	// GlobalImageUsability is a code that indicates whether the image view was tested for any of the conditions related to image usability defined in the Image Usability Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	GlobalImageUsability int32 `json:"globalImageUsability,omitempty"`
	// ImagingBankSpecificTest designates the capture institution may be able to perform specific tests that can indicate a potentially problematic image view caused by conditions other than those listed in the Image Quality and Image Usability Information fields. By mutual agreement, clearing partners can use the UserField to report the presence or absence of additional image conditions found through tests that are particular to the specific imaging institution. The meaning and interpretation of the User Field data must be understood and agreed upon between participants.   * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ImagingBankSpecificTest int32 `json:"imagingBankSpecificTest,omitempty"`
	// PartialImage is a code that indicates if only a portion of the image view is represented digitally while the other portion is suspected to be missing or corrupt.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PartialImage int32 `json:"partialImage,omitempty"`
	// ExcessiveImageSkew is a code that indicates if the image view skew exceeds an acceptable value. This value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ExcessiveImageSkew int32 `json:"excessiveImageSkew,omitempty"`
	// PiggybackImage is a code that indicates if a “piggyback” condition has been detected. With a “piggyback” condition, the intended image view may be extended, obscured, or replaced by image(s) of additional document(s). A piggyback occurs when two or more documents are fed together and captured as one document when only a single document should have been fed and captured.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PiggybackImage int32 `json:"piggybackImage,omitempty"`
	// TooLightOrTooDark is a code that indicates if the image view is too light or too dark. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	TooLightOrTooDark int32 `json:"tooLightOrTooDark,omitempty"`
	// StreaksAndOrBands is a A code that indicates if the image view is likely corrupted due to streaks and/or bands. Streaks and bands can be caused by such problems as dirt, dust, ink, or debris on a lens or in the optical path, and failures in the imaging equipment scanner.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	StreaksAndOrBands int32 `json:"streaksAndOrBands,omitempty"`
	// BelowMinimumImageSize is a code that indicates if the size of the compressed image view is below an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	BelowMinimumImageSize int32 `json:"belowMinimumImageSize,omitempty"`
	// ExceedsMaximumImageSize is a code that indicates if the size of the compressed image view is above an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ExceedsMaximumImageSize int32 `json:"exceedsMaximumImageSize,omitempty"`
	// ImageEnabledPOD is a code that indicates if the image view was used within an image-enabled POD (Proof of Deposit) application.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ImageEnabledPOD int32 `json:"imageEnabledPOD,omitempty"`
	// SourceDocumentBad is a code that indicates if it is possible to obtain a better image from the source document when it is known that the current image of the document is unusable.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	SourceDocumentBad int32 `json:"sourceDocumentBad,omitempty"`
	// DateUsability is a code that indicates if the date Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraint  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	DateUsability int32 `json:"dateUsability,omitempty"`
	// PayeeUsability is a code that indicates if the payee name Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayeeUsability int32 `json:"payeeUsability,omitempty"`
	// ConvenienceAmountUsability is a code that indicates if the convenience amount Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ConvenienceAmountUsability int32 `json:"convenienceAmountUsability,omitempty"`
	// AmountInWordsUsability is a code that indicates if the amount in words (legal amount) Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	AmountInWordsUsability int32 `json:"amountInWordsUsability,omitempty"`
	// SignatureUsability is a code that indicates if the signature Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	SignatureUsability int32 `json:"signatureUsability,omitempty"`
	// PayorNameAddressUsability is a code that indicates if the payor name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayorNameAddressUsability int32 `json:"payorNameAddressUsability,omitempty"`
	// MICRLineUsability is a code that indicates if the MICR line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	MICRLineUsability int32 `json:"mICRLineUsability,omitempty"`
	// MemoLineUsability is a code that indicates if the memo line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	MemoLineUsability int32 `json:"memoLineUsability,omitempty"`
	// PayorBankNameAddressUsability is a code that indicates if the payor bank name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayorBankNameAddressUsability int32 `json:"payorBankNameAddressUsability,omitempty"`
	// PayeeEndorsementUsability is a code that indicates if the payee endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayeeEndorsementUsability int32 `json:"payeeEndorsementUsability,omitempty"`
	// BOFDEndorsementUsability is a code that indicates if the Bank of First Deposit (BOFD) endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	BOFDEndorsementUsability int32 `json:"bOFDEndorsementUsability,omitempty"`
	// TransitEndorsementUsability is a code that indicates if the transit endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	TransitEndorsementUsability int32 `json:"transitEndorsementUsability,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

ImageViewAnalysis struct for ImageViewAnalysis

type ImageViewData 

type ImageViewData struct {
	// ImageViewData ID
	ID string `json:"ID,omitempty"`
	// ECEInstitutionRoutingNumber contains the routing and transit number of the institution that creates the bundle header.  This number is imported from the Bundle Header Record (Clause 9.4) associated with the image view conveyed in this Image View Data Property.
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// BundleBusinessDate is the business date of the bundle.
	BundleBusinessDate time.Time `json:"bundleBusinessDate,omitempty"`
	// CycleNumber is a code assigned by the institution that creates the bundle.  Denotes the cycle under which the bundle is created.
	CycleNumber string `json:"cycleNumber,omitempty"`
	// ECEInstitutionItemSequenceNumber is a number assigned by the institution that creates the Check or Return.  This number is imported from the Check.ECEInstitutionItemSequenceNumber or Return.ECEInstitutionItemSequenceNumber associated with the image view conveyed in this Image View Data Record. The ECE institution must construct the sequence number to guarantee uniqueness for a given routing number, business day, and cycle number. Must contain a numeric value.
	IvDataECEInstitutionItemSequenceNumber string `json:"ivData.ECEInstitutionItemSequenceNumber,omitempty"`
	// SecurityOriginatorName is a unique name that creates the Digital Signature for data to be exchanged. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityOriginatorName string `json:"ivData.SecurityOriginatorName,omitempty"`
	// SecurityAuthenticatorName is the unique name that performs authentication on received data. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityAuthenticatorName string `json:"ivData.SecurityAuthenticatorName,omitempty"`
	// SecurityKeyName is a name or character sequence used by the signer (originator) to communicate a key identifierto the recipient (authenticator) so the recipient can obtain the key needed to validate the signature. The name is typically used as an identifier related to the key pair used to sign the image. The name is mutually known to the security originator and the security authenticator and is unique to this relationship. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityKeyName string `json:"ivData.SecurityKeyName,omitempty"`
	// ClippingOrigin is a code that defines the corner of the conveyed image view that is taken as the reference point for the clipping coordinates. Top, bottom, left, and right references apply to a view that presents a visually correct orientation. When clipping information is present, the nature of the Area of Interest defined by the clipping rectangle is determined by the value of the ImageViewDetail.ViewDescriptor. Primary front and rear views shall only have a Defined Value of 0.  Can be blank.  * `0` - Clipping information is not present–full view present * `1` - Clipping origin is top left corner of image view * `2` - Clipping origin is top right corner of image view * `3` - Clipping origin is bottom right corner of image view * `4` - Clipping origin is bottom left corner of image view
	IvDataClippingOrigin int32 `json:"ivData.ClippingOrigin,omitempty"`
	// ClippingCoordinateH1 is a number that represents the horizontal offset in pixels from the clipping origin to the nearest vertical side of the clipping rectangle. The clipping coordinates (h1, h2, v1, v2) convey the clipping rectangle’s offsets in both horizontal (h) and vertical (v) directions. The offset values collectively establish the boundary sides of the clipping rectangle. Pixels on the boundary of the clipping rectangle are included in the selected array of pixels. That is, the first pixel of the selected array is at offset (h1, v1) and the last pixel of the selected array is at offset (h2, v2). The corner pixel at the origin of the image view is assumed to have the offset value (0, 0). Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateH1 string `json:"ivData.ClippingCoordinateH1,omitempty"`
	// ClippingCoordinateH2 is a number that represents the horizontal offset in pixels from the clipping origin to the furthermost vertical side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateH2 string `json:"ivData.ClippingCoordinateH2,omitempty"`
	// ClippingCoordinateV1 is a number that represents the vertical offset in pixels from the clipping origin to the nearest horizontal side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateV1 string `json:"ivData.ClippingCoordinateV1,omitempty"`
	// ClippingCoordinateV2 is a number that represents the vertical offset in pixels from the clipping origin to the furthermost horizontal side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateV2 string `json:"ivData.ClippingCoordinateV2,omitempty"`
	// LengthImageReferenceKey is the number of characters in the ImageViewData.ImageReferenceKey. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000 ImageReferenceKey is not present 0001–9999  Valid when ImageReferenceKey is present
	IvDataLengthImageReferenceKey string `json:"ivData.LengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is assigned by the ECE institution that creates the CheckDetail or Return, and the related Image View Records. This designator, when used, shall uniquely identify the item image to the ECE institution. This designator is a special key with significance to the creating institution. It is intended to be used to locate within an archive the unique image associated with the item. The designator could be a full access path and name that would allow direct look up and access to the image, for example a URL. This shall match CheckDetailAddendumB.ImageReferenceKey, or ReturnAddendumCImageReferenceKey Record, if used. Valid size - 0 – 9999
	IvDataImageReferenceKey string `json:"ivData.ImageReferenceKey,omitempty"`
	// LengthDigitalSignature is the number of bytes in the Image View Data.DigitalSignature. Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataLengthDigitalSignature string `json:"ivData.LengthDigitalSignature,omitempty"`
	// DigitalSignature is created by applying the cryptographic algorithm and private/secret key against the data to be protected. The Digital Signature provides user authentication and data integrity. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid size - 0-99999
	IvDataDigitalSignature string `json:"ivData.DigitalSignature,omitempty"`
	// LengthImageData is the number of bytes in the ImageViewData.ImageData. Shall be present when ImageViewDetail.ImageIndicator is NOT 0 Valid values - 0000001–99999999
	IvDataLengthImageData string `json:"ivData.LengthImageData,omitempty"`
	// ImageData contains the image view. The Image Data generally consists of an image header and the image raster data. The image header provides information that is required to interpret the image raster data. The image raster data contains the scanned image of the physical item in raster (line by line) format. Each scan line comprises a set of concatenated pixels. The image comprises a set of scan lines. The image raster data is typically compressed to reduce the number of bytes needed to transmit and store the image. The header/image format type is defined by the ImageViewDetail.ImageViewFormatIndicator. The syntax and semantics of the image header/image format are understood by referring to the appropriate image format specification. The compression scheme used to compress the image raster data is specified in the ImageViewCompressionAlgorithmIdentifier and in the image header portion of the Image Data or by association with the selected image format. The data may be provided in standard Base64 encoding and will be decoded on file generation. Shall be present when ImageViewDetail.ImageIndicator Record is NOT 0. Valid size - 0-9999999
	IvDataImageData string `json:"ivData.ImageData,omitempty"`
}

ImageViewData struct for ImageViewData

type ImageViewDetail 

type ImageViewDetail struct {
	// ImageViewDetail ID
	ID string `json:"ID,omitempty"`
	// ImageIndicator is a code that indicates the presence and disposition of an image view conveyed in the related ImageViewData.  When an image view is not present (0) then certain conditional fields in this ImageViewDetail and the related ImageViewData shall not be present and will be filled with blank space.  * `0` - Image view not present * `1` - Image view present, actual check * `2` - Image view present, not actual check * `3` - Image view present, unable to determine if value is 1 or 2
	ImageIndicator int32 `json:"imageIndicator,omitempty"`
	// ImageCreatorRoutingNumber identifies the financial institution that created the image view.
	ImageCreatorRoutingNumber string `json:"imageCreatorRoutingNumber,omitempty"`
	// ImageCreatorDate is the date assigned by the image creator for the image view conveyed in the related ImageData.
	ImageCreatorDate time.Time `json:"imageCreatorDate,omitempty"`
	// ImageViewFormatIndicator is a code that identifies the type of image format used in the related ImageViewData.ImageData. The image format type is also commonly specified by reference to the file extension used when image data is saved as an image file.  Agreement not required: * `00` - TIFF 6; Extension: TIF  Agreement required: * `01` - IOCA FS 11; Extension: ICA * `20` - PNG (Portable Network Graphics); Extension: PNG ‘21’ JFIF (JPEG File Interchange Format); Extension: JPG * `22` - SPIFF (Still Picture Interchange File Format) (ITU-T Rec. T.84 Annex F); Extension: SPF * `23` - JBIG data stream (ITU-T Rec. T.82/ISO/IEC 11544:1993); Extension: JBG ‘24’ JPEG 2000 (ISO/IEC 15444-1:2000); Extension: JP2
	ImageViewFormatIndicator string `json:"imageViewFormatIndicator,omitempty"`
	// ImageViewCompressionAlgorithm is a code that identifies the algorithm or method used to compress the Image Data in the related ImageViewData.ImageData.  Agreement not required: * `00` - Group 4 facsimile compression (ITU-T Rec. T.563/CCITT Rec. T.6)  Agreement required: * `01` - JPEG Baseline (JPEG Interchange Format) (ITU-T Rec. T.81/ISO/IEC 10918) * `02` - ABIC * `21` - PNG (Portable Network Graphics) * `22` - JBIG (ITU-T Rec. T.82/ISO/IEC 11544:1993) * `23` - JPEG 2000 (ISO/IEC 15444–1:2000)
	ImageViewCompressionAlgorithm string `json:"imageViewCompressionAlgorithm,omitempty"`
	// ImageViewDataSize is the total number of bytes in ImageViewData.ImageData.  Use of this field is NOT recommended. If data is present it shall be ignored, and ImageViewData.ImageDataLength shall take precedence.
	ImageViewDataSize string `json:"imageViewDataSize,omitempty"`
	// ViewSideIndicator is a code that indicates the image view conveyed in the related ImageViewData. An image view may be a full view of the item (i.e., the entire full face of the document) or may be a partial view (snippet) as determined by viewDescriptor.  * `0` - Front image view * `1` - Rear image view
	ViewSideIndicator int32 `json:"viewSideIndicator,omitempty"`
	// ViewDescriptor is a code that indicates the nature of the image view based on ImageViewData.ImageData.  * `00` -  Full view * `01` -  Partial view–unspecified Area of Interest * `02` -  Partial view–date Area of Interest * `03` -  Partial view–payee Area of Interest * `04` -  Partial view–convenience amount Area of Interest * `05` -  Partial view–amount in words (legal amount) Area of Interest * `06` -  Partial view–signature Area(s) of Interest * `07` -  Partial view–payor name and address Area of Interest * `08` -  Partial view–MICR line Area of Interest * `09` -  Partial view–memo line Area of Interest * `10` -  Partial view–payor bank name and address Area of Interest * `11` -  Partial view–payee endorsement Area of Interest * `12` -  Partial view–Bank Of First Deposit (BOFD) endorsement Area of Interest * `13` -  Partial view–transit endorsement Area of Interest * `14 - 99` -  Reserved for X9
	ViewDescriptor string `json:"viewDescriptor,omitempty"`
	// DigitalSignatureIndicator is a code that indicates the presence or absence of a digital signature for the image view contained in ImageViewData.ImageData. If present, the Digital Signature is conveyed in the related DigitalSignature.  * `0` - Digital Signature is not present * `1` - Digital Signature is present
	DigitalSignatureIndicator int32 `json:"digitalSignatureIndicator,omitempty"`
	// DigitalSignatureMethod is a code that identifies the cryptographic algorithm used to generate and validate the Digital Signature in ImageViewData.DigitalSignature. * `00` - Digital Signature Algorithm (DSA) with SHA1 (ANSI X9.30) * `01` - RSA with MD5 (ANSI X9.31) * `02` - RSA with MDC2 (ANSI X9.31) * `03` - RSA with SHA1 (ANSI X9.31) * `04` - Elliptic Curve DSA (ECDSA) with SHA1 (ANSI X9.62) * `05 - 99` - Reserved for emerging cryptographic algorithms.
	DigitalSignatureMethod string `json:"digitalSignatureMethod,omitempty"`
	// SecurityKeySize is the length in bits of the cryptographic algorithm key used to create the Digital Signature. Valid values 0–99999
	SecurityKeySize int32 `json:"securityKeySize,omitempty"`
	// ProtectedDataStart is a number that represents the offset in bytes from the first byte (counted as byte 1) of the image data in ImageViewData.ImageData to the first byte of the image data protected by the digital signature.  * 0000000 - Digital Signature is applied to entire image data * 000001–9999999 - Valid offset values
	ProtectedDataStart int32 `json:"protectedDataStart,omitempty"`
	// ProtectedDataLength is a number of contiguous bytes of image data in the related ImageViewData.ImageData protected by the digital signature starting with the byte indicated by the value of the ProtectedDataStart in this ImageViewDetail. The ProtectedDataLength value shall not exceed the ImageViewData.ImageDataLength.  * 0000000 - Digital Signature is applied to entire image data * 000001–9999999 - Valid length values
	ProtectedDataLength int32 `json:"protectedDataLength,omitempty"`
	// ImageRecreateIndicator is a code that indicates whether the sender has the ability to recreate the image view conveyed in the related ImageViewData.ImageData.  * `0` - Sender can recreate the image view for the duration of the agreed upon retention time frames. * `1` - Sender cannot recreate image view.
	ImageRecreateIndicator int32 `json:"imageRecreateIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// OverrideIndicator is a code that indicates to a receiving exchange partner that this image view has a detected image test failure that cannot be corrected and that this view shall be accepted regardless of any image test failures.  * ` ` -  blank/space indicates no observed image test failure present * `0` -  No override information for this view or not applicable * `1` -  Imperfect image * `A` -  IQA Fail–Image view reviewed and deemed usable—no alternate format * `B` -  IQA Fail–Image view reviewed and deemed usable—alternate format included in this file * `C` -  IQA Fail–Image view reviewed and deemed usable–alternate format included in this file and original document available * `D` -  IQA Fail–Image view reviewed and deemed usable–alternate format available * `E` -  IQA Fail–Image view reviewed and deemed usable–original document available * `F` -  IQA Fail–Image view reviewed and deemed usable–original document and alternate format available * `G` -  IQA Fail–Image view reviewed and deemed unusable–no alternate format * `H` -  IQA Fail–Image view reviewed and deemed unusable–alternate format included in this file * `I` -  IQA Fail–Image view reviewed and deemed unusable–alternate format included in this file and original document available * `J` -  IQA Fail–Image view reviewed and deemed unusable–alternate format available * `K` -  IQA Fail–Image view reviewed and deemed unusable–original document available * `L` -  IQA Fail–Image view reviewed and deemed unusable–original document and alternate format available * `M` -  IQA Fail–Image view not reviewed–no alternate format * `N` -  IQA Fail–Image view not reviewed–alternate format included in this file * `O` -  IQA Fail–Image view not reviewed–alternate format included in this file and original
	OverrideIndicator string `json:"overrideIndicator,omitempty"`
}

ImageViewDetail struct for ImageViewDetail

type ReturnDetailAddendumA 

type ReturnDetailAddendumA struct {
	// ReturnDetailAddendumA ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each ReturnDetailAddendumA was created. ReturnDetailAddendumA shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// ReturnLocationRoutingNumber is a valid routing and transit number indicating where returns, final return notifications, and preliminary return notifications are sent, usually the BOFD.
	ReturnLocationRoutingNumber string `json:"returnLocationRoutingNumber"`
	// BOFDEndorsementDate is the date of endorsement.
	BOFDEndorsementDate time.Time `json:"bOFDEndorsementDate,omitempty"`
	// BOFDItemSequenceNumber is a number that identifies the item in the CheckDetailAddendumA.
	BOFDItemSequenceNumber string `json:"bOFDItemSequenceNumber,omitempty"`
	// BOFDAccountNumber is a number that identifies the depository account at the Bank of First Deposit.
	BOFDAccountNumber string `json:"bOFDAccountNumber,omitempty"`
	// BOFDBranchCode is a code that identifies the branch at the Bank of First Deposit.
	BOFDBranchCode string `json:"bOFDBranchCode,omitempty"`
	// PayeeName is the name of the payee from the check.
	PayeeName string `json:"payeeName,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// BOFDConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of the institution that created this record.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	BOFDConversionIndicator string `json:"bOFDConversionIndicator,omitempty"`
	// BOFDCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumA Record for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	BOFDCorrectionIndicator int32 `json:"BOFDCorrectionIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

ReturnDetailAddendumA struct for ReturnDetailAddendumA

type ReturnDetailAddendumB 

type ReturnDetailAddendumB struct {
	// ReturnDetailAddendumB ID
	ID string `json:"ID,omitempty"`
	// PayorBankName is short name of the institution by or through which the item is payable.
	PayorBankName string `json:"payorBankName,omitempty"`
	// AuxiliaryOnUs identifies a code used on commercial checks at the discretion of the payor bank.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// PayorBankSequenceNumber is a number that identifies the item at the payor bank.
	PayorBankSequenceNumber string `json:"payorBankSequenceNumber,omitempty"`
	// PayorBankBusinessDate is the year, month, and day the payor bank processed the Return Record.
	PayorBankBusinessDate time.Time `json:"payorBankBusinessDate,omitempty"`
	// PayorAccountName is the account name from payor bank records.
	PayorAccountName string `json:"payorAccountName,omitempty"`
}

ReturnDetailAddendumB struct for ReturnDetailAddendumB

type ReturnDetailAddendumC 

type ReturnDetailAddendumC struct {
	// ReturnDetailAddendumC ID
	ID string `json:"ID,omitempty"`
	// ImageReferenceKeyIndicator identifies whether ImageReferenceKeyLength contains a variable value within the allowable range, or contains a defined value and the content is ItemReferenceKey.  * `0` - ImageReferenceKeyIndicator has a Defined Value of 0034 and ImageReferenceKey contains the Image Reference Key. * `1`- ImageReferenceKeyIndicator contains a value other than 0034; or ImageReferenceKeyIndicator contains Value 0034, which is not a Defined Value, and the content of ImageReferenceKey has no special significance with regards to an Image Reference Key; or ImageReferenceKeyIndicator is 0000, meaning the ImageReferenceKey is not present.
	ImageReferenceKeyIndicator int32 `json:"imageReferenceKeyIndicator,omitempty"`
	// microfilmArchiveSequenceNumber is a number that identifies the item in the microfilm archive system; it may be different than the Check.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.
	MicrofilmArchiveSequenceNumber string `json:"microfilmArchiveSequenceNumber,omitempty"`
	// ImageReferenceKeyLength is the number of characters in the ImageReferenceKey.  * `0034` - ImageReferenceKey contains the ImageReferenceKey (ImageReferenceKeyIndicator is 0). * `0000` - ImageReferenceKey not present (ImageReferenceKeyIndicator is 1). * `0001` - 9999: May include Value 0034, and ImageReferenceKey has no special significance to Image Reference Key (ImageReferenceKey is 1).
	LengthImageReferenceKey string `json:"lengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is used to find the image of the item in the image data system.  Size is variable based on lengthImageReferenceKey. The position within the file is variable based on the lengthImageReferenceKey.
	ImageReferenceKey string `json:"imageReferenceKey,omitempty"`
	// Descript describes the transaction.  The position within the file is variable based on the lengthImageReferenceKey.
	Descript string `json:"descript,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

ReturnDetailAddendumC struct for ReturnDetailAddendumC

type ReturnDetailAddendumD 

type ReturnDetailAddendumD struct {
	// ReturnDetailAddendumD ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each ReturnDetailAddendumD was created. ReturnDetailAddendumD shall be in sequential order starting with 1.  Maximum 99.
	RecordNumber int32 `json:"recordNumber,omitempty"`
	// EndorsingBankRoutingNumber is a valid routing and transit number indicating the bank that endorsed the check.
	EndorsingBankRoutingNumber string `json:"endorsingBankRoutingNumber"`
	// BOFDEndorsementBusinessDate is the date of endorsement.
	BOFDEndorsementBusinessDate time.Time `json:"bOFDEndorsementBusinessDate"`
	// EndorsingItemSequenceNumber is a number that identifies the item at the endorsing bank.
	EndorsingBankSequenceNumber string `json:"endorsingBankSequenceNumber,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// EndorsingBankConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of the institution identified in the EndorsingBankRoutingNumber.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	EndorsingBankConversionIndicator string `json:"endorsingBankConversionIndicator,omitempty"`
	// EndorsingBankCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumC Record for fields other than Payor Bank Routing Number and Amount.  * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	EndorsingBankCorrectionIndicator int32 `json:"endorsingBankCorrectionIndicator,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// * `0` - Depository Bank (BOFD) - this value is used when the CheckDetailAddendumC Record reflects the Return * `Processing Bank in lieu of BOFD. * `1` - Other Collecting Bank * `2` - Other Returning Bank * `3` - Payor Bank
	EndorsingBankIdentifier int32 `json:"endorsingBankIdentifier,omitempty"`
}

ReturnDetailAddendumD struct for ReturnDetailAddendumD

type Returns 

type Returns struct {
	// Return ID
	ID string `json:"ID,omitempty"`
	// PayorBankRoutingNumber identifies the institution by or through which the item is payable. Must be a valid routing and transit number issued by the ABA’s Routing Number Registrar. Shall represent the first 8 digits of a 9-digit routing number or 8 numeric digits of a 4 dash 4 routing number. A valid routing number consists of 2 fields: the eight-digit Payor Bank Routing Number and the one-digit Payor Bank Routing Number Check Digit.
	PayorBankRoutingNumber string `json:"payorBankRoutingNumber,omitempty"`
	// PayorBankCheckDigit identifies the routing number check digit.  The combination of Payor Bank Routing Number and Payor Bank Routing Number Check Digit must be a mod-checked routing number with a valid check digit.
	PayorBankCheckDigit string `json:"payorBankCheckDigit,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00.
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// AddendumCount is a number of Check Detail Record Addenda to follow. This represents the number of CheckDetailAddendumA, CheckDetailAddendumB, and CheckDetailAddendumC types. It matches the total number of addendum records associated with this item. The standard supports up to 99 addendum records.
	AddendumCount int32 `json:"addendumCount,omitempty"`
	// DocumentationTypeIndicator identifies a code that indicates the type of documentation that supports the check record.  This field is superseded by the Cash Letter Documentation Type Indicator in the Cash Letter Header Record for all Defined Values except ‘Z’ Not Same Type. In the case of Defined Value of ‘Z’, the Documentation Type Indicator in this record takes precedent.  Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// ForwardBundleDate represents for electronic check exchange items, the year, month, and day that designate the business date of the original forward bundle. This data is transferred from the BundleHeader BundleBusinessDate.  For items presented in paper cash letters, the year, month, and day that the cash letter was created.
	ForwardBundleDate time.Time `json:"forwardBundleDate,omitempty"`
	// ECEInstitutionItemSequenceNumber identifies a number assigned by the institution that creates the CheckDetail. Field must contain a numeric value. It cannot be all blanks.
	ECEInstitutionItemSequenceNumber string `json:"eCEInstitutionItemSequenceNumber,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// ReturnNotificationIndicator is a code that identifies the type of notification. The CashLetterHeader.CollectionTypeIndicator and BundleHeader.CollectionTypeIndicator equalling `05` or `06` takes precedence over this field.  * `1` - Preliminary notification * `2` - Final notification
	ReturnNotificationIndicator string `json:"returnNotificationIndicator,omitempty"`
	// ArchiveTypeIndicator is a code that indicates the type of archive that supports this Check. Access method, availability, and time frames shall be defined by clearing arrangements. * `A` - Microfilm * `B` - Image * `C` - Paper * `D` - Microfilm and image * `E` - Microfilm and paper * `F` - Image and paper * `G` - Microfilm, image, and paper * `H` - Electronic Check Instrument * `I` - None
	ArchiveTypeIndicator string `json:"archiveTypeIndicator,omitempty"`
	// TimesReturned is a code used to indicate the number of times the paying bank has returned this item.  * `0` - The item has been returned an unknown number of times * `1` - The item has been returned once * `2` - The item has been returned twice * `3` - The item has been returned three times
	TimesReturned         int32                   `json:"timesReturned,omitempty"`
	ReturnDetailAddendumA []ReturnDetailAddendumA `json:"returnDetailAddendumA,omitempty"`
	ReturnDetailAddendumB []ReturnDetailAddendumB `json:"returnDetailAddendumB,omitempty"`
	ReturnDetailAddendumC []ReturnDetailAddendumC `json:"returnDetailAddendumC,omitempty"`
	ReturnDetailAddendumD []ReturnDetailAddendumD `json:"returnDetailAddendumD,omitempty"`
	ImageViewDetail       []ImageViewDetail       `json:"imageViewDetail,omitempty"`
	ImageViewData         []ImageViewData         `json:"imageViewData,omitempty"`
	ImageViewAnalysis     []ImageViewAnalysis     `json:"imageViewAnalysis,omitempty"`
}

Returns struct for Returns

type RoutingNumberSummary 

type RoutingNumberSummary struct {
	// RoutingNumberSummary ID
	ID string `json:"ID,omitempty"`
	// CashLetterRoutingNumber is a number that identifies a given payor bank within a cash letter containing one or more payor banks.
	CashLetterRoutingNumber string `json:"cashLetterRoutingNumber"`
	// RoutingNumberTotalAmount is the total amount for all Check Records associated with the payor bank routing number designated in the Routing Number within the Cash Letter.
	RoutingNumberTotalAmount int32 `json:"routingNumberTotalAmount,omitempty"`
	// RoutingNumberItemCount is the the total number of all Check Records associated with the payor bank routing number designated in the Routing Number within the Cash Letter.
	RoutingNumberItemCount int32 `json:"routingNumberItemCount,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

RoutingNumberSummary struct for RoutingNumberSummary

type UpdateICLFileOpts 

type UpdateICLFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

UpdateICLFileOpts Optional parameters for the method 'UpdateICLFile'

type ValidateICLFileOpts 

type ValidateICLFileOpts struct {
	XRequestID optional.String
}

ValidateICLFileOpts Optional parameters for the method 'ValidateICLFile'

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.