Class: AchClient::ICheckGateway

Inherits:
Object
  • Object
show all
Includes:
SoapProvider
Defined in:
lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb,
lib/ach_client/providers/soap/i_check_gateway/ach_batch.rb,
lib/ach_client/providers/soap/i_check_gateway/company_info.rb,
lib/ach_client/providers/soap/i_check_gateway/ach_transaction.rb,
lib/ach_client/providers/soap/i_check_gateway/ach_status_checker.rb,
lib/ach_client/providers/soap/i_check_gateway/instant_rejection_error.rb,
lib/ach_client/providers/soap/i_check_gateway/account_type_transformer.rb,
lib/ach_client/providers/soap/i_check_gateway/response_record_processor.rb,
lib/ach_client/providers/soap/i_check_gateway/transaction_type_transformer.rb

Overview

Wrapper class for all things ICheckGateway

Defined Under Namespace

Classes: AccountTypeTransformer, AchBatch, AchStatusChecker, AchTransaction, CompanyInfo, InstantRejectionError, ResponseRecordProcessor, TransactionTypeTransformer

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.wrap_request(method:, message:) ⇒ Hash

Wraps SOAP request with exception handling and pulls relevent hash out of response

Parameters:

  • method (Symbol) —

    SOAP action to call

  • message (Hash) —

    SOAP message to send

Returns:

  • (Hash) —

    ICheckGateway response



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb', line 25

def self.wrap_request(method:, message:)
  response = AchClient::ICheckGateway.request(
    method: method,
    message: message
  )
  if response.success?
    response.body["#{method}_response".to_sym]["#{method}_result".to_sym]
  else
    # This happens when something goes wrong within the actual HTTP
    #   request before it gets to the soap processing.
    raise 'Unknown ICheckGateway SOAP fault'
  end
end

Instance Method Details

#api_key ⇒ String

Returns API key from ICheckGateway.

Returns:

  • (String) —

    API key from ICheckGateway



13
 
# File 'lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb', line 13

class_attribute :api_key

#live ⇒ Boolean

ICheckGateway uses their production environment for test/sandbox accounts Set this to false if you don’t want your transactions to actually complete

Returns:

  • (Boolean) —

    ICheckGateway GatewayLiveMode setting



18
 
# File 'lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb', line 18

class_attribute :live

#site_i_d ⇒ String

Returns Site identifier from ICheckGateway.

Returns:

  • (String) —

    Site identifier from ICheckGateway



7
 
# File 'lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb', line 7

class_attribute :site_i_d

#site_key ⇒ String

Returns Site key from ICheckGateway.

Returns:

  • (String) —

    Site key from ICheckGateway



10
 
# File 'lib/ach_client/providers/soap/i_check_gateway/i_check_gateway.rb', line 10

class_attribute :site_key