Class: CyberSource::PaymentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/api/payment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentApi

Returns a new instance of PaymentApi.



19
20
21
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment(create_payment_request, opts = {}) ⇒ InlineResponse201

Process a Payment Authorize the payment for the transaction.

Parameters:

  • create_payment_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 27

def create_payment(create_payment_request, opts = {})
  data, _status_code, _headers = create_payment_with_http_info(create_payment_request, opts)
  return data, _status_code, _headers
end

#create_payment_with_http_info(create_payment_request, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>

Process a Payment Authorize the payment for the transaction.

Parameters:

  • create_payment_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse201, Fixnum, Hash)>) —

    InlineResponse201 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 37

def create_payment_with_http_info(create_payment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentApi.create_payment ...'
  end
  # verify the required parameter 'create_payment_request' is set
  if @api_client.config.client_side_validation && create_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_payment_request' when calling PaymentApi.create_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_payment_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 => 'InlineResponse201')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment(id, opts = {}) ⇒ InlineResponse2002

Retrieve a Payment Include the payment ID in the GET request to retrieve the payment details.

Parameters:

  • id —

    The payment ID returned from a previous payment request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 79

def get_payment(id, opts = {})
  data, _status_code, _headers = get_payment_with_http_info(id, opts)
  return data, _status_code, _headers
end

#get_payment_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2002, Fixnum, Hash)>

Retrieve a Payment Include the payment ID in the GET request to retrieve the payment details.

Parameters:

  • id —

    The payment ID returned from a previous payment request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse2002, Fixnum, Hash)>) —

    InlineResponse2002 data, response status code and response headers



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/cyberSource_client/api/payment_api.rb', line 89

def get_payment_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentApi.get_payment ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PaymentApi.get_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2002')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentApi#get_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end