Class: Api::PaymentApi
- Inherits:
-
Object
- Object
- Api::PaymentApi
- Defined in:
- lib/jamm/api/api/payment_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_charge(body, opts = {}) ⇒ AddChargeResponse
Use existing contract with charge Use existing contract with charge.
-
#add_charge_with_http_info(body, opts = {}) ⇒ Array<(AddChargeResponse, Integer, Hash)>
Use existing contract with charge Use existing contract with charge.
-
#create_contract_with_charge(body, opts = {}) ⇒ CreateContractWithChargeResponse
Create a contract with initial charge Create a contract with initial charge.
-
#create_contract_with_charge_with_http_info(body, opts = {}) ⇒ Array<(CreateContractWithChargeResponse, Integer, Hash)>
Create a contract with initial charge Create a contract with initial charge.
-
#create_contract_without_charge(body, opts = {}) ⇒ CreateContractWithoutChargeResponse
Create a contract without initial charge (contract only) Create a contract without initial charge (contract only).
-
#create_contract_without_charge_with_http_info(body, opts = {}) ⇒ Array<(CreateContractWithoutChargeResponse, Integer, Hash)>
Create a contract without initial charge (contract only) Create a contract without initial charge (contract only).
-
#get_charge(charge, opts = {}) ⇒ GetChargeResponse
Get a specific charge Get a specific charge information.
-
#get_charge_with_http_info(charge, opts = {}) ⇒ Array<(GetChargeResponse, Integer, Hash)>
Get a specific charge Get a specific charge information.
-
#get_charges(customer, opts = {}) ⇒ GetChargesResponse
Get a list of charges Get a list of charges for a customer.
-
#get_charges_with_http_info(customer, opts = {}) ⇒ Array<(GetChargesResponse, Integer, Hash)>
Get a list of charges Get a list of charges for a customer.
-
#initialize(api_client = ApiClient.default) ⇒ PaymentApi
constructor
A new instance of PaymentApi.
-
#off_session_payment(body, opts = {}) ⇒ OffSessionPaymentResponse
Process payment directly without redirect Execute a payment off-session within your application without redirecting to a payment page.
-
#off_session_payment_with_http_info(body, opts = {}) ⇒ Array<(OffSessionPaymentResponse, Integer, Hash)>
Process payment directly without redirect Execute a payment off-session within your application without redirecting to a payment page.
-
#on_session_payment(body, opts = {}) ⇒ OnSessionPaymentResponse
Process payment with optional redirect Unified interface for creating payments - supports existing customers, new customers with charges, and contract-only creation.
-
#on_session_payment_with_http_info(body, opts = {}) ⇒ Array<(OnSessionPaymentResponse, Integer, Hash)>
Process payment with optional redirect Unified interface for creating payments - supports existing customers, new customers with charges, and contract-only creation.
-
#withdraw(body, opts = {}) ⇒ WithdrawResponse
Withdraw money from customer immediately, without redirect This call is synchronous.
-
#withdraw_with_http_info(body, opts = {}) ⇒ Array<(WithdrawResponse, Integer, Hash)>
Withdraw money from customer immediately, without redirect This call is synchronous.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PaymentApi
Returns a new instance of PaymentApi.
19 20 21 |
# File 'lib/jamm/api/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/jamm/api/api/payment_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_charge(body, opts = {}) ⇒ AddChargeResponse
Use existing contract with charge Use existing contract with charge
28 29 30 31 |
# File 'lib/jamm/api/api/payment_api.rb', line 28 def add_charge(body, opts = {}) data, _status_code, _headers = add_charge_with_http_info(body, opts) data end |
#add_charge_with_http_info(body, opts = {}) ⇒ Array<(AddChargeResponse, Integer, Hash)>
Use existing contract with charge Use existing contract with charge
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 74 75 76 77 78 79 80 81 82 |
# File 'lib/jamm/api/api/payment_api.rb', line 38 def add_charge_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.add_charge ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.add_charge" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/add-charge' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'AddChargeResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.add_charge", :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, ) @api_client.config.logger.debug "API called: PaymentApi#add_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#create_contract_with_charge(body, opts = {}) ⇒ CreateContractWithChargeResponse
Create a contract with initial charge Create a contract with initial charge
89 90 91 92 |
# File 'lib/jamm/api/api/payment_api.rb', line 89 def create_contract_with_charge(body, opts = {}) data, _status_code, _headers = create_contract_with_charge_with_http_info(body, opts) data end |
#create_contract_with_charge_with_http_info(body, opts = {}) ⇒ Array<(CreateContractWithChargeResponse, Integer, Hash)>
Create a contract with initial charge Create a contract with initial charge
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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/jamm/api/api/payment_api.rb', line 99 def create_contract_with_charge_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.create_contract_with_charge ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.create_contract_with_charge" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/contract-with-charge' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'CreateContractWithChargeResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.create_contract_with_charge", :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, ) @api_client.config.logger.debug "API called: PaymentApi#create_contract_with_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#create_contract_without_charge(body, opts = {}) ⇒ CreateContractWithoutChargeResponse
Create a contract without initial charge (contract only) Create a contract without initial charge (contract only)
150 151 152 153 |
# File 'lib/jamm/api/api/payment_api.rb', line 150 def create_contract_without_charge(body, opts = {}) data, _status_code, _headers = create_contract_without_charge_with_http_info(body, opts) data end |
#create_contract_without_charge_with_http_info(body, opts = {}) ⇒ Array<(CreateContractWithoutChargeResponse, Integer, Hash)>
Create a contract without initial charge (contract only) Create a contract without initial charge (contract only)
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/jamm/api/api/payment_api.rb', line 160 def create_contract_without_charge_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.create_contract_without_charge ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.create_contract_without_charge" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/contract-without-charge' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'CreateContractWithoutChargeResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.create_contract_without_charge", :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, ) @api_client.config.logger.debug "API called: PaymentApi#create_contract_without_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_charge(charge, opts = {}) ⇒ GetChargeResponse
Get a specific charge Get a specific charge information
211 212 213 214 |
# File 'lib/jamm/api/api/payment_api.rb', line 211 def get_charge(charge, opts = {}) data, _status_code, _headers = get_charge_with_http_info(charge, opts) data end |
#get_charge_with_http_info(charge, opts = {}) ⇒ Array<(GetChargeResponse, Integer, Hash)>
Get a specific charge Get a specific charge information
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/jamm/api/api/payment_api.rb', line 221 def get_charge_with_http_info(charge, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.get_charge ...' if @api_client.config.debugging # verify the required parameter 'charge' is set raise ArgumentError, "Missing the required parameter 'charge' when calling PaymentApi.get_charge" if @api_client.config.client_side_validation && charge.nil? # resource path local_var_path = '/v1/charge/{charge}'.sub('{charge}', CGI.escape(charge.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']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetChargeResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.get_charge", :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, ) @api_client.config.logger.debug "API called: PaymentApi#get_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_charges(customer, opts = {}) ⇒ GetChargesResponse
Get a list of charges Get a list of charges for a customer
271 272 273 274 |
# File 'lib/jamm/api/api/payment_api.rb', line 271 def get_charges(customer, opts = {}) data, _status_code, _headers = get_charges_with_http_info(customer, opts) data end |
#get_charges_with_http_info(customer, opts = {}) ⇒ Array<(GetChargesResponse, Integer, Hash)>
Get a list of charges Get a list of charges for a customer
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/jamm/api/api/payment_api.rb', line 283 def get_charges_with_http_info(customer, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.get_charges ...' if @api_client.config.debugging # verify the required parameter 'customer' is set raise ArgumentError, "Missing the required parameter 'customer' when calling PaymentApi.get_charges" if @api_client.config.client_side_validation && customer.nil? # resource path local_var_path = '/v1/charges/{customer}'.sub('{customer}', CGI.escape(customer.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pagination.pageSize'] = opts[:pagination_page_size] unless opts[:pagination_page_size].nil? query_params[:'pagination.pageToken'] = opts[:pagination_page_token] unless opts[:pagination_page_token].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetChargesResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.get_charges", :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, ) @api_client.config.logger.debug "API called: PaymentApi#get_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#off_session_payment(body, opts = {}) ⇒ OffSessionPaymentResponse
Process payment directly without redirect Execute a payment off-session within your application without redirecting to a payment page.
333 334 335 336 |
# File 'lib/jamm/api/api/payment_api.rb', line 333 def off_session_payment(body, opts = {}) data, _status_code, _headers = off_session_payment_with_http_info(body, opts) data end |
#off_session_payment_with_http_info(body, opts = {}) ⇒ Array<(OffSessionPaymentResponse, Integer, Hash)>
Process payment directly without redirect Execute a payment off-session within your application without redirecting to a payment page.
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/jamm/api/api/payment_api.rb', line 343 def off_session_payment_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.off_session_payment ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.off_session_payment" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/payments/off-session' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'OffSessionPaymentResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.off_session_payment", :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, ) @api_client.config.logger.debug "API called: PaymentApi#off_session_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#on_session_payment(body, opts = {}) ⇒ OnSessionPaymentResponse
Process payment with optional redirect Unified interface for creating payments - supports existing customers, new customers with charges, and contract-only creation.
394 395 396 397 |
# File 'lib/jamm/api/api/payment_api.rb', line 394 def on_session_payment(body, opts = {}) data, _status_code, _headers = on_session_payment_with_http_info(body, opts) data end |
#on_session_payment_with_http_info(body, opts = {}) ⇒ Array<(OnSessionPaymentResponse, Integer, Hash)>
Process payment with optional redirect Unified interface for creating payments - supports existing customers, new customers with charges, and contract-only creation.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/jamm/api/api/payment_api.rb', line 404 def on_session_payment_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.on_session_payment ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.on_session_payment" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/payments/on-session' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'OnSessionPaymentResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.on_session_payment", :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, ) @api_client.config.logger.debug "API called: PaymentApi#on_session_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#withdraw(body, opts = {}) ⇒ WithdrawResponse
Withdraw money from customer immediately, without redirect This call is synchronous. The money will be withdrawn immediately.
455 456 457 458 |
# File 'lib/jamm/api/api/payment_api.rb', line 455 def withdraw(body, opts = {}) data, _status_code, _headers = withdraw_with_http_info(body, opts) data end |
#withdraw_with_http_info(body, opts = {}) ⇒ Array<(WithdrawResponse, Integer, Hash)>
Withdraw money from customer immediately, without redirect This call is synchronous. The money will be withdrawn immediately.
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/jamm/api/api/payment_api.rb', line 465 def withdraw_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: PaymentApi.withdraw ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling PaymentApi.withdraw" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/v1/withdraw' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) header_params['Content-Type'] = content_type unless content_type.nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'WithdrawResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"PaymentApi.withdraw", :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, ) @api_client.config.logger.debug "API called: PaymentApi#withdraw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |