Class: Nacha::Record::AckEntryDetail

Inherits:
Base
  • Object
show all
Includes:
DetailRecordType
Defined in:
lib/nacha/record/ack_entry_detail.rb

Instance Attribute Summary collapse

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 A code indicating whether an addenda record follows, ‘1’ for yes and ‘0’ for no.

Returns:

  • (Nacha::Numeric) —

    A code indicating whether an addenda record follows, ‘1’ for yes and ‘0’ for no.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 entry being acknowledged, which is always zero for ACK entries.

Returns:

  • (Nacha::Numeric) —

    The amount of the entry being acknowledged, which is always zero for ACK entries.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 DFI account number of the receiver from the original entry detail record.

Returns:

  • (String) —

    The DFI account number of the receiver from the original entry detail record.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 Optional data field which can be used by the ODFI or Originator for their own purposes.

Returns:

  • (String) —

    Optional data field which can be used by the ODFI or Originator for their own purposes.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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

#originl_entry_trace_number ⇒ Nacha::Numeric

Returns The trace number from the original Entry Detail Record to which this acknowledgment applies.

Returns:

  • (Nacha::Numeric) —

    The trace number from the original Entry Detail Record to which this acknowledgment applies.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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_company_name ⇒ String

Returns The name of the receiver from the original entry detail record.

Returns:

  • (String) —

    The name of the receiver from the original entry detail record.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 that is to receive the acknowledgement.

Returns:

  • (Nacha::AbaNumber) —

    The routing number of the financial institution that is to receive the acknowledgement.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 ACK Entry Detail record with a constant value of ‘6’.

Returns:

  • (String) —

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 this specific acknowledgement entry.

Returns:

  • (Nacha::Numeric) —

    A unique number assigned by the ODFI to this specific acknowledgement entry.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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 Identifies the transaction as an acknowledgment for a received credit entry.

Returns:

  • (Nacha::Numeric) —

    Identifies the transaction as an acknowledgment for a received credit entry.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nacha/record/ack_entry_detail.rb', line 29

class AckEntryDetail < 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 :originl_entry_trace_number,
    inclusion: 'M', contents: 'Numeric', position: 40..54
  nacha_field :receiving_company_name,
    inclusion: 'R', contents: 'Alphameric', position: 55..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