citypay_api_client 1.0.0

data/docs/CardStatus.md

@@ -0,0 +1,19 @@
+# CityPayApiClient::CardStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_status** | **String** | The status of the card to set, valid values are ACTIVE or INACTIVE. | [optional] 
+**default** | **Boolean** | Defines if the card is set as the default. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::CardStatus.new(card_status: null,
+                                 default: null)
+```
+
+

data/docs/ChargeRequest.md

@@ -0,0 +1,41 @@
+# CityPayApiClient::ChargeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**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] 
+**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] 
+**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 32 to 127.  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] 
+**merchantid** | **Integer** | Identifies the merchant account to perform processing for. | 
+**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
+**token** | **String** | A tokenised form of a card that belongs to a card holder's account and that has been previously registered. The token is time based and will only be active for a short duration. The value is therefore designed not to be stored remotely for future  use.  Tokens will start with ct and are resiliently tamper proof using HMacSHA-256. No sensitive card data is stored internally within the token.  Each card will contain a different token and the value may be different on any retrieval call.  The value can be presented for payment as a selection value to an end user in a web application.  | 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::ChargeRequest.new(amount: 3600,
+                                 avs_postcode_policy: null,
+                                 csc: 12,
+                                 csc_policy: null,
+                                 currency: GBP,
+                                 duplicate_policy: null,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 match_avsa: null,
+                                 merchantid: 11223344,
+                                 sdk: MyClient 1.3.0,
+                                 token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr,
+                                 trans_info: null,
+                                 trans_type: null)
+```
+
+

data/docs/ContactDetails.md

@@ -0,0 +1,41 @@
+# CityPayApiClient::ContactDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address1** | **String** | The first line of the address for the card holder. | [optional] 
+**address2** | **String** | The second line of the address for the card holder. | [optional] 
+**address3** | **String** | The third line of the address for the card holder. | [optional] 
+**area** | **String** | The area such as city, department, parish for the card holder. | [optional] 
+**company** | **String** | The company name for the card holder if the contact is a corporate contact. | [optional] 
+**country** | **String** | The country code in ISO 3166 format. The country value may be used for fraud analysis and for   acceptance of the transaction.  | [optional] 
+**email** | **String** | An email address for the card holder which may be used for correspondence. | [optional] 
+**firstname** | **String** | The first name  of the card holder. | [optional] 
+**lastname** | **String** | The last name or surname of the card holder. | [optional] 
+**mobile_no** | **String** | A mobile number for the card holder the mobile number is often required by delivery companies to ensure they are able to be in contact when required. | [optional] 
+**postcode** | **String** | The postcode or zip code of the address which may be used for fraud analysis. | [optional] 
+**telephone_no** | **String** | A telephone number for the card holder. | [optional] 
+**title** | **String** | A title for the card holder such as Mr, Mrs, Ms, M. Mme. etc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::ContactDetails.new(address1: 79 Parliament St,
+                                 address2: Westminster,
+                                 address3: null,
+                                 area: London,
+                                 company: Acme Ltd,
+                                 country: GB,
+                                 email: card.holder@citypay.com,
+                                 firstname: John,
+                                 lastname: Smith,
+                                 mobile_no: 447790123456,
+                                 postcode: L1 789,
+                                 telephone_no: 442030123456,
+                                 title: Mr)
+```
+
+

data/docs/Decision.md

@@ -0,0 +1,21 @@
+# CityPayApiClient::Decision
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authentication** | [**AuthenRequired**](AuthenRequired.md) |  | [optional] 
+**challenge** | [**RequestChallenged**](RequestChallenged.md) |  | [optional] 
+**result** | [**AuthResponse**](AuthResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::Decision.new(authentication: null,
+                                 challenge: null,
+                                 result: null)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,23 @@
+# CityPayApiClient::Error
+
+## 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::Error.new(code: 0,
+                                 context: aspiu352908ns47n343598bads,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 message: Approved 044332)
+```
+
+

data/docs/ExternalMPI.md

