Class: Nacha::Record::XckEntryDetail

Inherits:

Base

• Object
• Base
• Nacha::Record::XckEntryDetail

Includes:

DetailRecordType

Defined in:

lib/nacha/record/xck_entry_detail.rb

Overview

Represents a Destroyed Check Entry (XCK) detail record.

Instance Attribute Summary

• #addenda_record_indicator ⇒ Nacha::Numeric

  Indicates if an addenda record is present.

• #amount ⇒ Nacha::Numeric

  The amount of the destroyed check.

• #check_serial_number ⇒ String

  The serial number of the destroyed check.

• #dfi_account_number ⇒ String

  The account number to be credited or debited.

• #discretionary_data ⇒ String

  An optional field for the Originator’s use.

• #item_research_number ⇒ String

  A number used for research purposes.

• #process_control_field ⇒ String

  A field containing information from the check’s MICR line.

• #receiving_dfi_identification ⇒ Nacha::AbaNumber

  The routing number of the financial institution receiving the entry.

• #record_type_code ⇒ String

  Identifies the record as an XCK Entry Detail record with a constant value of ‘6’.

• #trace_number ⇒ Nacha::Numeric

  A unique number assigned by the ODFI to trace the entry.

• #transaction_code ⇒ Nacha::Numeric

  Defines the type of account and transaction.

Attributes inherited from Base

#children, #fields, #line_number, #name, #original_input_line, #parent, #validations

Method Summary

Methods included from DetailRecordType

#child_record_types, included, #next_record_types

Methods inherited from Base

#add_error, #create_fields_from_definition, #credit?, #debit?, definition, #definition, #errors, #human_name, #initialize, #inspect, matcher, #method_missing, nacha_field, parse, #record_type, record_type, #respond_to_missing?, #to_ach, #to_h, to_h, #to_html, to_json, #to_json, unpack_str, #valid?, #validate, validations

Methods included from Validations::FieldValidations

included

Constructor Details

This class inherits a constructor from Nacha::Record::Base

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Nacha::Record::Base

Instance Attribute Details

#addenda_record_indicator ⇒ Nacha::Numeric

Returns Indicates if an addenda record is present.

Returns:

• (Nacha::Numeric) —

  Indicates if an addenda record is present.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#amount ⇒ Nacha::Numeric

Returns The amount of the destroyed check.

Returns:

• (Nacha::Numeric) —

  The amount of the destroyed check.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#check_serial_number ⇒ String

Returns The serial number of the destroyed check.

Returns:

• (String) —

  The serial number of the destroyed check.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#dfi_account_number ⇒ String

Returns The account number to be credited or debited.

Returns:

• (String) —

  The account number to be credited or debited.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#discretionary_data ⇒ String

Returns An optional field for the Originator’s use.

Returns:

• (String) —

  An optional field for the Originator’s use.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#item_research_number ⇒ String

Returns A number used for research purposes.

Returns:

• (String) —

  A number used for research purposes.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#process_control_field ⇒ String

Returns A field containing information from the check’s MICR line.

Returns:

• (String) —

  A field containing information from the check’s MICR line.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#receiving_dfi_identification ⇒ Nacha::AbaNumber

Returns The routing number of the financial institution receiving the entry.

Returns:

• (Nacha::AbaNumber) —

  The routing number of the financial institution receiving the entry.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#record_type_code ⇒ String

Returns Identifies the record as an XCK Entry Detail record with a constant value of ‘6’.

Returns:

• (String) —

  Identifies the record as an XCK Entry Detail record with a constant value of ‘6’.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#trace_number ⇒ Nacha::Numeric

Returns A unique number assigned by the ODFI to trace the entry.

Returns:

• (Nacha::Numeric) —

  A unique number assigned by the ODFI to trace the entry.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end

#transaction_code ⇒ Nacha::Numeric

Returns Defines the type of account and transaction.

Returns:

• (Nacha::Numeric) —

  Defines the type of account and transaction.

# File 'lib/nacha/record/xck_entry_detail.rb', line 32

class XckEntryDetail < Nacha::Record::Base
  include DetailRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
  nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
  nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
  nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
  nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
  nacha_field :check_serial_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
  nacha_field :process_control_field, inclusion: 'M', contents: 'Alphameric', position: 55..60
  nacha_field :item_research_number, inclusion: 'R', contents: 'Alphameric', position: 61..76
  nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
  nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
  nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
end