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

Inherits:

Object

• Object
• Increase::Resources::Simulations::RealTimePaymentsTransfers

Defined in:

lib/increase/resources/simulations/real_time_payments_transfers.rb

Instance Method Summary

• #complete(real_time_payments_transfer_id, rejection: nil, request_options: {}) ⇒ Increase::Models::RealTimePaymentsTransfer

  Simulates submission of a [Real-Time Payments Transfer](#real-time-payments-transfers) and handling the response from the destination financial institution.

• #initialize(client:) ⇒ RealTimePaymentsTransfers constructor private

  A new instance of RealTimePaymentsTransfers.

Constructor Details

#initialize(client:) ⇒ RealTimePaymentsTransfers

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

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/simulations/real_time_payments_transfers.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#complete(real_time_payments_transfer_id, rejection: nil, request_options: {}) ⇒ Increase::Models::RealTimePaymentsTransfer

Simulates submission of a [Real-Time Payments Transfer](#real-time-payments-transfers) 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.

• rejection (Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection) —

  If set, the simulation will reject the transfer.

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

Returns:

• (Increase::Models::RealTimePaymentsTransfer)

See Also:

• Models::Simulations::RealTimePaymentsTransferCompleteParams

# File 'lib/increase/resources/simulations/real_time_payments_transfers.rb', line 23

def complete(real_time_payments_transfer_id, params = {})
  parsed, options = Increase::Simulations::RealTimePaymentsTransferCompleteParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["simulations/real_time_payments_transfers/%1$s/complete", real_time_payments_transfer_id],
    body: parsed,
    model: Increase::RealTimePaymentsTransfer,
    options: options
  )
end