Class: FinchAPI::Resources::Sandbox::Payment

Inherits:

Object

• Object
• FinchAPI::Resources::Sandbox::Payment

Defined in:

lib/finch_api/resources/sandbox/payment.rb

Instance Method Summary

• #create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) ⇒ FinchAPI::Models::Sandbox::PaymentCreateResponse

  Add a new sandbox payment.

• #initialize(client:) ⇒ Payment constructor private

  A new instance of Payment.

Constructor Details

#initialize(client:) ⇒ Payment

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

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/sandbox/payment.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) ⇒ FinchAPI::Models::Sandbox::PaymentCreateResponse

Add a new sandbox payment

Parameters:

• end_date (Date)
• pay_statements (Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>) —

  Array of pay statements to include in the payment.

• start_date (Date)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (FinchAPI::Models::Sandbox::PaymentCreateResponse)

See Also:

• Models::Sandbox::PaymentCreateParams

# File 'lib/finch_api/resources/sandbox/payment.rb', line 22

def create(params = {})
  parsed, options = FinchAPI::Sandbox::PaymentCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "sandbox/payment",
    body: parsed,
    model: FinchAPI::Models::Sandbox::PaymentCreateResponse,
    options: options
  )
end