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

Returns a new instance of InboundRealTimePaymentsTransfers.



7
8
9
 
# File 'lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

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

Simulates an inbound Real-Time Payments transfer to your account. Real-Time Payments are a beta feature.

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_number_id (String) —

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

  • :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.

Returns:



27
28
29
30
31
32
33
34
 
# File 'lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb', line 27

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