Class: Increase::Resources::ACHPrenotifications

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ACHPrenotifications

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ACHPrenotifications.

Parameters:



121
122
123
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 121

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) ⇒ Increase::Models::ACHPrenotification

Create an ACH Prenotification

Parameters:

  • account_id (String) —

    The Increase identifier for the account that will send the ACH Prenotification.

  • 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 ACH Prenotification.

  • company_discretionary_data (String) —

    The data you choose to associate with the ACH Prenotification.

  • company_entry_description (String) —

    The description you wish to be shown to the recipient.

  • company_name (String) —

    The name by which the recipient knows you.

  • credit_debit_indicator (Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator) —

    Whether the Prenotification is for a future debit or credit.

  • effective_date (Date) —

    The ACH Prenotification effective date in ISO 8601 format.

  • individual_id (String) —

    Your identifier for the recipient.

  • individual_name (String) —

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

  • standard_entry_class_code (Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode) —

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

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 51

def create(params)
  parsed, options = Increase::ACHPrenotificationCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ach_prenotifications",
    body: parsed,
    model: Increase::ACHPrenotification,
    options: options
  )
end

#list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::ACHPrenotification>

List ACH Prenotifications

Parameters:

  • created_at (Increase::Models::ACHPrenotificationListParams::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.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/increase/resources/ach_prenotifications.rb', line 105

def list(params = {})
  parsed, options = Increase::ACHPrenotificationListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ach_prenotifications",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::ACHPrenotification,
    options: options
  )
end

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

Retrieve an ACH Prenotification

Parameters:

  • ach_prenotification_id (String) —

    The identifier of the ACH Prenotification to retrieve.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

def retrieve(ach_prenotification_id, params = {})
  @client.request(
    method: :get,
    path: ["ach_prenotifications/%1$s", ach_prenotification_id],
    model: Increase::ACHPrenotification,
    options: params[:request_options]
  )
end