masspay_ruby_sdk 1.0.0

data/lib/masspay_ruby_sdk/api/payout_api.rb

@@ -0,0 +1,397 @@
+=begin
+#MassPay API
+
+#MassPay API
+
+The version of the OpenAPI document: 0.1.4
+Contact: support@masspay.io
+Generated by: MassPay Inc.
+OpenAPI Generator version: 6.5.0
+=end
+
+require 'cgi'
+
+module MassPayRubySdk
+  class PayoutApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Commit payout transaction
+    # This **PUT** endpoint is used to commit a previously created payout transaction. <br> Once a payout transaction is created, you can use this endpoint to commit the transaction and initiate the actual payout. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` of the payout transaction you want to commit in the URL Path. <br> The response will include a JSON object containing details about the committed payout transaction, including the `payout_token`, `payout_status`, `pickup_code` and possible errors.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [PayoutTxnCommitResp]
+    def commit_payout_txn(user_token, payout_token, opts = {})
+      data, _status_code, _headers = commit_payout_txn_with_http_info(user_token, payout_token, opts)
+      data
+    end
+
+    # Commit payout transaction
+    # This **PUT** endpoint is used to commit a previously created payout transaction. &lt;br&gt; Once a payout transaction is created, you can use this endpoint to commit the transaction and initiate the actual payout. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; and &#x60;payout_token&#x60; of the payout transaction you want to commit in the URL Path. &lt;br&gt; The response will include a JSON object containing details about the committed payout transaction, including the &#x60;payout_token&#x60;, &#x60;payout_status&#x60;, &#x60;pickup_code&#x60; and possible errors.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [Array<(PayoutTxnCommitResp, Integer, Hash)>] PayoutTxnCommitResp data, response status code and response headers
+    def commit_payout_txn_with_http_info(user_token, payout_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutApi.commit_payout_txn ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling PayoutApi.commit_payout_txn"
+      end
+      # verify the required parameter 'payout_token' is set
+      if @api_client.config.client_side_validation && payout_token.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_token' when calling PayoutApi.commit_payout_txn"
+      end
+      # resource path
+      local_var_path = '/payout/{user_token}/{payout_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s)).sub('{' + 'payout_token' + '}', CGI.escape(payout_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutTxnCommitResp'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"PayoutApi.commit_payout_txn",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutApi#commit_payout_txn\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get status of a payout by payout token
+    # This **GET** endpoint is used to retrieve the status of a payout transaction for a user with the specified token and payout token. <br> You can use this endpoint to check the status of a specific payout transaction, including whether the payout has been successfully processed or if there was an error. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` in the URL Path. <br> The response will include a JSON object containing details about the payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Boolean] :force_status_update Attempts to get an updated status update from the payout destination (default to false)
+    # @option opts [Boolean] :include_payer_logo Whether to include the payer logo in base64 format. 
+    # @return [PayoutTxnResp]
+    def get_payout_status(user_token, payout_token, opts = {})
+      data, _status_code, _headers = get_payout_status_with_http_info(user_token, payout_token, opts)
+      data
+    end
+
+    # Get status of a payout by payout token
+    # This **GET** endpoint is used to retrieve the status of a payout transaction for a user with the specified token and payout token. &lt;br&gt; You can use this endpoint to check the status of a specific payout transaction, including whether the payout has been successfully processed or if there was an error. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; and &#x60;payout_token&#x60; in the URL Path. &lt;br&gt; The response will include a JSON object containing details about the payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Boolean] :force_status_update Attempts to get an updated status update from the payout destination (default to false)
+    # @option opts [Boolean] :include_payer_logo Whether to include the payer logo in base64 format. 
+    # @return [Array<(PayoutTxnResp, Integer, Hash)>] PayoutTxnResp data, response status code and response headers
+    def get_payout_status_with_http_info(user_token, payout_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutApi.get_payout_status ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling PayoutApi.get_payout_status"
+      end
+      # verify the required parameter 'payout_token' is set
+      if @api_client.config.client_side_validation && payout_token.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_token' when calling PayoutApi.get_payout_status"
+      end
+      # resource path
+      local_var_path = '/payout/{user_token}/{payout_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s)).sub('{' + 'payout_token' + '}', CGI.escape(payout_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'force_status_update'] = opts[:'force_status_update'] if !opts[:'force_status_update'].nil?
+      query_params[:'include_payer_logo'] = opts[:'include_payer_logo'] if !opts[:'include_payer_logo'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutTxnResp'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"PayoutApi.get_payout_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutApi#get_payout_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get transaction confirmation details
+    # This **PATCH** endpoint is used to obtain a PDF document with all the details of a payout transaction for a user with the specified token and payout token. <br> You can use this endpoint to obtain confirmation details about a specific payout transaction. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` in the URL Path. <br> The response will include a PDF document containing all the details of the payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [GetTransactionConfirmationDetails200Response]
+    def get_transaction_confirmation_details(user_token, payout_token, opts = {})
+      data, _status_code, _headers = get_transaction_confirmation_details_with_http_info(user_token, payout_token, opts)
+      data
+    end
+
+    # Get transaction confirmation details
+    # This **PATCH** endpoint is used to obtain a PDF document with all the details of a payout transaction for a user with the specified token and payout token. &lt;br&gt; You can use this endpoint to obtain confirmation details about a specific payout transaction. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; and &#x60;payout_token&#x60; in the URL Path. &lt;br&gt; The response will include a PDF document containing all the details of the payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_token [String] Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [Array<(GetTransactionConfirmationDetails200Response, Integer, Hash)>] GetTransactionConfirmationDetails200Response data, response status code and response headers
+    def get_transaction_confirmation_details_with_http_info(user_token, payout_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutApi.get_transaction_confirmation_details ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling PayoutApi.get_transaction_confirmation_details"
+      end
+      # verify the required parameter 'payout_token' is set
+      if @api_client.config.client_side_validation && payout_token.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_token' when calling PayoutApi.get_transaction_confirmation_details"
+      end
+      # resource path
+      local_var_path = '/payout/{user_token}/{payout_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s)).sub('{' + 'payout_token' + '}', CGI.escape(payout_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetTransactionConfirmationDetails200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"PayoutApi.get_transaction_confirmation_details",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutApi#get_transaction_confirmation_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get history of payouts by user token
+    # This **GET** endpoint is used to retrieve the payout history for a user with the specified token. <br> You can use this endpoint to view all payouts made to a user, including the `payout_token`, `destinantion_token` and `destination_amount`. <br> To use this endpoint, you need to provide the user token of the recipient in the URL Path. <br> The response will include a JSON object containing an array of payout transactions for the specified user, with each transaction including details such as the transaction ID, payout amount, currency, payout status, and date and time of the payout.
+    # @param user_token [String] The user token that needs to be fetched.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Boolean] :include_payer_logos Whether to include the payers logo in base64 format.  (default to false)
+    # @return [Array<PayoutTxnResp>]
+    def get_user_payouts_by_token(user_token, opts = {})
+      data, _status_code, _headers = get_user_payouts_by_token_with_http_info(user_token, opts)
+      data
+    end
+
+    # Get history of payouts by user token
+    # This **GET** endpoint is used to retrieve the payout history for a user with the specified token. &lt;br&gt; You can use this endpoint to view all payouts made to a user, including the &#x60;payout_token&#x60;, &#x60;destinantion_token&#x60; and &#x60;destination_amount&#x60;. &lt;br&gt; To use this endpoint, you need to provide the user token of the recipient in the URL Path. &lt;br&gt; The response will include a JSON object containing an array of payout transactions for the specified user, with each transaction including details such as the transaction ID, payout amount, currency, payout status, and date and time of the payout.
+    # @param user_token [String] The user token that needs to be fetched.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Boolean] :include_payer_logos Whether to include the payers logo in base64 format.  (default to false)
+    # @return [Array<(Array<PayoutTxnResp>, Integer, Hash)>] Array<PayoutTxnResp> data, response status code and response headers
+    def get_user_payouts_by_token_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutApi.get_user_payouts_by_token ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling PayoutApi.get_user_payouts_by_token"
+      end
+      # resource path
+      local_var_path = '/payout/{user_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'include_payer_logos'] = opts[:'include_payer_logos'] if !opts[:'include_payer_logos'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<PayoutTxnResp>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"PayoutApi.get_user_payouts_by_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutApi#get_user_payouts_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Initiate a payout transaction
+    # This **POST** endpoint is used to initiate a payout transaction from your account to a user with a specified token. <br> You can use this endpoint to pay out funds to your users, such as payments for services rendered or rewards for completing tasks. To use this endpoint, you need to provide the user token of the recipient in the URL Path. <br> The request body should include the funding source (`source_token`), payout destination (`destination_token`) and specify in which currency the payout should be made (`destination_currency_code`). <br> As a response API will return all details about your payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_txn [PayoutTxn] Payout parameters for a quote
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Float] :limit Limit amount for transaction amount + fee. If fee + amount are higher than the limit, the output will automatically adjust to maximize the possible amount sent
+    # @return [PayoutTxnResp]
+    def initiate_payout(user_token, payout_txn, opts = {})
+      data, _status_code, _headers = initiate_payout_with_http_info(user_token, payout_txn, opts)
+      data
+    end
+
+    # Initiate a payout transaction
+    # This **POST** endpoint is used to initiate a payout transaction from your account to a user with a specified token. &lt;br&gt; You can use this endpoint to pay out funds to your users, such as payments for services rendered or rewards for completing tasks. To use this endpoint, you need to provide the user token of the recipient in the URL Path. &lt;br&gt; The request body should include the funding source (&#x60;source_token&#x60;), payout destination (&#x60;destination_token&#x60;) and specify in which currency the payout should be made (&#x60;destination_currency_code&#x60;). &lt;br&gt; As a response API will return all details about your payout transaction.
+    # @param user_token [String] Token representing the user to pay out
+    # @param payout_txn [PayoutTxn] Payout parameters for a quote
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Float] :limit Limit amount for transaction amount + fee. If fee + amount are higher than the limit, the output will automatically adjust to maximize the possible amount sent
+    # @return [Array<(PayoutTxnResp, Integer, Hash)>] PayoutTxnResp data, response status code and response headers
+    def initiate_payout_with_http_info(user_token, payout_txn, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutApi.initiate_payout ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling PayoutApi.initiate_payout"
+      end
+      # verify the required parameter 'payout_txn' is set
+      if @api_client.config.client_side_validation && payout_txn.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_txn' when calling PayoutApi.initiate_payout"
+      end
+      pattern = Regexp.new(/^[\d.]+$/)
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling PayoutApi.initiate_payout, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/payout/{user_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(payout_txn)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutTxnResp'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"PayoutApi.initiate_payout",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutApi#initiate_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/masspay_ruby_sdk/api/spend_back_api.rb

@@ -0,0 +1,160 @@
+=begin
+#MassPay API
+
+#MassPay API
+
+The version of the OpenAPI document: 0.1.4
+Contact: support@masspay.io
+Generated by: MassPay Inc.
+OpenAPI Generator version: 6.5.0
+=end
+
+require 'cgi'
+
+module MassPayRubySdk
+  class SpendBackApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get history of spend backs by user token
+    # This **GET** endpoint is used to retrieve the history of spendbacks for a specific user token. <br> You can use this endpoint to help manage your payment operations and track the usage of funds by your users. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path. <br> The endpoint will then return a list of all the historical spendbacks for the provided user token. The response will contain a JSON array with details for each spendback transaction.
+    # @param user_token [String] Token representing the user to fetch/initiate spend back
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [Array<SpendBacks>]
+    def get_user_spendbacks_by_token(user_token, opts = {})
+      data, _status_code, _headers = get_user_spendbacks_by_token_with_http_info(user_token, opts)
+      data
+    end
+
+    # Get history of spend backs by user token
+    # This **GET** endpoint is used to retrieve the history of spendbacks for a specific user token. &lt;br&gt; You can use this endpoint to help manage your payment operations and track the usage of funds by your users. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; as a parameter in the URL Path. &lt;br&gt; The endpoint will then return a list of all the historical spendbacks for the provided user token. The response will contain a JSON array with details for each spendback transaction.
+    # @param user_token [String] Token representing the user to fetch/initiate spend back
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @return [Array<(Array<SpendBacks>, Integer, Hash)>] Array<SpendBacks> data, response status code and response headers
+    def get_user_spendbacks_by_token_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpendBackApi.get_user_spendbacks_by_token ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling SpendBackApi.get_user_spendbacks_by_token"
+      end
+      # resource path
+      local_var_path = '/spendback/{user_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<SpendBacks>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"SpendBackApi.get_user_spendbacks_by_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpendBackApi#get_user_spendbacks_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Initiate a spend back transaction
+    # This **POST** endpoint is used to initiate a spendback transaction to a provided user token. <br> You can use this endpoint to enable spendback transactions for your users and help them manage their funds more effectively. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path, along with the required parameters in the request Body, including `client_spendback_id`, `source_token`, `source_currency_code` and `amount`. <br> The endpoint will then initiate the spendback transaction, transferring funds from the source token to the user token. The response will contain a JSON object indicating the status of the request and any relevant transaction details.
+    # @param user_token [String] Token representing the user to fetch/initiate spend back
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [SpendBackTxn] :spend_back_txn Spend back information
+    # @return [SpendBackTxnResp]
+    def initiate_spendback(user_token, opts = {})
+      data, _status_code, _headers = initiate_spendback_with_http_info(user_token, opts)
+      data
+    end
+
+    # Initiate a spend back transaction
+    # This **POST** endpoint is used to initiate a spendback transaction to a provided user token. &lt;br&gt; You can use this endpoint to enable spendback transactions for your users and help them manage their funds more effectively. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; as a parameter in the URL Path, along with the required parameters in the request Body, including &#x60;client_spendback_id&#x60;, &#x60;source_token&#x60;, &#x60;source_currency_code&#x60; and &#x60;amount&#x60;. &lt;br&gt; The endpoint will then initiate the spendback transaction, transferring funds from the source token to the user token. The response will contain a JSON object indicating the status of the request and any relevant transaction details.
+    # @param user_token [String] Token representing the user to fetch/initiate spend back
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [SpendBackTxn] :spend_back_txn Spend back information
+    # @return [Array<(SpendBackTxnResp, Integer, Hash)>] SpendBackTxnResp data, response status code and response headers
+    def initiate_spendback_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpendBackApi.initiate_spendback ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling SpendBackApi.initiate_spendback"
+      end
+      # resource path
+      local_var_path = '/spendback/{user_token}'.sub('{' + 'user_token' + '}', CGI.escape(user_token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'spend_back_txn'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SpendBackTxnResp'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"SpendBackApi.initiate_spendback",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpendBackApi#initiate_spendback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/masspay_ruby_sdk/api/tax_api.rb

@@ -0,0 +1,82 @@
+=begin
+#MassPay API
+
+#MassPay API
+
+The version of the OpenAPI document: 0.1.4
+Contact: support@masspay.io
+Generated by: MassPay Inc.
+OpenAPI Generator version: 6.5.0
+=end
+
+require 'cgi'
+
+module MassPayRubySdk
+  class TaxApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get List Of Users Annual Balance
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :amount_threshold If specified, only show users whose total balance exceeds the provided amount
+    # @option opts [Integer] :tax_year The year for which we would like to obtain tax information for. If none provided, defaults to previous year.
+    # @return [Array<TaxYearUserResp>]
+    def get_tax_users(opts = {})
+      data, _status_code, _headers = get_tax_users_with_http_info(opts)
+      data
+    end
+
+    # Get List Of Users Annual Balance
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :amount_threshold If specified, only show users whose total balance exceeds the provided amount
+    # @option opts [Integer] :tax_year The year for which we would like to obtain tax information for. If none provided, defaults to previous year.
+    # @return [Array<(Array<TaxYearUserResp>, Integer, Hash)>] Array<TaxYearUserResp> data, response status code and response headers
+    def get_tax_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_users ...'
+      end
+      # resource path
+      local_var_path = '/tax'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'amount_threshold'] = opts[:'amount_threshold'] if !opts[:'amount_threshold'].nil?
+      query_params[:'tax_year'] = opts[:'tax_year'] if !opts[:'tax_year'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<TaxYearUserResp>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"TaxApi.get_tax_users",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TaxApi#get_tax_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end