unit_ruby_sdk 1.1.0 → 1.2.0

data/lib/unit/models/payment/payment.rb

@@ -14,6 +14,8 @@ module Unit
     autoload :ListPaymentParams, "unit/models/payment/list_payment_params"
     autoload :GetRequest, "unit/models/payment/get_request"
     autoload :BulkPaymentRequest, "unit/models/payment/bulk_payment_request"
+    autoload :CreateBatchReleaseRequest, "unit/models/payment/create_batch_release_request"
+    autoload :BatchReleaseRequestBuilder, "unit/models/payment/batch_release_request_builder"
     class << self
       # Create a new book payment by calling Unit's API
       # @see https://docs.unit.co/book-payments#book-payments
@@ -181,6 +183,24 @@ module Unit
         request = Unit::Payment::BulkPaymentRequest.serialize(requests)
         Unit::Resource::PaymentResource.create_bulk_payment(request)
       end
-    end
+
+      # Create a batch release
+      # @see https://docs.unit.co/batch-payments/#create-batch-releases
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param sender_name [String]
+      # @param sender_address [Address]
+      # @param sender_account_number [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_batch_release(requests)
+        payload = BatchReleaseRequestBuilder.new
+        requests.each do |req|
+          payload.add_request(req[:account_id], req[:batch_account_id], req[:amount], req[:description], req[:sender_name], req[:sender_address], req[:sender_account_number], req[:tags], req[:idempotency_key])
+        end
+        Unit::Resource::PaymentResource.create_batch_release(payload.to_hash)
+      end
+     end
   end
 end

