Class: Increase::Resources::ACHPrenotifications

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/ach_prenotifications.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ACHPrenotifications

Returns a new instance of ACHPrenotifications.



6
7
8
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#create(params = {}, opts = {}) ⇒ Increase::Models::ACHPrenotification

Create an ACH Prenotification

Parameters:

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :account_id (String) —

    The Increase identifier for the account that will send the transfer.

  • :account_number (String) —

    The account number for the destination account.

  • :routing_number (String) —

    The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

  • :addendum (String) —

    Additional information that will be sent to the recipient.

  • :company_descriptive_date (String) —

    The description of the date of the transfer.

  • :company_discretionary_data (String) —

    The data you choose to associate with the transfer.

  • :company_entry_description (String) —

    The description of the transfer you wish to be shown to the recipient.

  • :company_name (String) —

    The name by which the recipient knows you.

  • :credit_debit_indicator (Symbol) —

    Whether the Prenotification is for a future debit or credit.

  • :effective_date (String) —

    The transfer effective date in ISO 8601 format.

  • :individual_id (String) —

    Your identifier for the transfer recipient.

  • :individual_name (String) —

    The name of the transfer recipient. This value is information and not verified by the recipient's bank.

  • :standard_entry_class_code (Symbol) —

    The Standard Entry Class (SEC) code to use for the ACH Prenotification.

Returns:



33
34
35
36
37
38
39
40
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 33

def create(params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/ach_prenotifications"
  req[:body] = params
  req[:model] = Increase::Models::ACHPrenotification
  @client.request(req, opts)
end

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::ACHPrenotification>

List ACH Prenotifications

Parameters:

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :created_at (CreatedAt)
  • :cursor (String) —

    Return the page of entries after this one.

  • :idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Returns:



71
72
73
74
75
76
77
78
79
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 71

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/ach_prenotifications"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::ACHPrenotification
  @client.request(req, opts)
end

#retrieve(ach_prenotification_id, opts = {}) ⇒ Increase::Models::ACHPrenotification

Retrieve an ACH Prenotification

Parameters:

  • ach_prenotification_id (String) —

    The identifier of the ACH Prenotification to retrieve.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



48
49
50
51
52
53
54
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 48

def retrieve(ach_prenotification_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/ach_prenotifications/#{ach_prenotification_id}"
  req[:model] = Increase::Models::ACHPrenotification
  @client.request(req, opts)
end