@@ -0,0 +1,25 @@
+# CityPayApiClient::ExternalMPI
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authen_result** | **String** | The authentication result available from the MPI. | [optional] 
+**cavv** | **String** | A value determining the cardholder verification value supplied by the card scheme. | [optional] 
+**eci** | **Integer** | The obtained e-commerce indicator from the MPI. | [optional] 
+**enrolled** | **String** | A value determining whether the card holder was enrolled. | [optional] 
+**xid** | **String** | The XID used for processing with the MPI. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::ExternalMPI.new(authen_result: null,
+                                 cavv: null,
+                                 eci: null,
+                                 enrolled: null,
+                                 xid: null)
+```
+
+

data/docs/ListMerchantsResponse.md

@@ -0,0 +1,21 @@
+# CityPayApiClient::ListMerchantsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_name** | **String** | The client name that was requested. | [optional] 
+**clientid** | **String** | The client id requested. | [optional] 
+**merchants** | [**Array<Merchant>**](Merchant.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::ListMerchantsResponse.new(client_name: null,
+                                 clientid: PC12345,
+                                 merchants: null)
+```
+
+

data/docs/MCC6012.md

@@ -0,0 +1,23 @@
+# CityPayApiClient::MCC6012
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recipient_account** | **String** | The account number of the recipient. | [optional] 
+**recipient_dob** | **String** | The date of birth of the recipient. | [optional] 
+**recipient_lastname** | **String** | The lastname of ther recepient. | [optional] 
+**recipient_postcode** | **String** | The postcode of the recipient. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::MCC6012.new(recipient_account: null,
+                                 recipient_dob: null,
+                                 recipient_lastname: null,
+                                 recipient_postcode: null)
+```
+
+

data/docs/Merchant.md

@@ -0,0 +1,25 @@
+# CityPayApiClient::Merchant
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** | The currency of the merchant. | [optional] 
+**merchantid** | **Integer** | The merchant id which uniquely identifies the merchant account. | [optional] 
+**name** | **String** | The name of the merchant. | [optional] 
+**status** | **String** | The status of the account. | [optional] 
+**status_label** | **String** | The status label of the account. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::Merchant.new(currency: GBP,
+                                 merchantid: 11223344,
+                                 name: Merchant 1,
+                                 status: A,
+                                 status_label: Active)
+```
+
+

data/docs/OperationalApi.md

