citypay_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 850a1d1f9a63c3637a70b7d7f766fab91b2c0f2052f41a01970e3d0c42b54a5c
+  data.tar.gz: 54f1d9013d20448319ab3db2766014e2695499d22d02c7a21b625b6602f54924
+SHA512:
+  metadata.gz: 52e1c157f646c683e3d5b21c270124104d5f16d42553819ab07f54cb9af028ee0c8abd26b5738132bad78886e639105dc366eeaddafaa2b81e67aa54c2b80621
+  data.tar.gz: a980f50a46a4ba1cc254cd80daed48c0f4c91f068d8e17fb58c16bd911ac27eedfb4a3874e2a2cefeb5b5d2003c38b4e60a9fa774610c5cf87bc9a31761bf179

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,176 @@
+# citypay_api_client
+
+CityPayApiClient - the Ruby gem for the 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
+<aside class=\"notice\">
+  Before we begin a reminder that 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 including:
+</aside>
+
+* 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.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 6.0.0
+- Package version: 1.0.0
+- 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)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build citypay_api_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./citypay_api_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./citypay_api_client-1.0.0.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.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/citypay/citypay-api-client-ruby, then add the following in the Gemfile:
+
+    gem 'citypay_api_client', :git => 'https://github.com/citypay/citypay-api-client-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'citypay_api_client'
+
+# Setup authorization
+CityPayApiClient.configure do |config|
+  # Configure API key authorization: cp-api-key
+  config.api_key['cp-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['cp-api-key'] = 'Bearer'
+end
+
+api_instance = CityPayApiClient::CardHolderAccountApi.new
+accountid = 'accountid_example' # String | The account id that refers to the customer's account no. This value will have been provided when setting up the card holder account.
+card_id = 'card_id_example' # String | The id of the card that is presented by a call to retrieve a card holder account.
+
+begin
+  #Card Deletion
+  result = api_instance.account_card_delete_request(accountid, card_id)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_card_delete_request: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.citypay.com/v6*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_delete_request**](docs/CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /account/{accountid}/card/{cardId} | Card Deletion
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_register_request**](docs/CardHolderAccountApi.md#account_card_register_request) | **POST** /account/{accountid}/register | Card Registration
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_status_request**](docs/CardHolderAccountApi.md#account_card_status_request) | **POST** /account/{accountid}/card/{cardId}/status | Card Status
+*CityPayApiClient::CardHolderAccountApi* | [**account_change_contact_request**](docs/CardHolderAccountApi.md#account_change_contact_request) | **POST** /account/{accountid}/contact | Contact Details Update
+*CityPayApiClient::CardHolderAccountApi* | [**account_create**](docs/CardHolderAccountApi.md#account_create) | **POST** /account/create | Account Create
+*CityPayApiClient::CardHolderAccountApi* | [**account_delete_request**](docs/CardHolderAccountApi.md#account_delete_request) | **DELETE** /account/{accountid} | Account Deletion
+*CityPayApiClient::CardHolderAccountApi* | [**account_retrieve_request**](docs/CardHolderAccountApi.md#account_retrieve_request) | **GET** /account/{accountid} | Account Retrieval
+*CityPayApiClient::CardHolderAccountApi* | [**account_status_request**](docs/CardHolderAccountApi.md#account_status_request) | **POST** /account/{accountid}/status | Account Status
+*CityPayApiClient::CardHolderAccountApi* | [**charge_request**](docs/CardHolderAccountApi.md#charge_request) | **POST** /charge | Charge
+*CityPayApiClient::OperationalApi* | [**list_merchants_request**](docs/OperationalApi.md#list_merchants_request) | **GET** /merchants/{clientid} | List Merchants Request
+*CityPayApiClient::OperationalApi* | [**ping_request**](docs/OperationalApi.md#ping_request) | **POST** /ping | Ping Request
+*CityPayApiClient::PaymentProcessingApi* | [**authorisation_request**](docs/PaymentProcessingApi.md#authorisation_request) | **POST** /authorise | Authorisation
+*CityPayApiClient::PaymentProcessingApi* | [**c_res_request**](docs/PaymentProcessingApi.md#c_res_request) | **POST** /cres | CRes
+*CityPayApiClient::PaymentProcessingApi* | [**capture_request**](docs/PaymentProcessingApi.md#capture_request) | **POST** /capture | Capture
+*CityPayApiClient::PaymentProcessingApi* | [**pa_res_request**](docs/PaymentProcessingApi.md#pa_res_request) | **POST** /pares | PaRes
+*CityPayApiClient::PaymentProcessingApi* | [**retrieval_request**](docs/PaymentProcessingApi.md#retrieval_request) | **POST** /retrieve | Retrieval
+*CityPayApiClient::PaymentProcessingApi* | [**void_request**](docs/PaymentProcessingApi.md#void_request) | **POST** /void | Void
+
+
+## Documentation for Models
+
+ - [CityPayApiClient::AccountCreate](docs/AccountCreate.md)
+ - [CityPayApiClient::AccountStatus](docs/AccountStatus.md)
+ - [CityPayApiClient::Acknowledgement](docs/Acknowledgement.md)
+ - [CityPayApiClient::AirlineAdvice](docs/AirlineAdvice.md)
+ - [CityPayApiClient::AirlineSegment](docs/AirlineSegment.md)
+ - [CityPayApiClient::AuthReference](docs/AuthReference.md)
+ - [CityPayApiClient::AuthReferences](docs/AuthReferences.md)
+ - [CityPayApiClient::AuthRequest](docs/AuthRequest.md)
+ - [CityPayApiClient::AuthResponse](docs/AuthResponse.md)
+ - [CityPayApiClient::AuthenRequired](docs/AuthenRequired.md)
+ - [CityPayApiClient::CResAuthRequest](docs/CResAuthRequest.md)
+ - [CityPayApiClient::CaptureRequest](docs/CaptureRequest.md)
+ - [CityPayApiClient::Card](docs/Card.md)
+ - [CityPayApiClient::CardHolderAccount](docs/CardHolderAccount.md)
+ - [CityPayApiClient::CardStatus](docs/CardStatus.md)
+ - [CityPayApiClient::ChargeRequest](docs/ChargeRequest.md)
+ - [CityPayApiClient::ContactDetails](docs/ContactDetails.md)
+ - [CityPayApiClient::Decision](docs/Decision.md)
+ - [CityPayApiClient::Error](docs/Error.md)
+ - [CityPayApiClient::ExternalMPI](docs/ExternalMPI.md)
+ - [CityPayApiClient::ListMerchantsResponse](docs/ListMerchantsResponse.md)
+ - [CityPayApiClient::MCC6012](docs/MCC6012.md)
+ - [CityPayApiClient::Merchant](docs/Merchant.md)
+ - [CityPayApiClient::PaResAuthRequest](docs/PaResAuthRequest.md)
+ - [CityPayApiClient::Ping](docs/Ping.md)
+ - [CityPayApiClient::RegisterCard](docs/RegisterCard.md)
+ - [CityPayApiClient::RequestChallenged](docs/RequestChallenged.md)
+ - [CityPayApiClient::RetrieveRequest](docs/RetrieveRequest.md)
+ - [CityPayApiClient::ThreeDSecure](docs/ThreeDSecure.md)
+ - [CityPayApiClient::VoidRequest](docs/VoidRequest.md)
+
+
+## Documentation for Authorization
+
+
+### cp-api-key
+
+
+- **Type**: API key
+- **API key parameter name**: cp-api-key
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/citypay_api_client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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 <aside class=\"notice\">   Before we begin a reminder that 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 including: </aside>  * 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. 
+
+The version of the OpenAPI document: 6.0.0
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "citypay_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "citypay_api_client"
+  s.version     = CityPayApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["citypay"]
+  s.email       = ["support@citypay.com"]
+  s.homepage    = "https://github.com/citypay/citypay-api-client-ruby"
+  s.summary     = "A ruby wrapper for the CityPay API"
+  s.description = "CityPay API Client for Ruby"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AccountCreate.md

@@ -0,0 +1,19 @@
+# CityPayApiClient::AccountCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | A card holder account id used for uniquely identifying the account. This value will be used for future referencing of the account oand to link your system to this API. This value is immutable and never changes.  | 
+**contact** | [**ContactDetails**](ContactDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AccountCreate.new(account_id: aaabbb-cccddd-eee,
+                                 contact: null)
+```
+
+

data/docs/AccountStatus.md

@@ -0,0 +1,17 @@
+# CityPayApiClient::AccountStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The status of the account to set, valid values are ACTIVE or DISABLED. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AccountStatus.new(status: null)
+```
+
+

data/docs/Acknowledgement.md

@@ -0,0 +1,23 @@
+# CityPayApiClient::Acknowledgement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | A response code providing a result of the process. | [optional] 
+**context** | **String** | A context id of the process used for referencing transactions through support. | [optional] 
+**identifier** | **String** | An identifier if presented in the original request. | [optional] 
+**message** | **String** | A response message providing a description of the result of the process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::Acknowledgement.new(code: 0,
+                                 context: aspiu352908ns47n343598bads,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 message: Approved 044332)
+```
+
+

data/docs/AirlineAdvice.md

@@ -0,0 +1,47 @@
+# CityPayApiClient::AirlineAdvice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_name** | **String** | The name of the airline carrier that generated the tickets for airline travel. | 
+**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. | 
+**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) |  | 
+**segment2** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
+**segment3** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
+**segment4** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
+**ticket_issue_city** | **String** | The name of the city town or village where the transaction took place. | 
+**ticket_issue_date** | **Date** | The date the ticket was issued in ISO Date format (yyyy-MM-dd). | 
+**ticket_issue_name** | **String** | The name of the agency generating the ticket. | 
+**ticket_no** | **String** | This must be a valid ticket number, i.e. numeric (the first 3 digits must represent the valid IATA plate carrier code). The final check digit should be validated prior to submission. On credit charges, this field should contain the number of the original ticket, and not of a replacement.  | 
+**transaction_type** | **String** | This field contains the Transaction Type code assigned to this transaction. Valid codes include:   - `TKT` = Ticket Purchase  - `REF` = Refund  - `EXC` = Exchange Ticket  - `MSC` = Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only).  | 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AirlineAdvice.new(carrier_name: EG Air,
+                                 conjunction_ticket_indicator: false,
+                                 eticket_indicator: true,
+                                 no_air_segments: 2,
+                                 number_in_party: 2,
+                                 original_ticket_no: null,
+                                 passenger_name: NE Person,
+                                 segment1: null,
+                                 segment2: null,
+                                 segment3: null,
+                                 segment4: null,
+                                 ticket_issue_city: London,
+                                 ticket_issue_date: Sat Aug 01 00:00:00 GMT 2020,
+                                 ticket_issue_name: Issue Name,
+                                 ticket_no: A112233,
+                                 transaction_type: TKT)
+```
+
+

data/docs/AirlineSegment.md

@@ -0,0 +1,31 @@
+# CityPayApiClient::AirlineSegment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arrival_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the arrival portion of this segment.  | 
+**carrier_code** | **String** | This field contains the two character airline designator code (air carrier code or airline code) that corresponds to the airline carrier applicable for up to four flight segments of this trip itinerary.  | 
+**class_service_code** | **String** | This field contains a code that corresponds to the fare class (A, B, C, D, Premium, Discounted, etc.) within the overall class of service (e.g., First Class, Business, Economy) applicable to this travel segment, as specified in the IATA Standard Code allocation table.  | 
+**departure_date** | **Date** | The Departure Date for the travel segment in ISO Date Format (yyyy-MM-dd). | 
+**departure_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the departure portion of this segment.  | [optional] 
+**flight_number** | **String** | This field contains the carrier-assigned Flight Number for this travel segment. | 
+**segment_fare** | **Integer** | This field contains the total Fare for this travel segment. | [optional] 
+**stop_over_indicator** | **String** | O = Stopover allowed, X = Stopover not allowed. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AirlineSegment.new(arrival_location_code: SOU,
+                                 carrier_code: ZZ,
+                                 class_service_code: CC,
+                                 departure_date: Sat Aug 01 00:00:00 GMT 2020,
+                                 departure_location_code: JER,
+                                 flight_number: 772,
+                                 segment_fare: 7500,
+                                 stop_over_indicator: 1)
+```
+
+

data/docs/AuthReference.md

@@ -0,0 +1,43 @@
+# CityPayApiClient::AuthReference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | The amount of the transaction in decimal currency format. | [optional] 
+**amount_value** | **String** | The amount of the transaction in integer/request format. | [optional] 
+**atrn** | **String** | A reference number provided by the acquiring services. | [optional] 
+**authcode** | **String** | The authorisation code of the transaction returned by the acquirer or card issuer. | [optional] 
+**batchno** | **String** | A batch number which the transaction has been end of day batched towards. | [optional] 
+**currency** | **String** | The currency of the transaction in ISO 4217 code format. | [optional] 
+**datetime** | **DateTime** | The date and time of the transaction. | [optional] 
+**identifier** | **String** | The identifier of the transaction used to process the transaction. | [optional] 
+**maskedpan** | **String** | A masking of the card number which was used to process the tranasction. | [optional] 
+**merchantid** | **Integer** | The merchant id of the transaction result. | [optional] 
+**result** | **String** | The result of the transaction. | [optional] 
+**trans_status** | **String** | The current status of the transaction through it's lifecycle. | [optional] 
+**trans_type** | **String** | The type of transaction that was processed. | [optional] 
+**transno** | **Integer** | The transaction number of the transaction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AuthReference.new(amount: 3600,
+                                 amount_value: null,
+                                 atrn: null,
+                                 authcode: 001245A,
+                                 batchno: null,
+                                 currency: GBP,
+                                 datetime: 2020-01-02T18:32:28Z,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 maskedpan: 4***********0002,
+                                 merchantid: 11223344,
+                                 result: null,
+                                 trans_status: null,
+                                 trans_type: null,
+                                 transno: 78416)
+```
+
+

data/docs/AuthReferences.md

@@ -0,0 +1,17 @@
+# CityPayApiClient::AuthReferences
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auths** | [**Array<AuthReference>**](AuthReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AuthReferences.new(auths: null)
+```
+
+