=begin #Payment Gateway API Specification. #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway. The version of the OpenAPI document: 6.8.0.20190731.002 Generated by: https://openapi-generator.tech OpenAPI Generator version: unset =end require 'cgi' module OpenapiClient class PaymentTokenApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a payment token from a payment card. # Use this to create a payment token from a payment card. # @param content_type [String] Content type. # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). # @param payment_tokenization_request [PaymentTokenizationRequest] Accepted request types: PaymentCardPaymentTokenizationRequest, PaymentDevicePaymentTokenizationRequest, and ReferencedOrderPaymentTokenizationRequest. # @param [Hash] opts the optional parameters # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. # @option opts [String] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. # @return [PaymentTokenizationResponse] def create_payment_token(content_type, client_request_id, api_key, timestamp, payment_tokenization_request, opts = {}) data, _status_code, _headers = create_payment_token_with_http_info(content_type, client_request_id, api_key, timestamp, payment_tokenization_request, opts) data end # Create a payment token from a payment card. # Use this to create a payment token from a payment card. # @param content_type [String] Content type. # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). # @param payment_tokenization_request [PaymentTokenizationRequest] Accepted request types: PaymentCardPaymentTokenizationRequest, PaymentDevicePaymentTokenizationRequest, and ReferencedOrderPaymentTokenizationRequest. # @param [Hash] opts the optional parameters # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. # @option opts [String] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. # @return [Array<(PaymentTokenizationResponse, Integer, Hash)>] PaymentTokenizationResponse data, response status code and response headers def create_payment_token_with_http_info(content_type, client_request_id, api_key, timestamp, payment_tokenization_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentTokenApi.create_payment_token ...' end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentTokenApi.create_payment_token" end # verify enum value allowable_values = ["application/json"] if @api_client.config.client_side_validation && !allowable_values.include?(content_type) fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}" end # verify the required parameter 'client_request_id' is set if @api_client.config.client_side_validation && client_request_id.nil? fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentTokenApi.create_payment_token" end # verify the required parameter 'api_key' is set if @api_client.config.client_side_validation && api_key.nil? fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentTokenApi.create_payment_token" end # verify the required parameter 'timestamp' is set if @api_client.config.client_side_validation && timestamp.nil? fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentTokenApi.create_payment_token" end # verify the required parameter 'payment_tokenization_request' is set if @api_client.config.client_side_validation && payment_tokenization_request.nil? fail ArgumentError, "Missing the required parameter 'payment_tokenization_request' when calling PaymentTokenApi.create_payment_token" end # resource path local_var_path = '/payment-tokens' # 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']) # header_params[:'Content-Type'] = content_type header_params[:'Client-Request-Id'] = client_request_id header_params[:'Api-Key'] = api_key header_params[:'Timestamp'] = timestamp header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil? header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil? header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(payment_tokenization_request) # return_type return_type = opts[:return_type] || 'PaymentTokenizationResponse' # auth_names auth_names = opts[:auth_names] || [] 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 => 'PaymentTokenizationResponse', :default_error_type => 'ErrorResponse', :error_type => 'PaymentTokenizationErrorResponse') 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: PaymentTokenApi#create_payment_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete a payment token. # Use this to delete a payment token. # @param content_type [String] Content type. # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). # @param token_id [String] Identifies a payment token. # @param [Hash] opts the optional parameters # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. # @option opts [String] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. # @option opts [String] :store_id # @return [PaymentTokenizationResponse] def delete_payment_token(content_type, client_request_id, api_key, timestamp, token_id, opts = {}) data, _status_code, _headers = delete_payment_token_with_http_info(content_type, client_request_id, api_key, timestamp, token_id, opts) data end # Delete a payment token. # Use this to delete a payment token. # @param content_type [String] Content type. # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee. # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). # @param token_id [String] Identifies a payment token. # @param [Hash] opts the optional parameters # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. # @option opts [String] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. # @option opts [String] :store_id # @return [Array<(PaymentTokenizationResponse, Integer, Hash)>] PaymentTokenizationResponse data, response status code and response headers def delete_payment_token_with_http_info(content_type, client_request_id, api_key, timestamp, token_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentTokenApi.delete_payment_token ...' end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentTokenApi.delete_payment_token" end # verify enum value allowable_values = ["application/json"] if @api_client.config.client_side_validation && !allowable_values.include?(content_type) fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}" end # verify the required parameter 'client_request_id' is set if @api_client.config.client_side_validation && client_request_id.nil? fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentTokenApi.delete_payment_token" end # verify the required parameter 'api_key' is set if @api_client.config.client_side_validation && api_key.nil? fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentTokenApi.delete_payment_token" end # verify the required parameter 'timestamp' is set if @api_client.config.client_side_validation && timestamp.nil? fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentTokenApi.delete_payment_token" end # verify the required parameter 'token_id' is set if @api_client.config.client_side_validation && token_id.nil? fail ArgumentError, "Missing the required parameter 'token_id' when calling PaymentTokenApi.delete_payment_token" end # resource path local_var_path = '/payment-tokens/{token-id}'.sub('{' + 'token-id' + '}', CGI.escape(token_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # header_params[:'Content-Type'] = content_type header_params[:'Client-Request-Id'] = client_request_id header_params[:'Api-Key'] = api_key header_params[:'Timestamp'] = timestamp header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil? header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil? header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PaymentTokenizationResponse' # auth_names auth_names = opts[:auth_names] || [] 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 => 'PaymentTokenizationResponse', :default_error_type => 'ErrorResponse') 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: PaymentTokenApi#delete_payment_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end