@@ -0,0 +1,118 @@
+# CityPayApiClient::OperationalApi
+
+All URIs are relative to *https://api.citypay.com/v6*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_merchants_request**](OperationalApi.md#list_merchants_request) | **GET** /merchants/{clientid} | List Merchants Request
+[**ping_request**](OperationalApi.md#ping_request) | **POST** /ping | Ping Request
+
+
+
+## list_merchants_request
+
+> ListMerchantsResponse list_merchants_request(clientid)
+
+List Merchants Request
+
+An operational request to list current merchants for a client.  ### Sorting  Sorting can be performed by include a query parameter i.e. `/merchants/?sort=merchantid`  Fields that can be sorted are `merchantid` or `name`. 
+
+### Example
+
+```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::OperationalApi.new
+clientid = 'clientid_example' # String | The client id to return merchants for, specifying \"default\" will use the value in your api key.
+
+begin
+  #List Merchants Request
+  result = api_instance.list_merchants_request(clientid)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling OperationalApi->list_merchants_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **clientid** | **String**| The client id to return merchants for, specifying \"default\" will use the value in your api key. | 
+
+### Return type
+
+[**ListMerchantsResponse**](ListMerchantsResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## ping_request
+
+> Acknowledgement ping_request(ping)
+
+Ping Request
+
+A ping request which performs a connection and authentication test to the CityPay API server. The request will return a standard Acknowledgement with a response code `044` to signify a successful ping.  The ping call is useful to confirm that you will be able to access  the API from behind any firewalls and that the permission model is granting access from your source. 
+
+### Example
+
+```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::OperationalApi.new
+ping = CityPayApiClient::Ping.new # Ping | 
+
+begin
+  #Ping Request
+  result = api_instance.ping_request(ping)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling OperationalApi->ping_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ping** | [**Ping**](Ping.md)|  | 
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+

data/docs/PaResAuthRequest.md

@@ -0,0 +1,19 @@
+# CityPayApiClient::PaResAuthRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**md** | **String** | The Merchant Data (MD) which is a unique ID to reference the authentication session. This value will be created by CityPay when required. When responding from the ACS, this value will be returned by the ACS.  | 
+**pares** | **String** | The Payer Authentication Response packet which is returned by the ACS containing the  response of the authentication session including verification values. The response  is a base64 encoded packet and should be forwarded to CityPay untouched.  | 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::PaResAuthRequest.new(md: null,
+                                 pares: v66ycfSp8jNlvy7PkHbx44NEt3vox90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirb...)
+```
+
+

data/docs/PaymentProcessingApi.md

@@ -0,0 +1,338 @@
+# CityPayApiClient::PaymentProcessingApi
+
+All URIs are relative to *https://api.citypay.com/v6*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authorisation_request**](PaymentProcessingApi.md#authorisation_request) | **POST** /authorise | Authorisation
+[**c_res_request**](PaymentProcessingApi.md#c_res_request) | **POST** /cres | CRes
+[**capture_request**](PaymentProcessingApi.md#capture_request) | **POST** /capture | Capture
+[**pa_res_request**](PaymentProcessingApi.md#pa_res_request) | **POST** /pares | PaRes
+[**retrieval_request**](PaymentProcessingApi.md#retrieval_request) | **POST** /retrieve | Retrieval
+[**void_request**](PaymentProcessingApi.md#void_request) | **POST** /void | Void
+
+
+
+## authorisation_request
+
+> Decision authorisation_request(auth_request)
+
+Authorisation
+
+An authorisation process performs a standard transaction authorisation based on the provided parameters of its request. The CityPay gateway will route your transaction via an Acquiring bank for subsequent authorisation to the appropriate card  schemes such as Visa or MasterCard.  The authorisation API should be used for server environments to process transactions on demand and in realtime.   The authorisation API can be used for multiple types of transactions including E-commerce, mail order, telephone order, customer present (keyed), continuous authority, pre-authorisation and others. CityPay will configure your account for  the appropriate coding and this will perform transparently by the gateway.   Data properties that are required, may depend on the environment you are conducting payment for. Our API aims to be  flexible enough to cater for these structures. Our integration team will aid you in providing the necessary data to   transact.      ### E-commerce workflows   For E-commerce transactions requiring 3DSv1 and 3DSv2 transactions, the API contains a fully accredited in built mechanism to handle authentication.  The gateway has been accredited extensively with both Acquirers and Card Schemes and simplifies the nature of these calls into a simple structure for authentication, preventing integrators from performing lengthy and a costly accreditation with Visa and MasterCard.  3D-secure has been around for a number of years and aims to shift the liability of a transaction away from a merchant back to the card holder. A *liability shift* determines whether a card holder can charge back a transaction as unknown. Effectively the process asks for a card holder to authenticate the transaction prior to authorisation producing a Cardholder  verification value (CAVV) as evidence of authorisation.   #### 3DSv1  ```json {    \"AuthenticationRequired\": {     \"acsurl\": \"https://bank.com/3DS/ACS\",     \"pareq\": \"SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...\",     \"md\": \"WQgZXZlcnl0aGluZyBiZW\"   }                } ```  ```xml <AuthenticationRequired>  <acsurl>https://bank.com/3DS/ACS</acsurl>  <pareq>SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...</pareq>  <md>WQgZXZlcnl0aGluZyBiZW</md> </AuthenticationRequired> ```  For E-commerce transactions requiring 3DSv1, the API contains a built in MPI which will be called to check whether the  card is participating in 3DSv1 with Verified by Visa or MasterCard SecureCode. We only support Amex SafeKey with 3DSv2. Should the card be enrolled, a payer  request (PAReq) value will be created and returned back as an [authentication required](#authenticationrequired) response object.   Your system will need to process this authentication packet and forward the user's browser to an authentication server (ACS)  to gain the user's authentication. Once complete, the ACS will produce a HTTP `POST` call back to the URL supplied in   the authentication request as `merchant_termurl`. This URL should behave as a controller and handle the post data from the   ACS and on a forked server to server HTTP request, forward this data to the [pares authentication url](#pares) for    subsequent authorisation processing. You may prefer to provide a processing page whilst this is being processed.   Processing with our systems should be relatively quick and be between 500ms - 3000ms however it is desirable to let   the user see that something is happening rather than a pending browser.      The main reason for ensuring that this controller is two fold:      1. We are never in control of the user's browser in a server API call   2. The controller is actioned on your site to ensure that any post actions from authorisation can be executed in real time    To forward the user to the ACS, we recommend a simple auto submit HTML form.  ```html <html lang=\"en\">  <head>         <title>Forward to ACS</title>   <script type=\"text/javascript\">         function onLoadEvent() {              document.acs.submit();          }         </script>         <noscript>You will require JavaScript to be enabled to complete this transaction</noscript>     </head>     <body onload=\"onLoadEvent();\">         <form name=\"acs\" action=\"{{ACSURL from Response}}\" method=\"POST\">             <input type=\"hidden\" name=\"PaReq\" value=\"{{PaReq Packet from Response}}\" />             <input type=\"hidden\" name=\"TermUrl\" value=\"{{Your Controller}}\" />             <input type=\"hidden\" name=\"MD\" value=\"{{MD From Response}}\" />         </form>     </body> </html> ```  Please note that 3DSv1 is being phased out due to changes to strong customer authentication mechanisms. 3DSv2 addresses this and will solidify the authorisation and confirmation process.  We provide a Test ACS for full 3DSv1 integration testing that simulates an ACS.    #### 3DSv2  ```json {    \"RequestChallenged\": {     \"acsurl\": \"https://bank.com/3DS/ACS\",     \"creq\": \"SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...\"   }                } ```  ```xml <RequestChallenged>  <acsurl>https://bank.com/3DS/ACS</acsurl>  <creq>SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...</creq> </RequestChallenged> ```  All merchants in the EEC will require to migrate their E-commerce transactions to a secure customer authentication  model (SCA) throughout 2020. This has been adopted by the payment's industry as a progressive move alongside the European  Unions payments service directive.  CityPay support 3DSv2 for Verified by Visa, MasterCard Identity Check and American Express SafeKey 2.0 and will be rolling out acquirers on the new platform from Q2 2020. The new enhancement to 3DSv2 will allow for CityPay to seamlessly authenticate transactions in a \"frictionless\" flowed method which will authenticate low risk transactions with minimal impact to a  standard authorisation flow. Our API simply performs this on behalf of the merchant and cardholder. For these transactions you will not be required to change anything.  However, should a transaction be \"challenged\" the API will return a [request challenge](#requestchallenged) which will  require your integration to forward the cardholder's browser to the given [ACS url](#acsurl) by posting the [creq](#creq) value. Once complete, the ACS will have already been in touch with our servers by sending us a result of the authentication known as `RReq`.  Our servers however will await confirmation that the authorisation should continue and on receipt of a [cres](#cres) value, the flow will perform full authorisation processing.   Please note that the CRes returned to us is purely a mechanism of acknowledging that transactions should be committed for authorisation. The ACS by this point will have sent us the verification value (CAVV) to perform a liability shift. The CRes value will be validated for receipt of the CAVV and subsequently may return back response codes illustrating this.   To forward the user to the ACS, we recommend a simple auto submit HTML form.  ```html <html lang=\"en\">  <head>         <title>Forward to ACS</title>   <script type=\"text/javascript\">         function onLoadEvent() {              document.acs.submit();          }         </script>         <noscript>You will require JavaScript to be enabled to complete this transaction</noscript>     </head>     <body onload=\"onLoadEvent();\">         <form name=\"acs\" action=\"{{ACSURL from Response}}\" method=\"POST\">             <input type=\"hidden\" name=\"creq\" value=\"{{CReq Packet from Response}}\" />         </form>     </body> </html> ```  We are currently working on an integration test suite for 3DSv2 which will mock the ACS challenge process. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+auth_request = CityPayApiClient::AuthRequest.new # AuthRequest | 
+
+begin
+  #Authorisation
+  result = api_instance.authorisation_request(auth_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->authorisation_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_request** | [**AuthRequest**](AuthRequest.md)|  | 
+
+### Return type
+
+[**Decision**](Decision.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## c_res_request
+
+> AuthResponse c_res_request(c_res_auth_request)
+
+CRes
+
+The CRes request performs authorisation processing once a challenge request has been completed with an Authentication Server (ACS). This challenge response contains confirmation that will allow the API systems to return an authorisation response based on the result. Our systems will  know out of band via an `RReq` call by the ACS to notify us if the liability shift has been issued.  Any call to the CRes operation will require a previous authorisation request and cannot be called  on its own without a previous [request challenge](#requestchallenged) being obtained. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+c_res_auth_request = CityPayApiClient::CResAuthRequest.new # CResAuthRequest | 
+
+begin
+  #CRes
+  result = api_instance.c_res_request(c_res_auth_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->c_res_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **c_res_auth_request** | [**CResAuthRequest**](CResAuthRequest.md)|  | 
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## capture_request
+
+> Acknowledgement capture_request(capture_request)
+
+Capture
+
+_The capture process only applies to transactions which have been pre-authorised only._   The capture process will ensure that a transaction will now settle. It is expected that a capture call will be provided within 3 days or a maximum of 7 days.  A capture request is provided to confirm that you wish the transaction to be settled. This request can contain a final amount for the transaction which is different to the original authorisation amount. This may be useful in a delayed system process such as waiting for stock to be ordered, confirmed, or services provided before the final cost is known.  When a transaction is completed, a new authorisation code may be created and a new confirmation can be sent online to the acquiring bank.  Once the transaction has been processed. A standard [`Acknowledgement`](#acknowledgement) will be returned, outlining the result of the transaction. On a successful completion process, the transaction will be available for the settlement and completed at the end of the day. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+capture_request = CityPayApiClient::CaptureRequest.new # CaptureRequest | 
+
+begin
+  #Capture
+  result = api_instance.capture_request(capture_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->capture_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **capture_request** | [**CaptureRequest**](CaptureRequest.md)|  | 
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## pa_res_request
+
+> AuthResponse pa_res_request(pa_res_auth_request)
+
+PaRes
+
+The Payer Authentication Response (PaRes) is an operation after the result of authentication   being performed. The request uses an encoded packet of authentication data to  notify us of the completion of the liability shift. Once this value has been unpacked and its signature is checked, our systems will proceed to authorisation processing.    Any call to the PaRes operation will require a previous authorisation request and cannot be called  on its own without a previous [authentication required](#authenticationrequired)  being obtained. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+pa_res_auth_request = CityPayApiClient::PaResAuthRequest.new # PaResAuthRequest | 
+
+begin
+  #PaRes
+  result = api_instance.pa_res_request(pa_res_auth_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->pa_res_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pa_res_auth_request** | [**PaResAuthRequest**](PaResAuthRequest.md)|  | 
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## retrieval_request
+
+> AuthReferences retrieval_request(retrieve_request)
+
+Retrieval
+
+A retrieval request which allows an integration to obtain the result of a transaction processed in the last 90 days. The request allows for retrieval based on the identifier or transaction  number.   The process may return multiple results in particular where a transaction was processed multiple times against the same identifier. This can happen if errors were first received. The API therefore returns up to the first 5 transactions in the latest date time order.  It is not intended for this operation to be a replacement for reporting and only allows for base transaction information to be returned. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+retrieve_request = CityPayApiClient::RetrieveRequest.new # RetrieveRequest | 
+
+begin
+  #Retrieval
+  result = api_instance.retrieval_request(retrieve_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->retrieval_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **retrieve_request** | [**RetrieveRequest**](RetrieveRequest.md)|  | 
+
+### Return type
+
+[**AuthReferences**](AuthReferences.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## void_request
+
+> Acknowledgement void_request(void_request)
+
+Void
+
+_The void process generally applies to transactions which have been pre-authorised only however voids can occur  on the same day if performed before batching and settlement._   The void process will ensure that a transaction will now settle. It is expected that a void call will be  provided on the same day before batching and settlement or within 3 days or within a maximum of 7 days.  Once the transaction has been processed as a void, an [`Acknowledgement`](#acknowledgement) will be returned, outlining the result of the transaction. 
+
+### Example
+
+```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::PaymentProcessingApi.new
+void_request = CityPayApiClient::VoidRequest.new # VoidRequest | 
+
+begin
+  #Void
+  result = api_instance.void_request(void_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling PaymentProcessingApi->void_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **void_request** | [**VoidRequest**](VoidRequest.md)|  | 
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+