Class: AchClient::ReturnCode

Inherits:
Object
  • Object
show all
Defined in:
lib/ach_client/objects/return_code.rb

Overview

Represents an Ach Return code. Consult NACHA documentation for a full list See config/return_codes.yml for our list.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code:, description:, reason: nil) ⇒ ReturnCode

Constructs a Ach return code

Parameters:

  • code (String) —

    the 3 char code identifier (ie ‘R01’)

  • description (String) —

    full explanation of the return

  • reason (String) (defaults to: nil) —

    shorter explanation of the return



14
15
16
17
18
 
# File 'lib/ach_client/objects/return_code.rb', line 14

def initialize(code:, description:, reason: nil)
  @code = code
  @description = description
  @reason = reason
end

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



6
7
8
 
# File 'lib/ach_client/objects/return_code.rb', line 6

def code
  @code
end

#description ⇒ Object

Returns the value of attribute description.



6
7
8
 
# File 'lib/ach_client/objects/return_code.rb', line 6

def description
  @description
end

#reason ⇒ Object

Returns the value of attribute reason.



6
7
8
 
# File 'lib/ach_client/objects/return_code.rb', line 6

def reason
  @reason
end