models

Documentation

Index

• func ReadEvent(data []byte, evt interface{}) error
• type AESConfig
  • func (cfg *AESConfig) MarshalJSON() ([]byte, error)
• type Batch
• type CancelACHFile
• type CorrectionFile
  • func (evt *CorrectionFile) SetValidation(opts *ach.ValidateOpts)
• type EncodingConfig
• type EncryptionConfig
• type Event
  • func Read(data []byte) (*Event, error)
  • func (evt Event) Bytes() []byte
  • func (evt Event) MarshalJSON() ([]byte, error)
• type FileUploaded
• type IncomingFile
  • func (evt *IncomingFile) SetValidation(opts *ach.ValidateOpts)
• type PrenoteFile
  • func (evt *PrenoteFile) SetValidation(opts *ach.ValidateOpts)
• type QueueACHFile
  • func (evt *QueueACHFile) SetValidation(opts *ach.ValidateOpts)
• type ReconciliationFile
  • func (evt *ReconciliationFile) SetValidation(opts *ach.ValidateOpts)
• type ReturnFile
  • func (evt *ReturnFile) SetValidation(opts *ach.ValidateOpts)
• type TransformConfig

Functions

func ReadEvent

func ReadEvent(data []byte, evt interface{}) error

ReadEvent will unmarshal the event, but assumes the event type is known by the caller.

Types

type AESConfig

type AESConfig struct {
	Key string
}

func (*AESConfig) MarshalJSON

func (cfg *AESConfig) MarshalJSON() ([]byte, error)

type Batch

type Batch struct {
	Header  *ach.BatchHeader   `json:"batchHeader"`
	Entries []*ach.EntryDetail `json:"entryDetails"`
}

type CancelACHFile

type CancelACHFile incoming.CancelACHFile

CancelACHFile is an event that achgateway receives to cancel uploading a file to the ODFI.

type CorrectionFile

type CorrectionFile struct {
	Filename    string    `json:"filename"`
	File        *ach.File `json:"file"`
	Corrections []Batch   `json:"corrections"`
}

CorrectionFile is an event for when an Addenda98 record is found within a file from the ODFI. This is also called a "Notification of Change" (NOC).

func (*CorrectionFile) SetValidation

func (evt *CorrectionFile) SetValidation(opts *ach.ValidateOpts)

type EncodingConfig

type EncodingConfig struct {
	Base64 bool
}

type EncryptionConfig

type EncryptionConfig struct {
	AES *AESConfig
}

type Event

type Event struct {
	Event interface{} `json:"event"`
	Type  string      `json:"type"`
}

func Read

func Read(data []byte) (*Event, error)

Read will unmarshal an event and return the wrapper for it.

func (Event) Bytes

func (evt Event) Bytes() []byte

func (Event) MarshalJSON

func (evt Event) MarshalJSON() ([]byte, error)

type FileUploaded

type FileUploaded struct {
	FileID     string    `json:"fileID"`
	ShardKey   string    `json:"shardKey"`
	Filename   string    `json:"filename"`
	UploadedAt time.Time `json:"uploadedAt"`
}

FileUploaded is an event sent after a queued file has been uploaded to the ODFI. The entries and batches may have been merged into a larger file to optimize on cost, network performance, or other configuration.

type IncomingFile

type IncomingFile struct {
	Filename string    `json:"filename"`
	File     *ach.File `json:"file"`
}

IncomingFile is an event for when an ODFI receives an ACH file from another FI signifying entries to process (e.g. another FI is debiting your account).

func (*IncomingFile) SetValidation

func (evt *IncomingFile) SetValidation(opts *ach.ValidateOpts)

type PrenoteFile

type PrenoteFile struct {
	Filename string    `json:"filename"`
	File     *ach.File `json:"file"`
	Batches  []Batch   `json:"batches"`
}

PrenoteFile is an event for when an ODFI receives a "pre-notification" ACH file. This type of file is used to validate accounts exist and are usable for ACH.

func (*PrenoteFile) SetValidation

func (evt *PrenoteFile) SetValidation(opts *ach.ValidateOpts)

type QueueACHFile

type QueueACHFile incoming.ACHFile

QueueACHFile is an event that achgateway receives to enqueue an ACH file for upload to the ODFI at a later cutoff time.

func (*QueueACHFile) SetValidation

func (evt *QueueACHFile) SetValidation(opts *ach.ValidateOpts)

type ReconciliationFile

type ReconciliationFile struct {
	Filename        string    `json:"filename"`
	File            *ach.File `json:"file"`
	Reconciliations []Batch   `json:"reconciliations"`
}

ReconciliationFile is a file whose entries match entries initiated with the ODFI.

func (*ReconciliationFile) SetValidation

func (evt *ReconciliationFile) SetValidation(opts *ach.ValidateOpts)

type ReturnFile

type ReturnFile struct {
	Filename string    `json:"filename"`
	File     *ach.File `json:"file"`
	Returns  []Batch   `json:"returns"`
}

ReturnFile is an event for when an Addenda99 record is found within a file from the ODFI. This is also called a "return".

func (*ReturnFile) SetValidation

func (evt *ReturnFile) SetValidation(opts *ach.ValidateOpts)

type TransformConfig

type TransformConfig struct {
	Encoding   *EncodingConfig
	Encryption *EncryptionConfig
}