class CyberSource::PayerAuthenticationApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

check_payer_auth_enrollment(check_payer_auth_enrollment_request, opts = {}) click to toggle source

Check Payer Auth Enrollment This call verifies that the card is enrolled in a card authentication program. @param check_payer_auth_enrollment_request @param [Hash] opts the optional parameters @return [RiskV1AuthenticationsPost201Response]

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 28
def check_payer_auth_enrollment(check_payer_auth_enrollment_request, opts = {})
  data, status_code, headers = check_payer_auth_enrollment_with_http_info(check_payer_auth_enrollment_request, opts)
  return data, status_code, headers
end
check_payer_auth_enrollment_with_http_info(check_payer_auth_enrollment_request, opts = {}) click to toggle source

Check Payer Auth Enrollment This call verifies that the card is enrolled in a card authentication program. @param check_payer_auth_enrollment_request @param [Hash] opts the optional parameters @return [Array<(RiskV1AuthenticationsPost201Response, Fixnum, Hash)>] RiskV1AuthenticationsPost201Response data, response status code and response headers

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 38
def check_payer_auth_enrollment_with_http_info(check_payer_auth_enrollment_request, opts = {})
  
      if @api_client.config.debugging
           begin
                    raise
                            @api_client.config.logger.debug 'Calling API: PayerAuthenticationApi.check_payer_auth_enrollment ...'
                    rescue
                            puts 'Cannot write to log'
                    end
  end
  # verify the required parameter 'check_payer_auth_enrollment_request' is set
  if @api_client.config.client_side_validation && check_payer_auth_enrollment_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_payer_auth_enrollment_request' when calling PayerAuthenticationApi.check_payer_auth_enrollment"
  end
  # resource path
  local_var_path = 'risk/v1/authentications'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(check_payer_auth_enrollment_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RiskV1AuthenticationsPost201Response')
  if @api_client.config.debugging
            begin
            raise
                    @api_client.config.logger.debug "API called: PayerAuthenticationApi#check_payer_auth_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
            rescue
                    puts 'Cannot write to log'
            end
      end
  return data, status_code, headers
end
payer_auth_setup(payer_auth_setup_request, opts = {}) click to toggle source

Setup Payer Auth A new service for Merchants to get reference_id for Digital Wallets to use in place of BIN number in Cardinal. Set up file while authenticating with Cardinal. This service should be called by Merchant when payment instrument chosen or changes. This service has to be called before enrollment check. @param payer_auth_setup_request @param [Hash] opts the optional parameters @return [RiskV1AuthenticationSetupsPost201Response]

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 93
def payer_auth_setup(payer_auth_setup_request, opts = {})
  data, status_code, headers = payer_auth_setup_with_http_info(payer_auth_setup_request, opts)
  return data, status_code, headers
end
payer_auth_setup_with_http_info(payer_auth_setup_request, opts = {}) click to toggle source

Setup Payer Auth A new service for Merchants to get reference_id for Digital Wallets to use in place of BIN number in Cardinal. Set up file while authenticating with Cardinal. This service should be called by Merchant when payment instrument chosen or changes. This service has to be called before enrollment check. @param payer_auth_setup_request @param [Hash] opts the optional parameters @return [Array<(RiskV1AuthenticationSetupsPost201Response, Fixnum, Hash)>] RiskV1AuthenticationSetupsPost201Response data, response status code and response headers

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 103
def payer_auth_setup_with_http_info(payer_auth_setup_request, opts = {})
  
      if @api_client.config.debugging
           begin
                    raise
                            @api_client.config.logger.debug 'Calling API: PayerAuthenticationApi.payer_auth_setup ...'
                    rescue
                            puts 'Cannot write to log'
                    end
  end
  # verify the required parameter 'payer_auth_setup_request' is set
  if @api_client.config.client_side_validation && payer_auth_setup_request.nil?
    fail ArgumentError, "Missing the required parameter 'payer_auth_setup_request' when calling PayerAuthenticationApi.payer_auth_setup"
  end
  # resource path
  local_var_path = 'risk/v1/authentication-setups'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payer_auth_setup_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RiskV1AuthenticationSetupsPost201Response')
  if @api_client.config.debugging
            begin
            raise
                    @api_client.config.logger.debug "API called: PayerAuthenticationApi#payer_auth_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
            rescue
                    puts 'Cannot write to log'
            end
      end
  return data, status_code, headers
end
validate_authentication_results(validate_request, opts = {}) click to toggle source

Validate Authentication Results This call retrieves and validates the authentication results from issuer and allows the merchant to proceed with processing the payment. @param validate_request @param [Hash] opts the optional parameters @return [RiskV1AuthenticationResultsPost201Response]

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 158
def validate_authentication_results(validate_request, opts = {})
  data, status_code, headers = validate_authentication_results_with_http_info(validate_request, opts)
  return data, status_code, headers
end
validate_authentication_results_with_http_info(validate_request, opts = {}) click to toggle source

Validate Authentication Results This call retrieves and validates the authentication results from issuer and allows the merchant to proceed with processing the payment. @param validate_request @param [Hash] opts the optional parameters @return [Array<(RiskV1AuthenticationResultsPost201Response, Fixnum, Hash)>] RiskV1AuthenticationResultsPost201Response data, response status code and response headers

# File lib/cybersource_rest_client/api/payer_authentication_api.rb, line 168
def validate_authentication_results_with_http_info(validate_request, opts = {})
  
      if @api_client.config.debugging
           begin
                    raise
                            @api_client.config.logger.debug 'Calling API: PayerAuthenticationApi.validate_authentication_results ...'
                    rescue
                            puts 'Cannot write to log'
                    end
  end
  # verify the required parameter 'validate_request' is set
  if @api_client.config.client_side_validation && validate_request.nil?
    fail ArgumentError, "Missing the required parameter 'validate_request' when calling PayerAuthenticationApi.validate_authentication_results"
  end
  # resource path
  local_var_path = 'risk/v1/authentication-results'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(validate_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RiskV1AuthenticationResultsPost201Response')
  if @api_client.config.debugging
            begin
            raise
                    @api_client.config.logger.debug "API called: PayerAuthenticationApi#validate_authentication_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
            rescue
                    puts 'Cannot write to log'
            end
      end
  return data, status_code, headers
end