Class: GoCardlessPro::Resources::CreditorBankAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/gocardless_pro/resources/creditor_bank_account.rb

Overview

Creditor Bank Accounts hold the bank details of a [creditor](#core-endpoints-creditors). These are the bank accounts which your [payouts](#core-endpoints-payouts) will be sent to.

Note that creditor bank accounts must be unique, and so you will encounter a ‘bank_account_exists` error if you try to create a duplicate bank account. You may wish to handle this by updating the existing record instead, the ID of which will be provided as `links` in the error response.

<p class=“restricted-notice”><strong>Restricted</strong>: This API is not available for partner integrations.</p>

Defined Under Namespace

Classes: Links

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object, response = nil) ⇒ CreditorBankAccount

Initialize a creditor_bank_account resource instance

Parameters:

  • object (Hash) —

    an object returned from the API



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 41

def initialize(object, response = nil)
  @object = object

  @account_holder_name = object['account_holder_name']
  @account_number_ending = object['account_number_ending']
  @account_type = object['account_type']
  @bank_name = object['bank_name']
  @country_code = object['country_code']
  @created_at = object['created_at']
  @currency = object['currency']
  @enabled = object['enabled']
  @id = object['id']
  @links = object['links']
  @metadata = object['metadata']
  @response = response
end

Instance Attribute Details

#account_holder_name ⇒ Object (readonly)

Returns the value of attribute account_holder_name.



28
29
30
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 28

def 
  @account_holder_name
end

#account_number_ending ⇒ Object (readonly)

Returns the value of attribute account_number_ending.



29
30
31
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 29

def 
  @account_number_ending
end

#account_type ⇒ Object (readonly)

Returns the value of attribute account_type.



30
31
32
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 30

def 
  @account_type
end

#bank_name ⇒ Object (readonly)

Returns the value of attribute bank_name.



31
32
33
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 31

def bank_name
  @bank_name
end

#country_code ⇒ Object (readonly)

Returns the value of attribute country_code.



32
33
34
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 32

def country_code
  @country_code
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



33
34
35
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 33

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



34
35
36
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 34

def currency
  @currency
end

#enabled ⇒ Object (readonly)

Returns the value of attribute enabled.



35
36
37
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 35

def enabled
  @enabled
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



36
37
38
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 36

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



37
38
39
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 37

def metadata
  @metadata
end

Instance Method Details

#api_response ⇒ Object 



58
59
60
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 58

def api_response
  ApiResponse.new(@response)
end

#links ⇒ Object

Return the links that the resource has



63
64
65
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 63

def links
  @creditor_bank_account_links ||= Links.new(@links)
end

#to_h ⇒ Object

Provides the creditor_bank_account resource as a hash of all its readable attributes



68
69
70
 
# File 'lib/gocardless_pro/resources/creditor_bank_account.rb', line 68

def to_h
  @object
end