lib/velopayments/api/payors_api.rb
# List Payor Links
# This endpoint allows you to list payor links
# @param [Hash] opts the optional parameters
# @option opts [String] :descendants_of_payor The Payor ID from which to start the query to show all descendants
# @option opts [String] :parent_of_payor Look for the parent payor details for this payor id
# @option opts [String] :fields List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - &#39;fields&#39; allows you to add to this. Example: &#x60;&#x60;&#x60;fields&#x3D;primaryContactEmail,kycState&#x60;&#x60;&#x60; - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState 
# @return [Array<(PayorLinksResponse, Integer, Hash)>] PayorLinksResponse data, response status code and response headers
List Payor Links
This endpoint allows you to list payor links
List Payor Links This endpoint allows you to list payor links
def payor_links_with_http_info(opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PayorsApi.payor_links ...'
      end
      local_var_path = '/v1/payorLinks'
      query_params = opts[:query_params] || {}
      query_params[:'descendantsOfPayor'] = opts[:'descendants_of_payor'] if !opts[:'descendants_of_payor'].nil?
      query_params[:'parentOfPayor'] = opts[:'parent_of_payor'] if !opts[:'parent_of_payor'].nil?
      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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] || 'PayorLinksResponse'
      auth_names = opts[:debug_auth_names] || ['OAuth2']
      new_options = opts.merge(
        :operation => :"PayorsApi.payor_links",
        :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: PayorsApi#payor_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def payor_links_with_http_info ( opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PayorsApi.payor_links ...' end local_var_path = '/v1/payorLinks' query_params = opts [ :query_params ] || { } query_params [ :' descendantsOfPayor ' ] = opts [ :' descendants_of_payor ' ] if ! opts [ :' descendants_of_payor ' ] . nil? query_params [ :' parentOfPayor ' ] = opts [ :' parent_of_payor ' ] if ! opts [ :' parent_of_payor ' ] . nil? query_params [ :' fields ' ] = opts [ :' fields ' ] if ! opts [ :' fields ' ] . 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 ] || 'PayorLinksResponse' auth_names = opts [ :debug_auth_names ] || [ 'OAuth2' ] new_options = opts . merge ( :operation => :" PayorsApi.payor_links " , :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: PayorsApi#payor_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
List Payor Links
This endpoint allows you to list payor links
List Payor Links This endpoint allows you to list payor links
# resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
PayorLinksResponse data, response status code and response headers
PayorLinksResponse data response status code and response headers
Array<(PayorLinksResponse, Integer, Hash)>
opts
:fields List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState
: fields List of additional Payor fields to include in the response for each Payor . The values of payorId and payorName and always included for each Payor - ' fields ' allows you to add to this . Example : ` ` ` fields = primaryContactEmail kycState ` ` ` - will include payorId + payorName + primaryContactEmail + kycState for each Payor Default if not specified is to include only payorId and payorName . The supported fields are any combination of : primaryContactEmail kycState
<not_specific>
opts the optional parameters
opts the optional parameters