Class: Increase::Resources::Simulations::RealTimePaymentsTransfers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RealTimePaymentsTransfers

Returns a new instance of RealTimePaymentsTransfers.



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

def initialize(client:)
  @client = client
end

Instance Method Details

#complete(real_time_payments_transfer_id, params = {}, opts = {}) ⇒ Increase::Models::RealTimePaymentsTransfer

Simulates submission of a Real-Time Payments transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.

Parameters:

  • real_time_payments_transfer_id (String) —

    The identifier of the Real-Time Payments Transfer you wish to complete.

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

  • :rejection (Rejection) —

    If set, the simulation will reject the transfer.

Returns:



23
24
25
26
27
28
29
30
 
# File 'lib/increase/resources/simulations/real_time_payments_transfers.rb', line 23

def complete(real_time_payments_transfer_id, params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/real_time_payments_transfers/#{real_time_payments_transfer_id}/complete"
  req[:body] = params
  req[:model] = Increase::Models::RealTimePaymentsTransfer
  @client.request(req, opts)
end