Class: Loqate::Bank::BatchAccountValidation

Inherits:
Dry::Struct::Value
  • Object
show all
Defined in:
lib/loqate/bank/batch_account_validation.rb

Overview

Result of a batch bank account validation.

Constant Summary collapse

StatusInformation = 
Types::Strict::String.enum('CautiousOK', 'DetailsChanged', 'OK')

Instance Method Summary collapse

Instance Method Details

#bank ⇒ String

The name of the banking institution.

Returns:

  • (String) 


66
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 66

attribute :bank, Types::Strict::String

#bank_bic ⇒ String

The banking institution’s BIC, also know as the SWIFT BIC.

Returns:

  • (String) 


72
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 72

attribute :bank_bic, Types::Strict::String

#branch ⇒ String

The name of the account holding branch.

Returns:

  • (String) 


78
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 78

attribute :branch, Types::Strict::String

#branch_bic ⇒ String

The branch’s BIC.

Returns:

  • (String) 


84
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 84

attribute :branch_bic, Types::Strict::String

#contact_address_line1 ⇒ String

Line 1 of the branch’s contact address. NB: This is the address to be used for BACs enquiries and may be a contact centre rather than the branch’s address.

Returns:

  • (String) 


91
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 91

attribute :contact_address_line1, Types::Strict::String

#contact_address_line2 ⇒ String

Line 2 of the branch’s contact address.

Returns:

  • (String) 


97
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 97

attribute :contact_address_line2, Types::Strict::String

#contact_fax ⇒ String

The branch’s contact fax number.

Returns:

  • (String) 


121
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 121

attribute :contact_fax, Types::Strict::String

#contact_phone ⇒ String

The branch’s contact phone number.

Returns:

  • (String) 


115
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 115

attribute :contact_phone, Types::Strict::String

#contact_post_town ⇒ String

The branch’s contact post town.

Returns:

  • (String) 


103
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 103

attribute :contact_post_town, Types::Strict::String

#contact_postcode ⇒ String

The branch’s contact postcode.

Returns:

  • (String) 


109
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 109

attribute :contact_postcode, Types::Strict::String

#corrected_account_number ⇒ String

he correct version of the AccountNumber. This will be 8 digits long and in the form expected for BACs submission.

Returns:

  • (String) 


54
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 54

attribute :corrected_account_number, Types::Strict::String

#corrected_sort_code ⇒ String

The correct version of the SortCode. This will be 6 digits long with no hyphens. It may differ from the original sortcode.

Returns:

  • (String) 


47
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 47

attribute :corrected_sort_code, Types::Strict::String

#iban ⇒ String

The correctly formatted IBAN for the account.

Returns:

  • (String) 


60
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 60

attribute :iban, Types::Strict::String

#is_correct ⇒ Boolean Also known as: correct?

Indicates whether the account number and sortcode are valid.

Returns:

  • (Boolean) 


23
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 23

attribute :is_correct, Types::Strict::Bool

#is_direct_debit_capable ⇒ Boolean

Indicates whether the account can accept direct debits. Certain accounts (e.g. savings) will not accept direct debits.

Returns:

  • (Boolean) 


31
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 31

attribute :is_direct_debit_capable, Types::Strict::Bool

#original_account_number ⇒ String

The original AccountNumber passed to validate, excluding any non numeric characters.

Returns:

  • (String) 


11
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 11

attribute :original_account_number, Types::Strict::String

#original_sort_code ⇒ String

The original SortCode passed to validate, excluding any non numeric characters.

Returns:

  • (String) 


17
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 17

attribute :original_sort_code, Types::Strict::String

#status_information ⇒ String

More detail about the outcome of the validation process. Describes reasons validation failed or changes made to pass validation. DetailsChanged indicates that the account and sortcode should be changed for BACs submission (check CorrectedAccountNumber and CorrectedSortCode). CautiousOK is set where the sortcode exists but no validation rules are set for the bank (very rare).

Returns:

  • (String) 


40
 
# File 'lib/loqate/bank/batch_account_validation.rb', line 40

attribute :status_information, StatusInformation