citypay_api_client 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3018934533b8ffad25c118e803c368d46897f6b2a580e0c35c001d7e606ff4f0
-  data.tar.gz: 6ff21eeebb1ea06d1dfd7be47fb416148b2761fe9e95246dc34178092427c070
+  metadata.gz: d36a0f3efd58bb02a74314352277a877855ab8540b9e2399ad12ac125ffe7ec1
+  data.tar.gz: 517784392d04121ee29768f3a9c540aafa20743664bf903d4a33a5d3fa9a5d45
 SHA512:
-  metadata.gz: da644228d47e92255fd06d90c45f8107d2d65ae2d224d51df0e6bb45885a4b7b9de78ed35f5725a7bf66c042a85b629f87726c59d9d10c078d0aa8df49fdd90d
-  data.tar.gz: d7e533a08e6899c9dcb1c6dc53e8e3a43d11b63a64a69a894a1bf36ba8fa9c129f43e79129eb0be056335691a4a0da4a821d7723fd2ac5d42da00b177d13293a
+  metadata.gz: 102eb7ba9af62abba36e41d497df25eb18d152729d5153d61c3535cb2e043b66b80555b904858060f5fb9504db2a118c7d291f20ae4c8a3e2795931d0c3b1854
+  data.tar.gz: b8da4880b88398be310be4ba3de35550bb9cd1d87d01dea2a519a2d38bbc524d87d2617b45062f80e5d11982d43d7ff93e3aaf6e529585d56181217e924db838

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    citypay_api_client (1.1.3)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.16.3)
+    jaro_winkler (1.5.6)
+    method_source (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  citypay_api_client!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.5.9

data/README.md

@@ -1,40 +1,47 @@
 # CityPay API Client for Ruby
 
 CityPayApiClient - the Ruby gem for the CityPay Payment API
-[![Build Status](https://api.travis-ci.com/citypay/citypay-api-client-ruby.svg?branch=master)](https://app.travis-ci.com/github/citypay/citypay-api-client-ruby)
-
-
-This CityPay API is a 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 tokinsed payments using Card Holder 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](#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 card holder 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.
+[![Ruby RSpec Tests](https://github.com/citypay/citypay-api-client-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/citypay/citypay-api-client-ruby/actions/workflows/build.yml)
+
+
+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.
 
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 6.4.18
-- Package version: 1.1.1
+- API version: 6.6.40
+- Package version: 1.1.3
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://citypay.com/customer-centre/technical-support.html](https://citypay.com/customer-centre/technical-support.html)
+For more information, please visit [https://www.citypay.com/contacts/](https://www.citypay.com/contacts/)
 
 ## Installation
 
@@ -49,16 +56,16 @@ gem build citypay_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./citypay_api_client-1.1.1.gem
+gem install ./citypay_api_client-1.1.3.gem
 ```
 
-(for development, run `gem install --dev ./citypay_api_client-1.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./citypay_api_client-1.1.3.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'citypay_api_client', '~> 1.1.1'
+    gem 'citypay_api_client', '~> 1.1.3'
 
 ### Install from Git
 
@@ -88,7 +95,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
-auth_request = CityPayApiClient::AuthRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest | 
+auth_request = CityPayApiClient::AuthRequest.new({amount: 19995, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest | 
 
 begin
   #Authorisation
@@ -110,13 +117,14 @@ Class | Method | HTTP request | Description
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**bin_range_lookup_request**](docs/AuthorisationAndPaymentApi.md#bin_range_lookup_request) | **POST** /v6/bin | Bin Lookup
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**c_res_request**](docs/AuthorisationAndPaymentApi.md#c_res_request) | **POST** /v6/cres | CRes
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**capture_request**](docs/AuthorisationAndPaymentApi.md#capture_request) | **POST** /v6/capture | Capture
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**create_payment_intent**](docs/AuthorisationAndPaymentApi.md#create_payment_intent) | **POST** /v6/intent/create | Create a Payment Intent
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**pa_res_request**](docs/AuthorisationAndPaymentApi.md#pa_res_request) | **POST** /v6/pares | PaRes
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**refund_request**](docs/AuthorisationAndPaymentApi.md#refund_request) | **POST** /v6/refund | Refund
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**retrieval_request**](docs/AuthorisationAndPaymentApi.md#retrieval_request) | **POST** /v6/retrieve | Retrieval
 *CityPayApiClient::AuthorisationAndPaymentApi* | [**void_request**](docs/AuthorisationAndPaymentApi.md#void_request) | **POST** /v6/void | Void
 *CityPayApiClient::BatchProcessingApi* | [**batch_process_request**](docs/BatchProcessingApi.md#batch_process_request) | **POST** /v6/batch/process | Batch Process Request
-*CityPayApiClient::BatchProcessingApi* | [**batch_report_request**](docs/BatchProcessingApi.md#batch_report_request) | **POST** /v6/batch/retrieve | BatchReportRequest
-*CityPayApiClient::BatchProcessingApi* | [**check_batch_status_request**](docs/BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | CheckBatchStatus
+*CityPayApiClient::BatchProcessingApi* | [**batch_retrieve_request**](docs/BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | Batch Retrieve Request
+*CityPayApiClient::BatchProcessingApi* | [**check_batch_status_request**](docs/BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | Check Batch Status
 *CityPayApiClient::CardHolderAccountApi* | [**account_card_delete_request**](docs/CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /v6/account/{accountid}/card/{cardId} | Card Deletion
 *CityPayApiClient::CardHolderAccountApi* | [**account_card_register_request**](docs/CardHolderAccountApi.md#account_card_register_request) | **POST** /v6/account/{accountid}/register | Card Registration
 *CityPayApiClient::CardHolderAccountApi* | [**account_card_status_request**](docs/CardHolderAccountApi.md#account_card_status_request) | **POST** /v6/account/{accountid}/card/{cardId}/status | Card Status
@@ -138,14 +146,21 @@ Class | Method | HTTP request | Description
 *CityPayApiClient::OperationalFunctionsApi* | [**list_merchants_request**](docs/OperationalFunctionsApi.md#list_merchants_request) | **GET** /v6/merchants/{clientid} | List Merchants Request
 *CityPayApiClient::OperationalFunctionsApi* | [**ping_request**](docs/OperationalFunctionsApi.md#ping_request) | **POST** /v6/ping | Ping Request
 *CityPayApiClient::PaylinkApi* | [**token_adjustment_request**](docs/PaylinkApi.md#token_adjustment_request) | **POST** /paylink/{token}/adjustment | Paylink Token Adjustment
+*CityPayApiClient::PaylinkApi* | [**token_cancel_request**](docs/PaylinkApi.md#token_cancel_request) | **PUT** /paylink/{token}/cancel | Cancel a Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_changes_request**](docs/PaylinkApi.md#token_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit
 *CityPayApiClient::PaylinkApi* | [**token_close_request**](docs/PaylinkApi.md#token_close_request) | **PUT** /paylink/{token}/close | Close Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_create_bill_payment_request**](docs/PaylinkApi.md#token_create_bill_payment_request) | **POST** /paylink/bill-payment | Create Bill Payment Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_create_request**](docs/PaylinkApi.md#token_create_request) | **POST** /paylink/create | Create Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_purge_attachments_request**](docs/PaylinkApi.md#token_purge_attachments_request) | **PUT** /paylink/{token}/purge-attachments | Purges any attachments for a Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_reconciled_request**](docs/PaylinkApi.md#token_reconciled_request) | **PUT** /paylink/{token}/reconciled | Reconcile Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_reopen_request**](docs/PaylinkApi.md#token_reopen_request) | **PUT** /paylink/{token}/reopen | Reopen Paylink Token
-*CityPayApiClient::PaylinkApi* | [**token_status_changes_request**](docs/PaylinkApi.md#token_status_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit
+*CityPayApiClient::PaylinkApi* | [**token_resend_notification_request**](docs/PaylinkApi.md#token_resend_notification_request) | **POST** /paylink/{token}/resend-notification | Resend a notification for Paylink Token
 *CityPayApiClient::PaylinkApi* | [**token_status_request**](docs/PaylinkApi.md#token_status_request) | **GET** /paylink/{token}/status | Paylink Token Status
+*CityPayApiClient::ReportingApi* | [**batched_transaction_report_request**](docs/ReportingApi.md#batched_transaction_report_request) | **POST** /v6/merchant-batch/{merchantid}/{batch_no}/transactions | Batch Transaction Report Request
+*CityPayApiClient::ReportingApi* | [**merchant_batch_report_request**](docs/ReportingApi.md#merchant_batch_report_request) | **POST** /v6/merchant-batch/report | Merchant Batch Report Request
+*CityPayApiClient::ReportingApi* | [**merchant_batch_request**](docs/ReportingApi.md#merchant_batch_request) | **GET** /v6/merchant-batch/{merchantid}/{batch_no} | Merchant Batch Request
+*CityPayApiClient::ReportingApi* | [**remittance_range_report**](docs/ReportingApi.md#remittance_range_report) | **POST** /v6/remittance/report/{clientid} | Remittance Report Request
+*CityPayApiClient::ReportingApi* | [**remittance_report_request**](docs/ReportingApi.md#remittance_report_request) | **GET** /v6/remittance/report/{clientid}/{date} | Remittance Date Report Request
 
 
 ## Documentation for Models
@@ -161,11 +176,12 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::AuthReferences](docs/AuthReferences.md)
  - [CityPayApiClient::AuthRequest](docs/AuthRequest.md)
  - [CityPayApiClient::AuthResponse](docs/AuthResponse.md)
- - [CityPayApiClient::AuthenRequired](docs/AuthenRequired.md)
  - [CityPayApiClient::Batch](docs/Batch.md)
  - [CityPayApiClient::BatchReportRequest](docs/BatchReportRequest.md)
  - [CityPayApiClient::BatchReportResponseModel](docs/BatchReportResponseModel.md)
  - [CityPayApiClient::BatchTransaction](docs/BatchTransaction.md)
+ - [CityPayApiClient::BatchTransactionReportRequest](docs/BatchTransactionReportRequest.md)
+ - [CityPayApiClient::BatchTransactionReportResponse](docs/BatchTransactionReportResponse.md)
  - [CityPayApiClient::BatchTransactionResultModel](docs/BatchTransactionResultModel.md)
  - [CityPayApiClient::Bin](docs/Bin.md)
  - [CityPayApiClient::BinLookup](docs/BinLookup.md)
@@ -191,6 +207,10 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::ListMerchantsResponse](docs/ListMerchantsResponse.md)
  - [CityPayApiClient::MCC6012](docs/MCC6012.md)
  - [CityPayApiClient::Merchant](docs/Merchant.md)
+ - [CityPayApiClient::MerchantBatchReportRequest](docs/MerchantBatchReportRequest.md)
+ - [CityPayApiClient::MerchantBatchReportResponse](docs/MerchantBatchReportResponse.md)
+ - [CityPayApiClient::MerchantBatchResponse](docs/MerchantBatchResponse.md)
+ - [CityPayApiClient::NetSummaryResponse](docs/NetSummaryResponse.md)
  - [CityPayApiClient::PaResAuthRequest](docs/PaResAuthRequest.md)
  - [CityPayApiClient::PaylinkAddress](docs/PaylinkAddress.md)
  - [CityPayApiClient::PaylinkAdjustmentRequest](docs/PaylinkAdjustmentRequest.md)
@@ -206,6 +226,7 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::PaylinkErrorCode](docs/PaylinkErrorCode.md)
  - [CityPayApiClient::PaylinkFieldGuardModel](docs/PaylinkFieldGuardModel.md)
  - [CityPayApiClient::PaylinkPartPayments](docs/PaylinkPartPayments.md)
+ - [CityPayApiClient::PaylinkResendNotificationRequest](docs/PaylinkResendNotificationRequest.md)
  - [CityPayApiClient::PaylinkSMSNotificationPath](docs/PaylinkSMSNotificationPath.md)
  - [CityPayApiClient::PaylinkStateEvent](docs/PaylinkStateEvent.md)
  - [CityPayApiClient::PaylinkTokenCreated](docs/PaylinkTokenCreated.md)
@@ -214,11 +235,17 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::PaylinkTokenStatusChangeRequest](docs/PaylinkTokenStatusChangeRequest.md)
  - [CityPayApiClient::PaylinkTokenStatusChangeResponse](docs/PaylinkTokenStatusChangeResponse.md)
  - [CityPayApiClient::PaylinkUI](docs/PaylinkUI.md)
+ - [CityPayApiClient::PaymentIntent](docs/PaymentIntent.md)
+ - [CityPayApiClient::PaymentIntentReference](docs/PaymentIntentReference.md)
  - [CityPayApiClient::Ping](docs/Ping.md)
  - [CityPayApiClient::ProcessBatchRequest](docs/ProcessBatchRequest.md)
  - [CityPayApiClient::ProcessBatchResponse](docs/ProcessBatchResponse.md)
  - [CityPayApiClient::RefundRequest](docs/RefundRequest.md)
  - [CityPayApiClient::RegisterCard](docs/RegisterCard.md)
+ - [CityPayApiClient::RemittanceData](docs/RemittanceData.md)
+ - [CityPayApiClient::RemittanceReportRequest](docs/RemittanceReportRequest.md)
+ - [CityPayApiClient::RemittanceReportResponse](docs/RemittanceReportResponse.md)
+ - [CityPayApiClient::RemittedClientData](docs/RemittedClientData.md)
  - [CityPayApiClient::RequestChallenged](docs/RequestChallenged.md)
  - [CityPayApiClient::RetrieveRequest](docs/RetrieveRequest.md)
  - [CityPayApiClient::ThreeDSecure](docs/ThreeDSecure.md)
@@ -229,6 +256,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### cp-api-key
 
 

data/citypay_api_client.gemspec

@@ -3,11 +3,11 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is a 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 tokinsed payments using Card Holder 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](#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 card holder 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
-OpenAPI Generator version: 6.2.1
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
   s.summary     = "A ruby wrapper for the CityPay API"
   s.description = "CityPay API Client for Ruby"
   s.license     = "Unlicense"
-  s.required_ruby_version = ">= 2.4"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 

data/docs/Acknowledgement.md

@@ -15,10 +15,10 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::Acknowledgement.new(
-  code: 0,
+  code: 3,
   context: aspiu352908ns47n343598bads,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-  message: Approved 044332
+  message: Transaction Cancelled
 )
 ```
 

data/docs/AclCheckResponseModel.md

@@ -7,7 +7,7 @@
 | **acl** | **String** | The name or value of the acl which was found to match the ip address. | [optional] |
 | **cache** | **Boolean** | Whether the ACL was returned via a cached instance. | [optional] |
 | **ip** | **String** | The IP address used in the lookup. | [optional] |
-| **provider** | **String** | The source provider of the ACL. | [optional] |
+| **provider** | **String** | The source provider of the ACL such as cloud, subnet, country or IP based. | [optional] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::AclCheckResponseModel.new(
-  acl: null,
+  acl: Default ACL,
   cache: null,
   ip: 8.8.8.8,
-  provider: null
+  provider: AWS
 )
 ```
 

data/docs/AirlineAdvice.md

@@ -8,7 +8,7 @@
 | **conjunction_ticket_indicator** | **Boolean** | true if a conjunction ticket (with additional coupons) was issued for an itinerary with more than four segments. Defaults to false.  | [optional] |
 | **eticket_indicator** | **Boolean** | The Electronic Ticket Indicator, a code that indicates if an electronic ticket was issued.  Defaults to true. | [optional] |
 | **no_air_segments** | **Integer** | A value that indicates the number of air travel segments included on this ticket.  Valid entries include the numerals “0” through “4”. Required only if the transaction type is TKT or EXC.  | [optional] |
-| **number_in_party** | **Integer** | The number of people in the party. |  |
+| **number_in_party** | **Integer** | The number of people in the party. | [optional] |
 | **original_ticket_no** | **String** | Required if transaction type is EXC. | [optional] |
 | **passenger_name** | **String** | The name of the passenger when the traveller is not the card member that purchased the ticket. Required only if the transaction type is TKT or EXC. | [optional] |
 | **segment1** | [**AirlineSegment**](AirlineSegment.md) |  |  |

data/docs/AuthRequest.md

@@ -6,23 +6,24 @@
 | ---- | ---- | ----------- | ----- |
 | **airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] |
 | **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195.  |  |
-| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
 | **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
 | **cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.  |  |
-| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
-| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
 | **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
-| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
 | **event_management** | [**EventDataModel**](EventDataModel.md) |  | [optional] |
 | **expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12.  |  |
 | **expyear** | **Integer** | The year of expiry of the card.  |  |
 | **external_mpi** | [**ExternalMPI**](ExternalMPI.md) |  | [optional] |
 | **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
-| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
 | **mcc6012** | [**MCC6012**](MCC6012.md) |  | [optional] |
 | **merchantid** | **Integer** | Identifies the merchant account to perform processing for. |  |
 | **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] |
 | **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **Array<String>** |  | [optional] |
 | **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] |
 | **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
 | **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
@@ -34,7 +35,7 @@ require 'citypay_api_client'
 
 instance = CityPayApiClient::AuthRequest.new(
   airline_data: null,
-  amount: 3600,
+  amount: 19995,
   avs_postcode_policy: null,
   bill_to: null,
   cardnumber: 4000 0000 0000 0002,
@@ -44,7 +45,7 @@ instance = CityPayApiClient::AuthRequest.new(
   duplicate_policy: null,
   event_management: null,
   expmonth: 9,
-  expyear: 2025,
+  expyear: 2027,
   external_mpi: null,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   match_avsa: null,
@@ -52,6 +53,7 @@ instance = CityPayApiClient::AuthRequest.new(
   merchantid: 11223344,
   name_on_card: MR NE BODY,
   ship_to: null,
+  tag: null,
   threedsecure: null,
   trans_info: null,
   trans_type: null

data/docs/AuthResponse.md

@@ -16,7 +16,7 @@
 | **bin_description** | **String** | A description of the bin range found for the card. | [optional] |
 | **cavv** | **String** | The cardholder authentication verification value which can be returned for verification purposes of the authenticated  transaction for dispute realisation.  | [optional] |
 | **context** | **String** | The context which processed the transaction, can be used for support purposes to trace transactions. | [optional] |
-| **csc_result** | **String** | The CSC rseult codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline.  <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td> </td><td>No information</td></tr> <tr><td>M</td><td>Card verification data matches</td></tr> <tr><td>N</td><td>Card verification data was checked but did not match</td></tr> <tr><td>P</td><td>Card verification was not processed</td></tr> <tr><td>S</td><td>The card verification data should be on the card but the merchant indicates that it is not</td></tr> <tr><td>U</td><td>The card issuer is not certified</td></tr> </table>  | [optional] |
+| **csc_result** | **String** | The CSC result codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline.  <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td> </td><td>No information</td></tr> <tr><td>M</td><td>Card verification data matches</td></tr> <tr><td>N</td><td>Card verification data was checked but did not match</td></tr> <tr><td>P</td><td>Card verification was not processed</td></tr> <tr><td>S</td><td>The card verification data should be on the card but the merchant indicates that it is not</td></tr> <tr><td>U</td><td>The card issuer is not certified</td></tr> </table>  | [optional] |
 | **currency** | **String** | The currency the transaction was processed in. This is an `ISO4217` alpha currency value. | [optional] |
 | **datetime** | **Time** | The UTC date time of the transaction in ISO data time format.  | [optional] |
 | **eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.  | [optional] |
@@ -27,7 +27,9 @@
 | **result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value  <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>  |  |
 | **result_code** | **String** | The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure.  Codes may start with an alpha character i.e. C001 indicating a type of error such as a card validation error.  |  |
 | **result_message** | **String** | The message regarding the result which provides further narrative to the result code.  |  |
-| **scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme_id** | **String** | The name of the card scheme of the transaction such as VI or MC.  | [optional] |
+| **scheme_logo** | **String** | A url containing a logo of the card scheme.  | [optional] |
 | **sha256** | **String** | A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating   * authcode   * amount   * response_code   * merchant_id   * trans_no   * identifier   * licence_key - which is not provided in the response.  | [optional] |
 | **trans_status** | **String** | Used to identify the status of a transaction. The status is used to track a transaction through its life cycle.  <table> <tr> <th>Id</th> <th>Description</th> </tr> <tr> <td>O</td> <td>Transaction is open for settlement</td> </tr> <tr> <td>A</td> <td>Transaction is assigned for settlement and can no longer be voided</td> </tr> <tr> <td>S</td> <td>Transaction has been settled</td> </tr> <tr> <td>D</td> <td>Transaction has been declined</td> </tr> <tr> <td>R</td> <td>Transaction has been rejected</td> </tr> <tr> <td>P</td> <td>Transaction has been authorised only and awaiting a capture. Used in pre-auth situations</td> </tr> <tr> <td>C</td> <td>Transaction has been cancelled</td> </tr> <tr> <td>E</td> <td>Transaction has expired</td> </tr> <tr> <td>I</td> <td>Transaction has been initialised but no action was able to be carried out</td> </tr> <tr> <td>H</td> <td>Transaction is awaiting authorisation</td> </tr> <tr> <td>.</td> <td>Transaction is on hold</td> </tr> <tr> <td>V</td> <td>Transaction has been verified</td> </tr> </table>  | [optional] |
 | **transno** | **Integer** | The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.  | [optional] |
@@ -38,7 +40,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::AuthResponse.new(
-  amount: 3600,
+  amount: 19995,
   atrn: null,
   atsd: null,
   authcode: 001245A,
@@ -48,12 +50,12 @@ instance = CityPayApiClient::AuthResponse.new(
   bin_commercial: null,
   bin_debit: null,
   bin_description: Platinum Card,
-  cavv: null,
+  cavv: 00000109260000719349,
   context: aspiu352908ns47n343598bads,
   csc_result: null,
   currency: GBP,
   datetime: 2020-01-02T18:32:28Z,
-  eci: null,
+  eci: 5,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   live: true,
   maskedpan: 4***********0002,
@@ -62,6 +64,8 @@ instance = CityPayApiClient::AuthResponse.new(
   result_code: 0,
   result_message: Accepted Transaction,
   scheme: Visa,
+  scheme_id: MC,
+  scheme_logo: https://cdn.citypay.com/img/cs/visa-logo.svg,
   sha256: null,
   trans_status: null,
   transno: 78416