class VeloPayments::PayeesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/velopayments/api/payees_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_payee_by_id_v1(payee_id, opts = {}) click to toggle source

Delete Payee by Id <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> <p>Please use V3 instead.</p> @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payees_api.rb, line 27
def delete_payee_by_id_v1(payee_id, opts = {})
  delete_payee_by_id_v1_with_http_info(payee_id, opts)
  nil
end
delete_payee_by_id_v1_with_http_info(payee_id, opts = {}) click to toggle source

Delete Payee by Id &lt;p&gt;This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:&lt;/p&gt; &lt;p&gt;* Payee ID is not found&lt;/p&gt; &lt;p&gt;* If Payee has not been on-boarded&lt;/p&gt; &lt;p&gt;* If Payee is in grace period&lt;/p&gt; &lt;p&gt;* If Payee has existing payments&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 37
def delete_payee_by_id_v1_with_http_info(payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id_v1 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id_v1"
  end
  # resource path
  local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_payee_by_id_v3(payee_id, opts = {}) click to toggle source

Delete Payee by Id <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payees_api.rb, line 87
def delete_payee_by_id_v3(payee_id, opts = {})
  delete_payee_by_id_v3_with_http_info(payee_id, opts)
  nil
end
delete_payee_by_id_v3_with_http_info(payee_id, opts = {}) click to toggle source

Delete Payee by Id &lt;p&gt;This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:&lt;/p&gt; &lt;p&gt;* Payee ID is not found&lt;/p&gt; &lt;p&gt;* If Payee has not been on-boarded&lt;/p&gt; &lt;p&gt;* If Payee is in grace period&lt;/p&gt; &lt;p&gt;* If Payee has existing payments&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 97
def delete_payee_by_id_v3_with_http_info(payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id_v3 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id_v3"
  end
  # resource path
  local_var_path = '/v3/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payee_by_id_v1(payee_id, opts = {}) click to toggle source

Get Payee by Id <p>Get Payee by Id</p> <p>Please use V3 instead.</p> @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Payee]

# File lib/velopayments/api/payees_api.rb, line 148
def get_payee_by_id_v1(payee_id, opts = {})
  data, _status_code, _headers = get_payee_by_id_v1_with_http_info(payee_id, opts)
  data
end
get_payee_by_id_v1_with_http_info(payee_id, opts = {}) click to toggle source

Get Payee by Id &lt;p&gt;Get Payee by Id&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Array<(Payee, Integer, Hash)>] Payee data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 159
def get_payee_by_id_v1_with_http_info(payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v1 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v1"
  end
  # resource path
  local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'Payee' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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#get_payee_by_id_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payee_by_id_v2(payee_id, opts = {}) click to toggle source

Get Payee by Id <p>Get Payee by Id</p> <p>Please use V3 instead.</p> @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [PayeeResponseV2]

# File lib/velopayments/api/payees_api.rb, line 213
def get_payee_by_id_v2(payee_id, opts = {})
  data, _status_code, _headers = get_payee_by_id_v2_with_http_info(payee_id, opts)
  data
end
get_payee_by_id_v2_with_http_info(payee_id, opts = {}) click to toggle source

Get Payee by Id &lt;p&gt;Get Payee by Id&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Array<(PayeeResponseV2, Integer, Hash)>] PayeeResponseV2 data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 224
def get_payee_by_id_v2_with_http_info(payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v2 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v2"
  end
  # resource path
  local_var_path = '/v2/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PayeeResponseV2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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#get_payee_by_id_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payee_by_id_v3(payee_id, opts = {}) click to toggle source

Get Payee by Id Get Payee by Id @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [PayeeResponseV3]

# File lib/velopayments/api/payees_api.rb, line 278
def get_payee_by_id_v3(payee_id, opts = {})
  data, _status_code, _headers = get_payee_by_id_v3_with_http_info(payee_id, opts)
  data
end
get_payee_by_id_v3_with_http_info(payee_id, opts = {}) click to toggle source

Get Payee by Id Get Payee by Id @param payee_id [String] The UUID of the payee. @param [Hash] opts the optional parameters @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Array<(PayeeResponseV3, Integer, Hash)>] PayeeResponseV3 data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 289
def get_payee_by_id_v3_with_http_info(payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v3 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v3"
  end
  # resource path
  local_var_path = '/v3/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PayeeResponseV3' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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#get_payee_by_id_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_payee_changes(payor_id, updated_since, opts = {}) click to toggle source

List Payee Changes <p>Get a paginated response listing payee changes.</p> <p>Please use V3 instead.</p> @param payor_id [String] The Payor ID to find associated Payees @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100) @return [PayeeDeltaResponse]

# File lib/velopayments/api/payees_api.rb, line 345
def list_payee_changes(payor_id, updated_since, opts = {})
  data, _status_code, _headers = list_payee_changes_with_http_info(payor_id, updated_since, opts)
  data
end
list_payee_changes_v3(payor_id, updated_since, opts = {}) click to toggle source

List Payee Changes Get a paginated response listing payee changes. @param payor_id [String] The Payor ID to find associated Payees @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100) @return [PayeeDeltaResponse2]