data/lib/unit/models/received_payment/list_payment_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Request to list ach received payments by calling Unit's API
+# @see https://docs.unit.co/received-ach#list-received-payments
+module Unit
+  module ReceivedPayment
+    class ListPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :status,
+                  :include_completed, :tags, :sort, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include_completed [Boolean] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = RECEIVED_PAYMENT_LIMIT, offset = ACH_PAYMENT_OFFSET, account_id = nil, customer_id = nil, status = nil,
+                     include_completed = nil, tags = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @status = status
+        @include_completed = include_completed
+        @tags = tags
+        @sort = sort
+        @include = include
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[includeCompleted]": include_completed,
+          "filter[tags]": tags,
+          "sort": sort,
+          "include": include&.join(",")
+        }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/received_payment/patch_payment_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to update a received ACH payment
+# @see https://docs.unit.co/received-ach#update-received-payment
+module Unit
+  module ReceivedPayment
+    class PatchPaymentRequest
+      attr_reader :payment_id, :tags
+
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def initialize(payment_id, tags = nil)
+        @payment_id = payment_id
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "achReceivedPayment",
+            "attributes": {
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/received_payment/received_payment.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Unit
+  module ReceivedPayment
+    RECEIVED_PAYMENT_LIMIT = 100
+    RECEIVED_PAYMENT_OFFSET = 0
+
+    autoload :PatchPaymentRequest, "unit/models/received_payment/patch_payment_request"
+    autoload :ListPaymentParams, "unit/models/received_payment/list_payment_params"
+
+    class << self
+      # Get received ach payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#get-specific-received-payment
+      # @param payment_id [String]
+      def get_payment(payment_id:)
+        Unit::Resource::ReceivedPaymentResource.get_payment(payment_id)
+      end
+
+      # Update a received ACH payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#update-received-payment
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def update_payment(payment_id:, tags: nil)
+        request = Unit::ReceivedPayment::PatchPaymentRequest.new(payment_id, tags)
+        Unit::Resource::ReceivedPaymentResource.update_payment(request)
+      end
+
+      # List ach payments by calling Unit's API
+      # @see https://docs.unit.co/received-ach#list-received-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include_completed [Boolean] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_payments(limit: RECEIVED_PAYMENT_LIMIT, offset: RECEIVED_PAYMENT_OFFSET, account_id: nil, customer_id: nil, status: nil,
+                        include_completed: nil, tags: nil, sort: nil, include: nil)
+        request = Unit::ReceivedPayment::ListPaymentParams.new(limit, offset, account_id, customer_id, status,
+                                                               include_completed, tags, sort, include)
+        Unit::Resource::ReceivedPaymentResource.list_payments(request)
+      end
+
+      # Advance a received payment by calling Unit's API
+      # @see https://docs.unit.co/received-ach#advance-received-payment
+      # @param payment_id [String]
+      def advance_payment(payment_id:)
+        Unit::Resource::ReceivedPaymentResource.advance_payment(payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/create_recurring_credit_ach_payment_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Request to create a recurring credit ach payment
+# @see https://docs.unit.co/recurring-payments/#recurring-payment-credit-ach-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringCreditAchPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :addenda, :schedule, :idempotency_key, :tags
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule, addenda = nil, idempotency_key = nil, tags = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @addenda = addenda
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringCreditAchPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "addenda": addenda,
+              "schedule": schedule&.represent,
+              "idempotencyKey": idempotency_key,
+              "tags": tags
+            },
+            "relationships": {
+              account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              counterparty: Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/create_recurring_credit_book_payment_request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Request to create a recurring credit book payment
+# @see https://docs.unit.co/recurring-payments/#recurring-credit-book-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringCreditBookPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :schedule, :transaction_summary_override, :idempotency_key, :tags
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule,
+                     transaction_summary_override = nil, idempotency_key = nil, tags = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @transaction_summary_override = transaction_summary_override
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringCreditBookPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "schedule": schedule&.represent,
+              "transaction_summary_override": transaction_summary_override,
+              "idempotencyKey": idempotency_key,
+              "tags": tags
+            },
+            "relationships":
+              {
+                account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+                counterpartyAccount: Unit::Types::Relationship.new("depositAccount", counterparty_id).to_hash
+              }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/create_recurring_debit_ach_payment_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Create a recurring debit ACH payment request
+# @see https://docs.unit.co/recurring-payments/#recurring-payment-debit-ach-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringDebitAchPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :addenda, :schedule, :idempotency_key, :tags,
+                  :verify_counterparty_balance, :same_day
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule, addenda = nil, idempotency_key = nil, tags = nil,
+                     verify_counterparty_balance = nil, same_day = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @addenda = addenda
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @verify_counterparty_balance = verify_counterparty_balance
+        @same_day = same_day
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringDebitAchPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "addenda": addenda,
+              "schedule": schedule&.represent,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "verifyCounterpartyBalance": verify_counterparty_balance,
+              "sameDay": same_day
+            },
+            "relationships": {
+              account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              counterparty: Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/list_recurring_payment_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Params for listing recurring payments
+# @see https://docs.unit.co/recurring-payments/#list-recurring-payments
+module Unit
+  module RecurringPayment
+    class ListRecurringPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :status, :type,
+                  :from_start_time, :to_start_time, :from_end_time, :to_end_time, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array] - optional
+      # @param type [Array] - optional
+      # @param from_start_time [String] - optional
+      # @param to_start_time [String] - optional
+      # @param from_end_time [String] - optional
+      # @param to_end_time [String] - optional
+      # @param sort [String] - optional
+      def initialize(limit = RECURRING_PAYMENT_LIMIT, offset = RECURRING_PAYMENT_OFFSET, account_id = nil, customer_id = nil, status = nil, type = nil,
+                     from_start_time = nil, to_start_time = nil, from_end_time = nil, to_end_time = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @status = status
+        @type = type
+        @from_start_date = from_start_time
+        @to_start_date = to_start_time
+        @from_end_date = from_end_time
+        @to_end_date = to_end_time
+        @sort = sort
+      end
+
+      def to_hash
+        payload = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[fromStartTime]": from_start_time,
+          "filter[toStartTime]": to_start_time,
+          "filter[fromEndTime]": from_end_time,
+          "filter[toEndTime]": to_end_time,
+          "sort": sort
+        }
+        filters = %i[status type]
+        filters.each do |filter|
+          values = send(filter)
+          values&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[#{filter}][#{index}]": val })
+          end
+        end
+        payload.compact!
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/recurring_payment.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Unit
+  module RecurringPayment
+    RECURRING_PAYMENT_LIMIT = 100
+    RECURRING_PAYMENT_OFFSET = 0
+    autoload :CreateRecurringCreditBookPaymentRequest, "unit/models/recurring_payment/create_recurring_credit_book_payment_request"
+    autoload :CreateRecurringCreditAchPaymentRequest, "unit/models/recurring_payment/create_recurring_credit_ach_payment_request"
+    autoload :CreateRecurringDebitAchPaymentRequest, "unit/models/recurring_payment/create_recurring_debit_ach_payment_request"
+    autoload :ListRecurringPaymentParams, "unit/models/recurring_payment/list_recurring_payment_params"
+
+    class << self
+      # Create a recurring credit book payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-credit-book-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def create_recurring_credit_book_payment(account_id:, counterparty_id:, amount:, description:,
+                                               schedule:, transaction_summary_override: nil, idempotency_key: nil, tags: nil)
+        request = Unit::RecurringPayment::CreateRecurringCreditBookPaymentRequest.new(account_id, counterparty_id, amount, description, schedule,
+                                                                                      transaction_summary_override, idempotency_key, tags)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Create a recurring credit ACH payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-payment-credit-ach-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def create_recurring_credit_ach_payment(account_id:, counterparty_id:, amount:, description:, schedule:, addenda: nil, idempotency_key: nil, tags: nil)
+        request = Unit::RecurringPayment::CreateRecurringCreditAchPaymentRequest.new(account_id, counterparty_id, amount, description, schedule, addenda, idempotency_key, tags)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Create a recurring debit ACH payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-payment-debit-ach-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      def create_recurring_debit_ach_payment(account_id:, counterparty_id:, amount:, description:, schedule:, addenda: nil, idempotency_key: nil, tags: nil,
+                                             verify_counterparty_balance: nil, same_day: nil)
+        request = Unit::RecurringPayment::CreateRecurringDebitAchPaymentRequest.new(account_id, counterparty_id, amount, description, schedule, addenda, idempotency_key, tags,
+                                                                                    verify_counterparty_balance, same_day)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Enable a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#enable-recurring-payment
+      # @param recurring_payment_id [String]
+      def enable_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.enable_recurring_payment(recurring_payment_id)
+      end
+
+      # Disable a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#disable-recurring-payment
+      # @param recurring_payment_id [String]
+      def disable_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.disable_recurring_payment(recurring_payment_id)
+      end
+
+      # List recurring payments
+      # @see https://docs.unit.co/recurring-payments/#list-recurring-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [String] - optional
+      # @param type [String] - optional
+      # @param from_start_time [String] - optional
+      # @param to_start_time [String] - optional
+      # @param from_end_time [String] - optional
+      # @param to_end_time [String] - optional
+      # @param sort [String] - optional
+      def list_recurring_payment(limit: RECURRING_PAYMENT_LIMIT, offset: RECURRING_PAYMENT_OFFSET, account_id: nil, customer_id: nil, status: nil, type: nil,
+                                 from_start_time: nil, to_start_time: nil, from_end_time: nil, to_end_time: nil, sort: nil)
+        request = Unit::RecurringPayment::ListRecurringPaymentParams.new(limit, offset, account_id, customer_id, status, type,
+                                                                         from_start_time, to_start_time, from_end_time, to_end_time, sort)
+        Unit::Resource::RecurringPaymentResource.list_recurring_payment(request)
+      end
+
+      # Get a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#get-specific-recurring-payment
+      # @param recurring_payment_id [String]
+      def get_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.get_recurring_payment(recurring_payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/create_ach_repayment_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Request to create an ach repayment
+# @see https://docs.unit.co/repayments/#create-ach-repayment
+module Unit
+  module Repayment
+    class CreateAchRepaymentRequest
+      attr_reader :account_id, :credit_account_id, :counterparty_id, :description,
+                  :amount, :addenda, :tags, :same_day, :idempotency_key
+
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param addenda [String] - optional
+      # @param tags [Hash] - optional
+      # @param same_day [Boolean] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, credit_account_id, counterparty_id, description, amount, addenda = nil, tags = nil,
+                     idempotency_key = nil, same_day: false)
+        @account_id = account_id
+        @credit_account_id = credit_account_id
+        @counterparty_id = counterparty_id
+        @description = description
+        @amount = amount
+        @addenda = addenda
+        @tags = tags
+        @same_day = same_day
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "achRepayment",
+            attributes: {
+              description: description,
+              amount: amount,
+              addenda: addenda,
+              tags: tags,
+              sameDay: same_day,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "creditAccount": Unit::Types::Relationship.new("creditAccount", credit_account_id).to_hash,
+              "counterparty": Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/create_book_repayment_request.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Request to create a book repayment
+# @see https://docs.unit.co/repayments/#book-repayment
+module Unit
+  module Repayment
+    class CreateBookRepaymentRequest
+      attr_reader :account_id, :credit_account_id, :counterparty_account_id, :description, :amount, :transaction_summary_override,
+                  :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_account_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param transaction_summary_override [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, credit_account_id, counterparty_account_id, description, amount, transaction_summary_override, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @credit_account_id = credit_account_id
+        @counterparty_account_id = counterparty_account_id
+        @description = description
+        @amount = amount
+        @transaction_summary_override = transaction_summary_override
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "bookRepayment",
+            attributes: {
+              description: description,
+              amount: amount,
+              transactionSummaryOverride: transaction_summary_override,
+              tags: tags,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "creditAccount": Unit::Types::Relationship.new("creditAccount", credit_account_id).to_hash,
+              "counterpartyAccount": Unit::Types::Relationship.new("account", counterparty_account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/list_repayment_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Params for listing repayments
+# @see https://docs.unit.co/repayments/#list-repayments
+module Unit
+  module Repayment
+    class ListRepaymentParams
+      attr_reader :limit, :offset, :account_id, :credit_account_id,
+                  :customer_id, :status, :type
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param credit_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param type [Array<String>] - optional
+      def initialize(limit = REPAYMENT_LIMIT, offset = REPAYMENT_OFFSET, account_id = nil,
+                     credit_account_id = nil, customer_id = nil, status = nil, type = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @credit_account_id = credit_account_id
+        @customer_id = customer_id
+        @status = status
+        @type = type
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[creditAccountId]": credit_account_id,
+          "filter[customerId]": customer_id
+        }
+        filters = %i[status type]
+        filters.each do |filter|
+          values = send(filter)
+          values&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[#{filter}][#{index}]": val })
+          end
+        end
+        params.compact
+      end
+    end
+  end
+end