Class: Increase::Resources::Simulations::InboundRealTimePaymentsTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundRealTimePaymentsTransfers

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 InboundRealTimePaymentsTransfers.

Parameters:



50
51
52
 
# File 'lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb', line 50

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number_id: , amount: , debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, remittance_information: nil, request_for_payment_id: nil, request_options: {}) ⇒ Increase::Models::InboundRealTimePaymentsTransfer

Some parameter documentations has been truncated, see Models::Simulations::InboundRealTimePaymentsTransferCreateParams for more details.

Simulates an [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to your account. Real-Time Payments are a beta feature.

Parameters:

  • account_number_id (String) —

    The identifier of the Account Number the inbound Real-Time Payments Transfer is

  • amount (Integer) —

    The transfer amount in USD cents. Must be positive.

  • debtor_account_number (String) —

    The account number of the account that sent the transfer.

  • debtor_name (String) —

    The name provided by the sender of the transfer.

  • debtor_routing_number (String) —

    The routing number of the account that sent the transfer.

  • remittance_information (String) —

    Additional information included with the transfer.

  • request_for_payment_id (String) —

    The identifier of a pending Request for Payment that this transfer will fulfill.

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

Returns:

See Also:



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb', line 36

def create(params)
  parsed, options = Increase::Simulations::InboundRealTimePaymentsTransferCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "simulations/inbound_real_time_payments_transfers",
    body: parsed,
    model: Increase::InboundRealTimePaymentsTransfer,
    options: options
  )
end