lib/velopayments/api/payees_api.rb
# List Payees
# &lt;p&gt;Use v4 instead&lt;/p&gt; Get a paginated response listing the payees for a payor. 
# @param payor_id [String] The account owner Payor ID
# @param [Hash] opts the optional parameters
# @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
# @option opts [Boolean] :disabled Payee disabled
# @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
# @option opts [String] :email Email address
# @option opts [String] :display_name The display name of the payees.
# @option opts [String] :remote_id The remote id of the payees.
# @option opts [PayeeType] :payee_type The onboarded status of the payees.
# @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
# @option opts [Integer] :page Page number. Default is 1.
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
# @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
# @return [Array<(PagedPayeeResponse, Integer, Hash)>] PagedPayeeResponse data, response status code and response headers
List Payees
<p>Use v4 instead</p> Get a paginated response listing the payees for a payor.
List Payees <p > Use v4 instead< / p > Get a paginated response listing the payees for a payor .
def list_payees_v3_with_http_info(payor_id, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v3 ...'
      end
      if @api_client.config.client_side_validation && payor_id.nil?
        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v3"
      end
      pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
      if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
        fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v3, must conform to the pattern #{pattern}."
      end
      local_var_path = '/v3/payees'
      query_params = opts[:query_params] || {}
      query_params[:'payorId'] = payor_id
      query_params[:'watchlistStatus'] = opts[:'watchlist_status'] if !opts[:'watchlist_status'].nil?
      query_params[:'disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil?
      query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
      query_params[:'displayName'] = opts[:'display_name'] if !opts[:'display_name'].nil?
      query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
      query_params[:'payeeType'] = opts[:'payee_type'] if !opts[:'payee_type'].nil?
      query_params[:'payeeCountry'] = opts[:'payee_country'] if !opts[:'payee_country'].nil?
      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type] || 'PagedPayeeResponse'
      auth_names = opts[:debug_auth_names] || ['OAuth2']
      new_options = opts.merge(
        :operation => :"PayeesApi.list_payees_v3",
        :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: PayeesApi#list_payees_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def list_payees_v3_with_http_info ( payor_id , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PayeesApi.list_payees_v3 ...' end if @api_client . config . client_side_validation && payor_id . nil? fail ArgumentError , "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v3" end pattern = Regexp . new ( / [a-zA-Z]+[:desc|:asc] / ) if @api_client . config . client_side_validation && ! opts [ :' sort ' ] . nil? && opts [ :' sort ' ] !~ pattern fail ArgumentError , "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v3, must conform to the pattern #{pattern}." end local_var_path = '/v3/payees' query_params = opts [ :query_params ] || { } query_params [ :' payorId ' ] = payor_id query_params [ :' watchlistStatus ' ] = opts [ :' watchlist_status ' ] if ! opts [ :' watchlist_status ' ] . nil? query_params [ :' disabled ' ] = opts [ :' disabled ' ] if ! opts [ :' disabled ' ] . nil? query_params [ :' onboardedStatus ' ] = opts [ :' onboarded_status ' ] if ! opts [ :' onboarded_status ' ] . nil? query_params [ :' email ' ] = opts [ :' email ' ] if ! opts [ :' email ' ] . nil? query_params [ :' displayName ' ] = opts [ :' display_name ' ] if ! opts [ :' display_name ' ] . nil? query_params [ :' remoteId ' ] = opts [ :' remote_id ' ] if ! opts [ :' remote_id ' ] . nil? query_params [ :' payeeType ' ] = opts [ :' payee_type ' ] if ! opts [ :' payee_type ' ] . nil? query_params [ :' payeeCountry ' ] = opts [ :' payee_country ' ] if ! opts [ :' payee_country ' ] . nil? query_params [ :' page ' ] = opts [ :' page ' ] if ! opts [ :' page ' ] . nil? query_params [ :' pageSize ' ] = opts [ :' page_size ' ] if ! opts [ :' page_size ' ] . nil? query_params [ :' sort ' ] = opts [ :' sort ' ] if ! opts [ :' sort ' ] . nil? header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] || 'PagedPayeeResponse' auth_names = opts [ :debug_auth_names ] || [ 'OAuth2' ] new_options = opts . merge ( :operation => :" PayeesApi.list_payees_v3 " , :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: PayeesApi#list_payees_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
List Payees
&lt;p&gt;Use v4 instead&lt;/p&gt; Get a paginated response listing the payees for a payor.
List Payees &lt ; p&gt ; Use v4 instead&lt ; / p&gt ; Get a paginated response listing the payees for a payor .
# verify the required parameter 'payor_id' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
PagedPayeeResponse data, response status code and response headers
PagedPayeeResponse data response status code and response headers
Array<(PagedPayeeResponse, Integer, Hash)>
payor_id
The account owner Payor ID
The account owner Payor ID
opts
:sort List of sort fields  Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
: sort List of sort fields Default is name : asc ' name ' is treated as company name for companies - last name + ' ' + firstName for individuals The supported sort fields are - payeeId displayName payoutStatus onboardedStatus .
<not_specific>
opts the optional parameters
opts the optional parameters