nacha 0.1.15 → 0.1.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/lib/nacha/numeric.rb +1 -1
- data/lib/nacha/record/ack_entry_detail.rb +20 -0
- data/lib/nacha/record/adv_batch_control.rb +18 -0
- data/lib/nacha/record/adv_entry_detail.rb +28 -0
- data/lib/nacha/record/adv_file_control.rb +16 -0
- data/lib/nacha/record/adv_file_header.rb +26 -0
- data/lib/nacha/record/arc_entry_detail.rb +20 -0
- data/lib/nacha/record/base.rb +115 -3
- data/lib/nacha/record/batch_control.rb +22 -0
- data/lib/nacha/record/batch_header.rb +26 -0
- data/lib/nacha/record/batch_header_record_type.rb +2 -0
- data/lib/nacha/record/boc_entry_detail.rb +20 -0
- data/lib/nacha/record/ccd_addenda.rb +10 -0
- data/lib/nacha/record/ccd_entry_detail.rb +20 -0
- data/lib/nacha/record/cie_addenda.rb +10 -0
- data/lib/nacha/record/cie_entry_detail.rb +20 -0
- data/lib/nacha/record/ctx_addenda.rb +10 -0
- data/lib/nacha/record/ctx_corporate_entry_detail.rb +24 -0
- data/lib/nacha/record/dne_addenda.rb +11 -0
- data/lib/nacha/record/dne_entry_detail.rb +20 -0
- data/lib/nacha/record/enr_addenda.rb +10 -0
- data/lib/nacha/record/enr_entry_detail.rb +24 -0
- data/lib/nacha/record/fifth_iat_addenda.rb +16 -0
- data/lib/nacha/record/file_control.rb +16 -0
- data/lib/nacha/record/file_header.rb +26 -0
- data/lib/nacha/record/filler.rb +4 -0
- data/lib/nacha/record/first_iat_addenda.rb +16 -0
- data/lib/nacha/record/fourth_iat_addenda.rb +16 -0
- data/lib/nacha/record/iat_batch_header.rb +34 -0
- data/lib/nacha/record/iat_entry_detail.rb +24 -0
- data/lib/nacha/record/iat_foreign_coorespondent_bank_information_addenda.rb +18 -0
- data/lib/nacha/record/iat_remittance_information_addenda.rb +10 -0
- data/lib/nacha/record/mte_addenda.rb +24 -0
- data/lib/nacha/record/mte_entry_detail.rb +20 -0
- data/lib/nacha/record/pop_entry_detail.rb +24 -0
- data/lib/nacha/record/pos_addenda.rb +24 -0
- data/lib/nacha/record/pos_entry_detail.rb +20 -0
- data/lib/nacha/record/ppd_addenda.rb +10 -0
- data/lib/nacha/record/ppd_entry_detail.rb +20 -0
- data/lib/nacha/record/rck_entry_detail.rb +20 -0
- data/lib/nacha/record/second_iat_addenda.rb +12 -0
- data/lib/nacha/record/seventh_iat_addenda.rb +13 -1
- data/lib/nacha/record/shr_addenda.rb +24 -0
- data/lib/nacha/record/shr_entry_detail.rb +22 -0
- data/lib/nacha/record/sixth_iat_addenda.rb +12 -0
- data/lib/nacha/record/tel_entry_detail.rb +20 -0
- data/lib/nacha/record/third_iat_addenda.rb +12 -0
- data/lib/nacha/record/trc_entry_detail.rb +22 -0
- data/lib/nacha/record/trx_addenda.rb +10 -0
- data/lib/nacha/record/trx_entry_detail.rb +24 -0
- data/lib/nacha/record/web_addenda.rb +10 -0
- data/lib/nacha/record/web_entry_detail.rb +20 -0
- data/lib/nacha/record/xck_entry_detail.rb +22 -0
- data/lib/nacha/version.rb +1 -1
- data/nacha.gemspec +1 -0
- metadata +16 -2
@@ -6,6 +6,26 @@ require 'nacha/record/detail_record_type'
|
|
6
6
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
|
+
# @!attribute [rw] record_type_code
|
10
|
+
# @return [String] Identifies the record as a CIE Entry Detail record with a constant value of '6'.
|
11
|
+
# @!attribute [rw] transaction_code
|
12
|
+
# @return [Nacha::Numeric] Defines the account type and nature of the transaction.
|
13
|
+
# @!attribute [rw] receiving_dfi_identification
|
14
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
|
15
|
+
# @!attribute [rw] dfi_account_number
|
16
|
+
# @return [String] The account number at the receiving institution.
|
17
|
+
# @!attribute [rw] amount
|
18
|
+
# @return [Nacha::Numeric] The amount of the transaction.
|
19
|
+
# @!attribute [rw] individual_name
|
20
|
+
# @return [String] The name of the individual receiver.
|
21
|
+
# @!attribute [rw] individual_identification_number
|
22
|
+
# @return [String] A unique identifier for the individual receiver.
|
23
|
+
# @!attribute [rw] discretionary_data
|
24
|
+
# @return [String] An optional data field for the Originator's use.
|
25
|
+
# @!attribute [rw] addenda_record_indicator
|
26
|
+
# @return [Nacha::Numeric] Indicates whether an addenda record follows.
|
27
|
+
# @!attribute [rw] trace_number
|
28
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI for tracing the entry.
|
9
29
|
class CieEntryDetail < Nacha::Record::Base
|
10
30
|
include DetailRecordType
|
11
31
|
|
@@ -4,6 +4,16 @@ require 'nacha/record/base'
|
|
4
4
|
require 'nacha/record/addenda_record_type'
|
5
5
|
module Nacha
|
6
6
|
module Record
|
7
|
+
# @!attribute [rw] record_type_code
|
8
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
9
|
+
# @!attribute [rw] addenda_type_code
|
10
|
+
# @return [String] Specifies the type of addenda, which is '05' for CTX payment-related information.
|
11
|
+
# @!attribute [rw] payment_related_information
|
12
|
+
# @return [String] Contains remittance information, such as invoice numbers and amounts.
|
13
|
+
# @!attribute [rw] addenda_sequence_number
|
14
|
+
# @return [Nacha::Numeric] The sequence number of this addenda record within the entry.
|
15
|
+
# @!attribute [rw] entry_detail_sequence_number
|
16
|
+
# @return [Nacha::Numeric] The sequence number of the Entry Detail record this addenda belongs to.
|
7
17
|
class CtxAddenda < Nacha::Record::Base
|
8
18
|
include AddendaRecordType
|
9
19
|
|
@@ -6,6 +6,30 @@ require 'nacha/record/detail_record_type'
|
|
6
6
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
|
+
# @!attribute [rw] record_type_code
|
10
|
+
# @return [String] Identifies the record as a CTX Entry Detail record with a constant value of '6'.
|
11
|
+
# @!attribute [rw] transaction_code
|
12
|
+
# @return [Nacha::Numeric] Defines the account type and whether the transaction is a debit or credit.
|
13
|
+
# @!attribute [rw] receiving_dfi_identification
|
14
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
|
15
|
+
# @!attribute [rw] dfi_account_number
|
16
|
+
# @return [String] The account number at the receiving DFI.
|
17
|
+
# @!attribute [rw] total_amount
|
18
|
+
# @return [Nacha::Numeric] The total amount of the entry.
|
19
|
+
# @!attribute [rw] identification_number
|
20
|
+
# @return [String] An identifier for the receiving company.
|
21
|
+
# @!attribute [rw] number_of_addenda_records
|
22
|
+
# @return [String] The number of addenda records associated with this entry.
|
23
|
+
# @!attribute [rw] receiving_company_name
|
24
|
+
# @return [String] The name of the company receiving the entry.
|
25
|
+
# @!attribute [rw] reserved
|
26
|
+
# @return [String] A reserved field.
|
27
|
+
# @!attribute [rw] discretionary_data
|
28
|
+
# @return [String] An optional data field for the Originator's use.
|
29
|
+
# @!attribute [rw] addenda_record_indicator
|
30
|
+
# @return [Nacha::Numeric] Indicates that one or more addenda records follow.
|
31
|
+
# @!attribute [rw] trace_number
|
32
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
|
9
33
|
class CtxCorporateEntryDetail < Nacha::Record::Base
|
10
34
|
include DetailRecordType
|
11
35
|
|
@@ -6,6 +6,17 @@ require 'nacha/record/addenda_record_type'
|
|
6
6
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
|
+
# Represents a Death Notification Entry (DNE) addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies the type of addenda, typically '05' for DNE notices.
|
14
|
+
# @!attribute [rw] payment_related_information
|
15
|
+
# @return [String] Contains information related to the death notification, such as date of death.
|
16
|
+
# @!attribute [rw] addenda_sequence_number
|
17
|
+
# @return [Nacha::Numeric] The sequence number for this addenda record.
|
18
|
+
# @!attribute [rw] entry_detail_sequence_number
|
19
|
+
# @return [Nacha::Numeric] The sequence number of the associated DNE Entry Detail record.
|
9
20
|
class DneAddenda < Nacha::Record::Base
|
10
21
|
include AddendaRecordType
|
11
22
|
|
@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Death Notification Entry (DNE) detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as a DNE Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Defines the transaction as a DNE.
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution that received the original payment.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number of the deceased individual.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the entry, which is typically zero for a DNE.
|
20
|
+
# @!attribute [rw] individual_identification_number
|
21
|
+
# @return [String] The Social Security Number of the deceased individual.
|
22
|
+
# @!attribute [rw] individual_name
|
23
|
+
# @return [String] The name of the deceased individual.
|
24
|
+
# @!attribute [rw] discretionary_data
|
25
|
+
# @return [String] Optional data field for the Originator's use.
|
26
|
+
# @!attribute [rw] addenda_record_indicator
|
27
|
+
# @return [Nacha::Numeric] Indicates if an addenda record with further information is present.
|
28
|
+
# @!attribute [rw] trace_number
|
29
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI for tracing the entry.
|
10
30
|
class DneEntryDetail < Nacha::Record::Base
|
11
31
|
include DetailRecordType
|
12
32
|
|
@@ -7,6 +7,16 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents an Automated Enrollment Entry (ENR) addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Indicates the type of addenda information, '05' for ENR.
|
14
|
+
# @!attribute [rw] payment_related_information
|
15
|
+
# @return [String] Contains enrollment-related information provided by the Federal Government agency.
|
16
|
+
# @!attribute [rw] addenda_sequence_number
|
17
|
+
# @return [Nacha::Numeric] The sequence number of this addenda record.
|
18
|
+
# @!attribute [rw] entry_detail_sequence_number
|
19
|
+
# @return [Nacha::Numeric] The sequence number of the associated ENR Entry Detail record.
|
10
20
|
class EnrAddenda < Nacha::Record::Base
|
11
21
|
include AddendaRecordType
|
12
22
|
|
@@ -7,6 +7,30 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents an Automated Enrollment Entry (ENR) detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an ENR Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] The transaction code for the enrollment.
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution where the enrollment is to occur.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number for the enrollment.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the entry, which is always zero for ENR.
|
20
|
+
# @!attribute [rw] identification_number
|
21
|
+
# @return [String] A unique identifier for the enrollee.
|
22
|
+
# @!attribute [rw] number_of_addenda_records
|
23
|
+
# @return [String] The number of addenda records containing enrollment information.
|
24
|
+
# @!attribute [rw] receiving_company_name
|
25
|
+
# @return [String] The name of the enrollee.
|
26
|
+
# @!attribute [rw] reserved
|
27
|
+
# @return [String] A reserved field.
|
28
|
+
# @!attribute [rw] discretionary_data
|
29
|
+
# @return [String] Optional data field for use by the receiving DFI.
|
30
|
+
# @!attribute [rw] addenda_record_indicator
|
31
|
+
# @return [Nacha::Numeric] Indicates that an addenda record is present.
|
32
|
+
# @!attribute [rw] trace_number
|
33
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the enrollment.
|
10
34
|
class EnrEntryDetail < Nacha::Record::Base
|
11
35
|
include DetailRecordType
|
12
36
|
|
@@ -5,6 +5,22 @@ require 'nacha/record/addenda_record_type'
|
|
5
5
|
module Nacha
|
6
6
|
module Record
|
7
7
|
# Represents a fifth IAT addenda record
|
8
|
+
# @!attribute [rw] record_type_code
|
9
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
10
|
+
# @!attribute [rw] addenda_type_code
|
11
|
+
# @return [String] Specifies this is the fifth in a series of IAT addenda records with code '14'.
|
12
|
+
# @!attribute [rw] receiving_dfi_name
|
13
|
+
# @return [String] The name of the financial institution that will receive the transaction.
|
14
|
+
# @!attribute [rw] receiving_dfi_identification_number_qualifier
|
15
|
+
# @return [String] A code that specifies the format of the receiving DFI's identification number.
|
16
|
+
# @!attribute [rw] receiving_dfi_identification
|
17
|
+
# @return [String] The identification number of the receiving financial institution.
|
18
|
+
# @!attribute [rw] receiving_dfi_branch_country_code
|
19
|
+
# @return [String] The ISO country code of the country where the receiving DFI branch is located.
|
20
|
+
# @!attribute [rw] reserved
|
21
|
+
# @return [String] A reserved field for future use.
|
22
|
+
# @!attribute [rw] entry_detail_sequence_number
|
23
|
+
# @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
|
8
24
|
class FifthIatAddenda < Nacha::Record::Base
|
9
25
|
include AddendaRecordType
|
10
26
|
|
@@ -6,6 +6,22 @@ require 'nacha/record/file_control_record_type'
|
|
6
6
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
|
+
# @!attribute [rw] record_type_code
|
10
|
+
# @return [String] Identifies the record as a File Control record with a constant value of '9'.
|
11
|
+
# @!attribute [rw] batch_count
|
12
|
+
# @return [Nacha::Numeric] The total number of batches in the file.
|
13
|
+
# @!attribute [rw] block_count
|
14
|
+
# @return [Nacha::Numeric] The total number of physical blocks in the file.
|
15
|
+
# @!attribute [rw] entry_addenda_count
|
16
|
+
# @return [Nacha::Numeric] The total number of entry detail and addenda records in the file.
|
17
|
+
# @!attribute [rw] entry_hash
|
18
|
+
# @return [Nacha::Numeric] A sum of the entry hash totals from all the batch control records in the file.
|
19
|
+
# @!attribute [rw] total_debit_entry_dollar_amount_in_file
|
20
|
+
# @return [Nacha::Numeric] The total dollar amount of all debit entries in the file.
|
21
|
+
# @!attribute [rw] total_credit_entry_dollar_amount_in_file
|
22
|
+
# @return [Nacha::Numeric] The total dollar amount of all credit entries in the file.
|
23
|
+
# @!attribute [rw] reserved
|
24
|
+
# @return [String] A reserved field for future use.
|
9
25
|
class FileControl < Nacha::Record::Base
|
10
26
|
include FileControlRecordType
|
11
27
|
|
@@ -7,6 +7,32 @@ module Nacha
|
|
7
7
|
module Record
|
8
8
|
# The FileHeader record is the first record in a
|
9
9
|
# Nacha file and contains information about the file itself.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as a File Header record with a constant value of '1'.
|
12
|
+
# @!attribute [rw] priority_code
|
13
|
+
# @return [Nacha::Numeric] A code assigned by the ODFI to indicate the processing priority of the file.
|
14
|
+
# @!attribute [rw] immediate_destination
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the ACH Operator or receiving point to which the file is sent.
|
16
|
+
# @!attribute [rw] immediate_origin
|
17
|
+
# @return [Nacha::AbaNumber] The routing number of the ODFI or sending point that created the file.
|
18
|
+
# @!attribute [rw] file_creation_date
|
19
|
+
# @return [String] The date the file was created, in YYMMDD format.
|
20
|
+
# @!attribute [rw] file_creation_time
|
21
|
+
# @return [String] The time the file was created, in HHMM format.
|
22
|
+
# @!attribute [rw] file_id_modifier
|
23
|
+
# @return [String] A character used to distinguish between multiple files created on the same day.
|
24
|
+
# @!attribute [rw] record_size
|
25
|
+
# @return [String] The fixed number of characters per record, which is always '094'.
|
26
|
+
# @!attribute [rw] blocking_factor
|
27
|
+
# @return [String] The number of records in a block, which is always '10'.
|
28
|
+
# @!attribute [rw] format_code
|
29
|
+
# @return [String] Indicates the version of the Nacha file format, typically '1'.
|
30
|
+
# @!attribute [rw] immediate_destination_name
|
31
|
+
# @return [String] The name of the ACH Operator or receiving point.
|
32
|
+
# @!attribute [rw] immediate_origin_name
|
33
|
+
# @return [String] The name of the ODFI or sending point.
|
34
|
+
# @!attribute [rw] reference_code
|
35
|
+
# @return [String] An optional code for the ODFI's use.
|
10
36
|
class FileHeader < Nacha::Record::Base
|
11
37
|
include FileHeaderRecordType
|
12
38
|
|
data/lib/nacha/record/filler.rb
CHANGED
@@ -6,6 +6,10 @@ require 'nacha/record/filler_record_type'
|
|
6
6
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
|
+
# @!attribute [rw] record_type_code
|
10
|
+
# @return [String] Identifies the record as a Filler record with a constant value of '9'.
|
11
|
+
# @!attribute [rw] filler
|
12
|
+
# @return [String] A field consisting of all '9's to pad a block to 10 lines.
|
9
13
|
class Filler < Nacha::Record::Base
|
10
14
|
include FillerRecordType
|
11
15
|
|
@@ -7,6 +7,22 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a first IAT addenda record
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies this is the first in a series of IAT addenda records with code '10'.
|
14
|
+
# @!attribute [rw] transaction_type_code
|
15
|
+
# @return [String] A code that further specifies the type of IAT transaction (e.g., business, consumer).
|
16
|
+
# @!attribute [rw] foreign_payment_amount
|
17
|
+
# @return [String] The amount of the payment in the foreign currency.
|
18
|
+
# @!attribute [rw] foreign_trace_number
|
19
|
+
# @return [String] A trace number assigned by a foreign payment system.
|
20
|
+
# @!attribute [rw] receiving_company_name
|
21
|
+
# @return [String] The name of the company that is the ultimate recipient of the funds.
|
22
|
+
# @!attribute [rw] reserved
|
23
|
+
# @return [String] A reserved field for future use.
|
24
|
+
# @!attribute [rw] entry_detail_sequence_number
|
25
|
+
# @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
|
10
26
|
class FirstIatAddenda < Nacha::Record::Base
|
11
27
|
include AddendaRecordType
|
12
28
|
|
@@ -7,6 +7,22 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a fourth IAT addenda record
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies this is the fourth in a series of IAT addenda records with code '13'.
|
14
|
+
# @!attribute [rw] originating_dfi_name
|
15
|
+
# @return [String] The name of the financial institution that originated the transaction.
|
16
|
+
# @!attribute [rw] originating_dfi_identification_number_qualifier
|
17
|
+
# @return [String] A code that specifies the format of the originating DFI's identification number.
|
18
|
+
# @!attribute [rw] originating_dfi_identification
|
19
|
+
# @return [String] The identification number of the originating financial institution.
|
20
|
+
# @!attribute [rw] originating_dfi_branch_country_code
|
21
|
+
# @return [String] The ISO country code of the country where the originating DFI branch is located.
|
22
|
+
# @!attribute [rw] reserved
|
23
|
+
# @return [String] A reserved field for future use.
|
24
|
+
# @!attribute [rw] entry_detail_sequence_number
|
25
|
+
# @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
|
10
26
|
class FourthIatAddenda < Nacha::Record::Base
|
11
27
|
include AddendaRecordType
|
12
28
|
|
@@ -6,6 +6,40 @@ require 'nacha/record/batch_header_record_type'
|
|
6
6
|
module Nacha
|
7
7
|
module Record
|
8
8
|
# Represents an IAT batch header record
|
9
|
+
# @!attribute [rw] record_type_code
|
10
|
+
# @return [String] Identifies the record as a Batch Header record with a constant value of '5'.
|
11
|
+
# @!attribute [rw] service_class_code
|
12
|
+
# @return [Nacha::Numeric] Defines the type of entries in the batch, such as credits or debits.
|
13
|
+
# @!attribute [rw] iat_indicator
|
14
|
+
# @return [String] Provides supplemental information about the IAT entry.
|
15
|
+
# @!attribute [rw] foreign_exchange_indicator
|
16
|
+
# @return [String] Indicates the method used to determine the foreign exchange rate.
|
17
|
+
# @!attribute [rw] foreign_exchange_reference_indicator
|
18
|
+
# @return [Nacha::Numeric] A code indicating the content of the Foreign Exchange Reference field.
|
19
|
+
# @!attribute [rw] foreign_exchange_reference
|
20
|
+
# @return [String] A reference related to the foreign exchange conversion.
|
21
|
+
# @!attribute [rw] iso_destination_country_code
|
22
|
+
# @return [String] The two-character ISO code for the country of the receiver's financial institution.
|
23
|
+
# @!attribute [rw] originator_identification
|
24
|
+
# @return [String] The identifier for the originator of the transaction.
|
25
|
+
# @!attribute [rw] standard_entry_class_code
|
26
|
+
# @return [String] The Standard Entry Class code, which is 'IAT' for these batches.
|
27
|
+
# @!attribute [rw] company_entry_description
|
28
|
+
# @return [String] A description of the purpose of the entries in the batch.
|
29
|
+
# @!attribute [rw] iso_originating_currency_code
|
30
|
+
# @return [String] The three-character ISO currency code of the originating country.
|
31
|
+
# @!attribute [rw] iso_destination_currency_code
|
32
|
+
# @return [String] The three-character ISO currency code of the destination country.
|
33
|
+
# @!attribute [rw] effective_entry_date
|
34
|
+
# @return [String] The date on which the entries are intended to be settled.
|
35
|
+
# @!attribute [rw] settlement_date_julian
|
36
|
+
# @return [Nacha::Numeric] A Julian date used by the ACH Operator for settlement.
|
37
|
+
# @!attribute [rw] originator_status_code
|
38
|
+
# @return [String] A code indicating the status of the originator.
|
39
|
+
# @!attribute [rw] originating_dfi_identification
|
40
|
+
# @return [String] The 8-digit routing number of the financial institution originating the batch.
|
41
|
+
# @!attribute [rw] batch_number
|
42
|
+
# @return [Nacha::Numeric] A number assigned by the Originator to uniquely identify the batch.
|
9
43
|
class IatBatchHeader < Nacha::Record::Base
|
10
44
|
include BatchHeaderRecordType
|
11
45
|
|
@@ -7,6 +7,30 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents an IAT entry detail record
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an IAT Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Specifies the type of account and transaction (e.g., debit to a checking account).
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the U.S. financial institution that will receive the entry.
|
16
|
+
# @!attribute [rw] number_of_addenda_records
|
17
|
+
# @return [String] The number of addenda records that follow this entry detail record.
|
18
|
+
# @!attribute [rw] reserved1
|
19
|
+
# @return [String] A reserved field for future use.
|
20
|
+
# @!attribute [rw] amount
|
21
|
+
# @return [Nacha::Numeric] The amount of the transaction in U.S. dollars.
|
22
|
+
# @!attribute [rw] dfi_account_number
|
23
|
+
# @return [Nacha::Numeric] The account number of the receiver at the foreign financial institution.
|
24
|
+
# @!attribute [rw] reserved2
|
25
|
+
# @return [String] A reserved field for future use.
|
26
|
+
# @!attribute [rw] gateway_operator_ofac_screening_indicator
|
27
|
+
# @return [String] Indicates whether the Gateway Operator has screened the entry against the OFAC list.
|
28
|
+
# @!attribute [rw] secondary_ofac_screening_indicator
|
29
|
+
# @return [String] Indicates whether a secondary screening has been performed.
|
30
|
+
# @!attribute [rw] addenda_record_indicator
|
31
|
+
# @return [Nacha::Numeric] Indicates that one or more addenda records are present.
|
32
|
+
# @!attribute [rw] trace_number
|
33
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
|
10
34
|
class IatEntryDetail < Nacha::Record::Base
|
11
35
|
include DetailRecordType
|
12
36
|
|
@@ -7,6 +7,24 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents an IAT Foreign Correspondent Bank Information addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies this is a foreign correspondent bank information addenda record with code '18'.
|
14
|
+
# @!attribute [rw] foreign_correspondent_bank_name
|
15
|
+
# @return [String] The name of the foreign correspondent bank.
|
16
|
+
# @!attribute [rw] foreign_correspondent_bank_identification_number_qualifier
|
17
|
+
# @return [String] A code qualifying the identification number of the foreign correspondent bank.
|
18
|
+
# @!attribute [rw] foreign_correspondent_bank_identification_number
|
19
|
+
# @return [String] The identification number of the foreign correspondent bank.
|
20
|
+
# @!attribute [rw] foreign_correspondent_bank_branch_country_code
|
21
|
+
# @return [String] The ISO country code of the foreign correspondent bank's branch.
|
22
|
+
# @!attribute [rw] reserved
|
23
|
+
# @return [String] A reserved field for future use.
|
24
|
+
# @!attribute [rw] addenda_sequence_number
|
25
|
+
# @return [Nacha::Numeric] The sequence number for this addenda record within the entry.
|
26
|
+
# @!attribute [rw] entry_detail_sequence_number
|
27
|
+
# @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
|
10
28
|
class IatForeignCoorespondentBankInformationAddenda < Nacha::Record::Base
|
11
29
|
include AddendaRecordType
|
12
30
|
|
@@ -7,6 +7,16 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents an IAT Remittance Information addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies this is a remittance information addenda record with code '17'.
|
14
|
+
# @!attribute [rw] payment_related_information
|
15
|
+
# @return [String] Contains remittance information, such as invoice numbers or other reference data.
|
16
|
+
# @!attribute [rw] addenda_sequence_number
|
17
|
+
# @return [Nacha::Numeric] The sequence number for this addenda record within the entry.
|
18
|
+
# @!attribute [rw] entry_detail_sequence_number
|
19
|
+
# @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
|
10
20
|
class IatRemittanceInformationAddenda < Nacha::Record::Base
|
11
21
|
include AddendaRecordType
|
12
22
|
|
@@ -7,6 +7,30 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Machine Transfer Entry (MTE) addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies the type of addenda, '02' for MTE terminal information.
|
14
|
+
# @!attribute [rw] transaction_description
|
15
|
+
# @return [String] A description of the transaction.
|
16
|
+
# @!attribute [rw] network_identification_code
|
17
|
+
# @return [String] Identifies the ATM network through which the transaction was processed.
|
18
|
+
# @!attribute [rw] terminal_identification_code
|
19
|
+
# @return [String] A unique code identifying the ATM terminal.
|
20
|
+
# @!attribute [rw] transaction_serial_number
|
21
|
+
# @return [String] The serial number assigned to the transaction by the terminal.
|
22
|
+
# @!attribute [rw] transaction_date
|
23
|
+
# @return [String] The date of the transaction in MMDD format.
|
24
|
+
# @!attribute [rw] transaction_time
|
25
|
+
# @return [String] The time of the transaction in HHMMSS format.
|
26
|
+
# @!attribute [rw] terminal_location
|
27
|
+
# @return [String] The physical location of the terminal.
|
28
|
+
# @!attribute [rw] terminal_city
|
29
|
+
# @return [String] The city where the terminal is located.
|
30
|
+
# @!attribute [rw] terminal_state
|
31
|
+
# @return [String] The state where the terminal is located.
|
32
|
+
# @!attribute [rw] trace_number
|
33
|
+
# @return [Nacha::Numeric] The trace number of the associated MTE Entry Detail record.
|
10
34
|
class MteAddenda < Nacha::Record::Base
|
11
35
|
include AddendaRecordType
|
12
36
|
|
@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Machine Transfer Entry (MTE) detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an MTE Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Defines the type of account and transaction.
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the funds.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number being credited or debited.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the transaction.
|
20
|
+
# @!attribute [rw] individual_name
|
21
|
+
# @return [String] The name of the individual cardholder.
|
22
|
+
# @!attribute [rw] individual_identification_number
|
23
|
+
# @return [String] The cardholder's account number or other identifier.
|
24
|
+
# @!attribute [rw] discretionary_data
|
25
|
+
# @return [String] An optional field for the Originator's use.
|
26
|
+
# @!attribute [rw] addenda_record_indicator
|
27
|
+
# @return [Nacha::Numeric] Indicates if an addenda record with terminal information is present.
|
28
|
+
# @!attribute [rw] trace_number
|
29
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI for tracing the entry.
|
10
30
|
class MteEntryDetail < Nacha::Record::Base
|
11
31
|
include DetailRecordType
|
12
32
|
|
@@ -7,6 +7,30 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Point-of-Purchase (POP) entry detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as a POP Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Defines the type of account and transaction (debit).
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number to be debited.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the transaction from the source check.
|
20
|
+
# @!attribute [rw] check_serial_number
|
21
|
+
# @return [String] The serial number of the source check.
|
22
|
+
# @!attribute [rw] terminal_city
|
23
|
+
# @return [String] The city where the point-of-purchase terminal is located.
|
24
|
+
# @!attribute [rw] terminal_state
|
25
|
+
# @return [String] The state where the point-of-purchase terminal is located.
|
26
|
+
# @!attribute [rw] individual_name
|
27
|
+
# @return [String] The name of the individual who wrote the check.
|
28
|
+
# @!attribute [rw] discretionary_data
|
29
|
+
# @return [String] An optional field for the Originator's use.
|
30
|
+
# @!attribute [rw] addenda_record_indicator
|
31
|
+
# @return [Nacha::Numeric] Indicates if an addenda record is present.
|
32
|
+
# @!attribute [rw] trace_number
|
33
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
|
10
34
|
class PopEntryDetail < Nacha::Record::Base
|
11
35
|
include DetailRecordType
|
12
36
|
|
@@ -7,6 +7,30 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Point-of-Sale (POS) addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies the type of addenda, '02' for POS terminal information.
|
14
|
+
# @!attribute [rw] reference_information_1
|
15
|
+
# @return [String] First reference field for additional transaction information.
|
16
|
+
# @!attribute [rw] reference_information_2
|
17
|
+
# @return [String] Second reference field for additional transaction information.
|
18
|
+
# @!attribute [rw] terminal_identification_code
|
19
|
+
# @return [String] A unique code identifying the POS terminal.
|
20
|
+
# @!attribute [rw] transaction_serial_number
|
21
|
+
# @return [String] The serial number of the transaction from the terminal.
|
22
|
+
# @!attribute [rw] transaction_date
|
23
|
+
# @return [String] The date of the POS transaction.
|
24
|
+
# @!attribute [rw] authorization_code_or_card_expiration_date
|
25
|
+
# @return [String] The authorization code for the transaction or the card's expiration date.
|
26
|
+
# @!attribute [rw] terminal_location
|
27
|
+
# @return [String] The physical location of the POS terminal.
|
28
|
+
# @!attribute [rw] terminal_city
|
29
|
+
# @return [String] The city where the terminal is located.
|
30
|
+
# @!attribute [rw] terminal_state
|
31
|
+
# @return [Nacha::Numeric] The state where the terminal is located.
|
32
|
+
# @!attribute [rw] trace_number
|
33
|
+
# @return [Nacha::Numeric] The trace number of the associated POS Entry Detail record.
|
10
34
|
class PosAddenda < Nacha::Record::Base
|
11
35
|
include AddendaRecordType
|
12
36
|
|
@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Point-of-Sale (POS) entry detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as a POS Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Defines the type of account and transaction.
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number to be credited or debited.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the transaction.
|
20
|
+
# @!attribute [rw] individual_identification_number
|
21
|
+
# @return [String] The cardholder's account number or other identifier.
|
22
|
+
# @!attribute [rw] individual_name
|
23
|
+
# @return [String] The name of the individual cardholder.
|
24
|
+
# @!attribute [rw] card_transaction_type_code
|
25
|
+
# @return [String] A code identifying the type of card transaction.
|
26
|
+
# @!attribute [rw] addenda_record_indicator
|
27
|
+
# @return [Nacha::Numeric] Indicates if an addenda record with terminal information is present.
|
28
|
+
# @!attribute [rw] trace_number
|
29
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI for tracing the entry.
|
10
30
|
class PosEntryDetail < Nacha::Record::Base
|
11
31
|
include DetailRecordType
|
12
32
|
|
@@ -7,6 +7,16 @@ require 'nacha/record/addenda_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Represents a Prearranged Payment and Deposit (PPD) addenda record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as an Addenda record with a constant value of '7'.
|
12
|
+
# @!attribute [rw] addenda_type_code
|
13
|
+
# @return [String] Specifies the type of addenda, '05' for PPD payment-related information.
|
14
|
+
# @!attribute [rw] payment_related_information
|
15
|
+
# @return [String] Contains additional information about the payment, such as a reference number.
|
16
|
+
# @!attribute [rw] addenda_sequence_number
|
17
|
+
# @return [Nacha::Numeric] The sequence number for this addenda record.
|
18
|
+
# @!attribute [rw] entry_detail_sequence_number
|
19
|
+
# @return [Nacha::Numeric] The sequence number of the associated PPD Entry Detail record.
|
10
20
|
class PpdAddenda < Nacha::Record::Base
|
11
21
|
include AddendaRecordType
|
12
22
|
|
@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
|
|
7
7
|
module Nacha
|
8
8
|
module Record
|
9
9
|
# Describes a PPD (Prearranged Payment and Deposit) Entry Detail record.
|
10
|
+
# @!attribute [rw] record_type_code
|
11
|
+
# @return [String] Identifies the record as a PPD Entry Detail record with a constant value of '6'.
|
12
|
+
# @!attribute [rw] transaction_code
|
13
|
+
# @return [Nacha::Numeric] Defines the type of account and transaction (e.g., credit to a savings account).
|
14
|
+
# @!attribute [rw] receiving_dfi_identification
|
15
|
+
# @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
|
16
|
+
# @!attribute [rw] dfi_account_number
|
17
|
+
# @return [String] The account number to be credited or debited.
|
18
|
+
# @!attribute [rw] amount
|
19
|
+
# @return [Nacha::Numeric] The amount of the transaction.
|
20
|
+
# @!attribute [rw] individual_identification_number
|
21
|
+
# @return [String] An identifier for the individual receiver, such as an employee or customer number.
|
22
|
+
# @!attribute [rw] individual_name
|
23
|
+
# @return [String] The name of the individual receiver.
|
24
|
+
# @!attribute [rw] discretionary_data
|
25
|
+
# @return [String] An optional field for the Originator's use.
|
26
|
+
# @!attribute [rw] addenda_record_indicator
|
27
|
+
# @return [Nacha::Numeric] Indicates if an addenda record is present.
|
28
|
+
# @!attribute [rw] trace_number
|
29
|
+
# @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
|
10
30
|
class PpdEntryDetail < Nacha::Record::Base
|
11
31
|
include DetailRecordType
|
12
32
|
|