# File lib/velopayments/api/payees_api.rb, line 421
def list_payee_changes_v3(payor_id, updated_since, opts = {})
  data, _status_code, _headers = list_payee_changes_v3_with_http_info(payor_id, updated_since, opts)
  data
end
list_payee_changes_v3_with_http_info(payor_id, updated_since, opts = {}) click to toggle source

List Payee Changes Get a paginated response listing payee changes. @param payor_id [String] The Payor ID to find associated Payees @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. @return [Array<(PayeeDeltaResponse2, Integer, Hash)>] PayeeDeltaResponse2 data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 434
def list_payee_changes_v3_with_http_info(payor_id, updated_since, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes_v3 ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payee_changes_v3"
  end
  # verify the required parameter 'updated_since' is set
  if @api_client.config.client_side_validation && updated_since.nil?
    fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes_v3"
  end
  # resource path
  local_var_path = '/v3/payees/deltas'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payorId'] = payor_id
  query_params[:'updatedSince'] = updated_since
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PayeeDeltaResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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_payee_changes_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_payee_changes_with_http_info(payor_id, updated_since, opts = {}) click to toggle source

List Payee Changes &lt;p&gt;Get a paginated response listing payee changes.&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt; @param payor_id [String] The Payor ID to find associated Payees @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. @return [Array<(PayeeDeltaResponse, Integer, Hash)>] PayeeDeltaResponse data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 358
def list_payee_changes_with_http_info(payor_id, updated_since, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payee_changes"
  end
  # verify the required parameter 'updated_since' is set
  if @api_client.config.client_side_validation && updated_since.nil?
    fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes"
  end
  # resource path
  local_var_path = '/v1/deltas/payees'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payorId'] = payor_id
  query_params[:'updatedSince'] = updated_since
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PayeeDeltaResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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_payee_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_payees_v1(payor_id, opts = {}) click to toggle source

List Payees V1 <p>Get a paginated response listing the payees for a payor.</p> <p>Please use V3 instead.</> @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [OfacStatus] :ofac_status The ofacStatus of the payees. @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. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @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. (default to 'displayName:asc') @return [PagedPayeeResponse]

# File lib/velopayments/api/payees_api.rb, line 504
def list_payees_v1(payor_id, opts = {})
  data, _status_code, _headers = list_payees_v1_with_http_info(payor_id, opts)
  data
end
list_payees_v1_with_http_info(payor_id, opts = {}) click to toggle source

List Payees V1 &lt;p&gt;Get a paginated response listing the payees for a payor.&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/&gt; @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [OfacStatus] :ofac_status The ofacStatus of the payees. @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

# File lib/velopayments/api/payees_api.rb, line 524
def list_payees_v1_with_http_info(payor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v1 ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v1"
  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_v1, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/payees'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payorId'] = payor_id
  query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].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 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PagedPayeeResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_payees_v3(payor_id, opts = {}) click to toggle source

List Payees 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] :ofac_status The watchlistStatus of the payees. @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. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @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. (default to 'displayName:asc') @return [PagedPayeeResponse2]

# File lib/velopayments/api/payees_api.rb, line 602
def list_payees_v3(payor_id, opts = {})
  data, _status_code, _headers = list_payees_v3_with_http_info(payor_id, opts)
  data
end
list_payees_v3_with_http_info(payor_id, opts = {}) click to toggle source

List Payees 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] :ofac_status The watchlistStatus of the payees. @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<(PagedPayeeResponse2, Integer, Hash)>] PagedPayeeResponse2 data, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 622
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
  # verify the required parameter 'payor_id' is set
  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

  # resource path
  local_var_path = '/v3/payees'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payorId'] = payor_id
  query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].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 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PagedPayeeResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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
v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {}) click to toggle source

Update Payee Remote Id <p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p> @param payee_id [String] The UUID of the payee. @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v1 @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payees_api.rb, line 691
def v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
  v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts)
  nil
end
v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {}) click to toggle source

Update Payee Remote Id &lt;p&gt;Update the remote Id for the given Payee Id.&lt;/p&gt; &lt;p&gt;Please use V3 instead&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v1 @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 702
def v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.v1_payees_payee_id_remote_id_update_post ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v1_payees_payee_id_remote_id_update_post"
  end
  # verify the required parameter 'update_remote_id_request' is set
  if @api_client.config.client_side_validation && update_remote_id_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_remote_id_request' when calling PayeesApi.v1_payees_payee_id_remote_id_update_post"
  end
  # resource path
  local_var_path = '/v1/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(update_remote_id_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeesApi#v1_payees_payee_id_remote_id_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {}) click to toggle source

Update Payee Remote Id <p>Update the remote Id for the given Payee Id.</p> @param payee_id [String] The UUID of the payee. @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v3 @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payees_api.rb, line 761
def v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
  v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts)
  nil
end
v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {}) click to toggle source

Update Payee Remote Id &lt;p&gt;Update the remote Id for the given Payee Id.&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v3 @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payees_api.rb, line 772
def v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeesApi.v3_payees_payee_id_remote_id_update_post ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
  end
  # verify the required parameter 'update_remote_id_request' is set
  if @api_client.config.client_side_validation && update_remote_id_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_remote_id_request' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
  end
  # resource path
  local_var_path = '/v3/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(update_remote_id_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeesApi#v3_payees_payee_id_remote_id_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end