citypay_api_client 1.1.2 → 1.1.3

data/lib/citypay_api_client/models/remitted_client_data.rb

@@ -0,0 +1,612 @@
+=begin
+#CityPay Payment API
+
+# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server  transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.  Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing  Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure  authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for  Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability  for tokenised payments.  ## Compliance and Security Overview <aside class=\"notice\">   Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is    designed with stringent security measures and compliance protocols to safeguard sensitive information and meet    the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside>  ### Key Compliance and Security Measures  * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.  ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.  For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.  Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution. 
+
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module CityPayApiClient
+  class RemittedClientData
+    attr_accessor :batches
+
+    # The client id that the remittance data is for.
+    attr_accessor :clientid
+
+    # The date of the remittance.
+    attr_accessor :date
+
+    # The date time that the remittance was created.
+    attr_accessor :date_created
+
+    # Represents the net amount after accounting for refunds. This is calculated as SalesAmount - RefundAmount and expressed in the smallest currency unit.
+    attr_accessor :net_amount
+
+    # The total monetary amount processed consisting of sale and refund transactions.
+    attr_accessor :processed_amount
+
+    # Indicates the total number of sales and refund transactions that occurred. This count provides insight into the volume of processing.
+    attr_accessor :processed_count
+
+    # The total amount refunded to customers.
+    attr_accessor :refund_amount
+
+    # The total number of refund transactions processed. This figure helps in understanding the frequency of refunds relative to sales.
+    attr_accessor :refund_count
+
+    attr_accessor :remittances
+
+    # The total monetary amount of sales transactions.
+    attr_accessor :sales_amount
+
+    # Indicates the total number of sales transactions that occurred. This count provides insight into the volume of sales.
+    attr_accessor :sales_count
+
+    # The name of the implementation.
+    attr_accessor :settlement_implementation
+
+    # The uuid of the settlement file processed on.
+    attr_accessor :uuid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batches' => :'batches',
+        :'clientid' => :'clientid',
+        :'date' => :'date',
+        :'date_created' => :'date_created',
+        :'net_amount' => :'net_amount',
+        :'processed_amount' => :'processed_amount',
+        :'processed_count' => :'processed_count',
+        :'refund_amount' => :'refund_amount',
+        :'refund_count' => :'refund_count',
+        :'remittances' => :'remittances',
+        :'sales_amount' => :'sales_amount',
+        :'sales_count' => :'sales_count',
+        :'settlement_implementation' => :'settlement_implementation',
+        :'uuid' => :'uuid'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'batches' => :'Array<MerchantBatchResponse>',
+        :'clientid' => :'String',
+        :'date' => :'Date',
+        :'date_created' => :'Time',
+        :'net_amount' => :'Integer',
+        :'processed_amount' => :'Integer',
+        :'processed_count' => :'Integer',
+        :'refund_amount' => :'Integer',
+        :'refund_count' => :'Integer',
+        :'remittances' => :'Array<RemittanceData>',
+        :'sales_amount' => :'Integer',
+        :'sales_count' => :'Integer',
+        :'settlement_implementation' => :'String',
+        :'uuid' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::RemittedClientData` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::RemittedClientData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'batches')
+        if (value = attributes[:'batches']).is_a?(Array)
+          self.batches = value
+        end
+      else
+        self.batches = nil
+      end
+
+      if attributes.key?(:'clientid')
+        self.clientid = attributes[:'clientid']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      end
+
+      if attributes.key?(:'net_amount')
+        self.net_amount = attributes[:'net_amount']
+      end
+
+      if attributes.key?(:'processed_amount')
+        self.processed_amount = attributes[:'processed_amount']
+      end
+
+      if attributes.key?(:'processed_count')
+        self.processed_count = attributes[:'processed_count']
+      end
+
+      if attributes.key?(:'refund_amount')
+        self.refund_amount = attributes[:'refund_amount']
+      end
+
+      if attributes.key?(:'refund_count')
+        self.refund_count = attributes[:'refund_count']
+      end
+
+      if attributes.key?(:'remittances')
+        if (value = attributes[:'remittances']).is_a?(Array)
+          self.remittances = value
+        end
+      else
+        self.remittances = nil
+      end
+
+      if attributes.key?(:'sales_amount')
+        self.sales_amount = attributes[:'sales_amount']
+      end
+
+      if attributes.key?(:'sales_count')
+        self.sales_count = attributes[:'sales_count']
+      end
+
+      if attributes.key?(:'settlement_implementation')
+        self.settlement_implementation = attributes[:'settlement_implementation']
+      end
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @batches.nil?
+        invalid_properties.push('invalid value for "batches", batches cannot be nil.')
+      end
+
+      if !@clientid.nil? && @clientid.to_s.length > 10
+        invalid_properties.push('invalid value for "clientid", the character length must be smaller than or equal to 10.')
+      end
+
+      if !@clientid.nil? && @clientid.to_s.length < 3
+        invalid_properties.push('invalid value for "clientid", the character length must be great than or equal to 3.')
+      end
+
+      if !@net_amount.nil? && @net_amount > 999999999
+        invalid_properties.push('invalid value for "net_amount", must be smaller than or equal to 999999999.')
+      end
+
+      if !@net_amount.nil? && @net_amount < 0
+        invalid_properties.push('invalid value for "net_amount", must be greater than or equal to 0.')
+      end
+
+      if !@processed_amount.nil? && @processed_amount > 999999999
+        invalid_properties.push('invalid value for "processed_amount", must be smaller than or equal to 999999999.')
+      end
+
+      if !@processed_amount.nil? && @processed_amount < 0
+        invalid_properties.push('invalid value for "processed_amount", must be greater than or equal to 0.')
+      end
+
+      if !@processed_count.nil? && @processed_count > 999999999
+        invalid_properties.push('invalid value for "processed_count", must be smaller than or equal to 999999999.')
+      end
+
+      if !@processed_count.nil? && @processed_count < 0
+        invalid_properties.push('invalid value for "processed_count", must be greater than or equal to 0.')
+      end
+
+      if !@refund_amount.nil? && @refund_amount > 999999999
+        invalid_properties.push('invalid value for "refund_amount", must be smaller than or equal to 999999999.')
+      end
+
+      if !@refund_amount.nil? && @refund_amount < 0
+        invalid_properties.push('invalid value for "refund_amount", must be greater than or equal to 0.')
+      end
+
+      if !@refund_count.nil? && @refund_count > 999999999
+        invalid_properties.push('invalid value for "refund_count", must be smaller than or equal to 999999999.')
+      end
+
+      if !@refund_count.nil? && @refund_count < 0
+        invalid_properties.push('invalid value for "refund_count", must be greater than or equal to 0.')
+      end
+
+      if @remittances.nil?
+        invalid_properties.push('invalid value for "remittances", remittances cannot be nil.')
+      end
+
+      if !@sales_amount.nil? && @sales_amount > 999999999
+        invalid_properties.push('invalid value for "sales_amount", must be smaller than or equal to 999999999.')
+      end
+
+      if !@sales_amount.nil? && @sales_amount < 0
+        invalid_properties.push('invalid value for "sales_amount", must be greater than or equal to 0.')
+      end
+
+      if !@sales_count.nil? && @sales_count > 999999999
+        invalid_properties.push('invalid value for "sales_count", must be smaller than or equal to 999999999.')
+      end
+
+      if !@sales_count.nil? && @sales_count < 0
+        invalid_properties.push('invalid value for "sales_count", must be greater than or equal to 0.')
+      end
+
+      if !@uuid.nil? && @uuid.to_s.length > 36
+        invalid_properties.push('invalid value for "uuid", the character length must be smaller than or equal to 36.')
+      end
+
+      if !@uuid.nil? && @uuid.to_s.length < 36
+        invalid_properties.push('invalid value for "uuid", the character length must be great than or equal to 36.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @batches.nil?
+      return false if !@clientid.nil? && @clientid.to_s.length > 10
+      return false if !@clientid.nil? && @clientid.to_s.length < 3
+      return false if !@net_amount.nil? && @net_amount > 999999999
+      return false if !@net_amount.nil? && @net_amount < 0
+      return false if !@processed_amount.nil? && @processed_amount > 999999999
+      return false if !@processed_amount.nil? && @processed_amount < 0
+      return false if !@processed_count.nil? && @processed_count > 999999999
+      return false if !@processed_count.nil? && @processed_count < 0
+      return false if !@refund_amount.nil? && @refund_amount > 999999999
+      return false if !@refund_amount.nil? && @refund_amount < 0
+      return false if !@refund_count.nil? && @refund_count > 999999999
+      return false if !@refund_count.nil? && @refund_count < 0
+      return false if @remittances.nil?
+      return false if !@sales_amount.nil? && @sales_amount > 999999999
+      return false if !@sales_amount.nil? && @sales_amount < 0
+      return false if !@sales_count.nil? && @sales_count > 999999999
+      return false if !@sales_count.nil? && @sales_count < 0
+      return false if !@uuid.nil? && @uuid.to_s.length > 36
+      return false if !@uuid.nil? && @uuid.to_s.length < 36
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] clientid Value to be assigned
+    def clientid=(clientid)
+      if clientid.nil?
+        fail ArgumentError, 'clientid cannot be nil'
+      end
+
+      if clientid.to_s.length > 10
+        fail ArgumentError, 'invalid value for "clientid", the character length must be smaller than or equal to 10.'
+      end
+
+      if clientid.to_s.length < 3
+        fail ArgumentError, 'invalid value for "clientid", the character length must be great than or equal to 3.'
+      end
+
+      @clientid = clientid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] net_amount Value to be assigned
+    def net_amount=(net_amount)
+      if net_amount.nil?
+        fail ArgumentError, 'net_amount cannot be nil'
+      end
+
+      if net_amount > 999999999
+        fail ArgumentError, 'invalid value for "net_amount", must be smaller than or equal to 999999999.'
+      end
+
+      if net_amount < 0
+        fail ArgumentError, 'invalid value for "net_amount", must be greater than or equal to 0.'
+      end
+
+      @net_amount = net_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processed_amount Value to be assigned
+    def processed_amount=(processed_amount)
+      if processed_amount.nil?
+        fail ArgumentError, 'processed_amount cannot be nil'
+      end
+
+      if processed_amount > 999999999
+        fail ArgumentError, 'invalid value for "processed_amount", must be smaller than or equal to 999999999.'
+      end
+
+      if processed_amount < 0
+        fail ArgumentError, 'invalid value for "processed_amount", must be greater than or equal to 0.'
+      end
+
+      @processed_amount = processed_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processed_count Value to be assigned
+    def processed_count=(processed_count)
+      if processed_count.nil?
+        fail ArgumentError, 'processed_count cannot be nil'
+      end
+
+      if processed_count > 999999999
+        fail ArgumentError, 'invalid value for "processed_count", must be smaller than or equal to 999999999.'
+      end
+
+      if processed_count < 0
+        fail ArgumentError, 'invalid value for "processed_count", must be greater than or equal to 0.'
+      end
+
+      @processed_count = processed_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] refund_amount Value to be assigned
+    def refund_amount=(refund_amount)
+      if refund_amount.nil?
+        fail ArgumentError, 'refund_amount cannot be nil'
+      end
+
+      if refund_amount > 999999999
+        fail ArgumentError, 'invalid value for "refund_amount", must be smaller than or equal to 999999999.'
+      end
+
+      if refund_amount < 0
+        fail ArgumentError, 'invalid value for "refund_amount", must be greater than or equal to 0.'
+      end
+
+      @refund_amount = refund_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] refund_count Value to be assigned
+    def refund_count=(refund_count)
+      if refund_count.nil?
+        fail ArgumentError, 'refund_count cannot be nil'
+      end
+
+      if refund_count > 999999999
+        fail ArgumentError, 'invalid value for "refund_count", must be smaller than or equal to 999999999.'
+      end
+
+      if refund_count < 0
+        fail ArgumentError, 'invalid value for "refund_count", must be greater than or equal to 0.'
+      end
+
+      @refund_count = refund_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sales_amount Value to be assigned
+    def sales_amount=(sales_amount)
+      if sales_amount.nil?
+        fail ArgumentError, 'sales_amount cannot be nil'
+      end
+
+      if sales_amount > 999999999
+        fail ArgumentError, 'invalid value for "sales_amount", must be smaller than or equal to 999999999.'
+      end
+
+      if sales_amount < 0
+        fail ArgumentError, 'invalid value for "sales_amount", must be greater than or equal to 0.'
+      end
+
+      @sales_amount = sales_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sales_count Value to be assigned
+    def sales_count=(sales_count)
+      if sales_count.nil?
+        fail ArgumentError, 'sales_count cannot be nil'
+      end
+
+      if sales_count > 999999999
+        fail ArgumentError, 'invalid value for "sales_count", must be smaller than or equal to 999999999.'
+      end
+
+      if sales_count < 0
+        fail ArgumentError, 'invalid value for "sales_count", must be greater than or equal to 0.'
+      end
+
+      @sales_count = sales_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.nil?
+        fail ArgumentError, 'uuid cannot be nil'
+      end
+
+      if uuid.to_s.length > 36
+        fail ArgumentError, 'invalid value for "uuid", the character length must be smaller than or equal to 36.'
+      end
+
+      if uuid.to_s.length < 36
+        fail ArgumentError, 'invalid value for "uuid", the character length must be great than or equal to 36.'
+      end
+
+      @uuid = uuid
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          batches == o.batches &&
+          clientid == o.clientid &&
+          date == o.date &&
+          date_created == o.date_created &&
+          net_amount == o.net_amount &&
+          processed_amount == o.processed_amount &&
+          processed_count == o.processed_count &&
+          refund_amount == o.refund_amount &&
+          refund_count == o.refund_count &&
+          remittances == o.remittances &&
+          sales_amount == o.sales_amount &&
+          sales_count == o.sales_count &&
+          settlement_implementation == o.settlement_implementation &&
+          uuid == o.uuid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [batches, clientid, date, date_created, net_amount, processed_amount, processed_count, refund_amount, refund_count, remittances, sales_amount, sales_count, settlement_implementation, uuid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = CityPayApiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/citypay_api_client/models/request_challenged.rb

@@ -1,7 +1,7 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server  transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.  Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing  Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure  authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for  Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability  for tokenised payments.  ## Compliance and Security Overview <aside class=\"notice\">   Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is    designed with stringent security measures and compliance protocols to safeguard sensitive information and meet    the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside>  ### Key Compliance and Security Measures  * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.  ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.  For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.  Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution. 
 
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech

data/lib/citypay_api_client/models/retrieve_request.rb

@@ -1,7 +1,7 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server  transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.  Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing  Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure  authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for  Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability  for tokenised payments.  ## Compliance and Security Overview <aside class=\"notice\">   Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is    designed with stringent security measures and compliance protocols to safeguard sensitive information and meet    the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside>  ### Key Compliance and Security Measures  * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.  ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.  For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.  Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution. 
 
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech