citypay_api_client 1.0.0

data/docs/AuthRequest.md

@@ -0,0 +1,59 @@
+# CityPayApiClient::AuthRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] 
+**card_holder_name** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [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] 
+**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] 
+**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 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] 
+**mcc6012** | [**MCC6012**](MCC6012.md) |  | [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] 
+**ship_to** | [**ContactDetails**](ContactDetails.md) |  | [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] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AuthRequest.new(airline_data: null,
+                                 amount: 3600,
+                                 avs_postcode_policy: null,
+                                 bill_to: null,
+                                 card_holder_name: null,
+                                 cardnumber: 4000 0000 0000 0002,
+                                 csc: 12,
+                                 csc_policy: null,
+                                 currency: GBP,
+                                 duplicate_policy: null,
+                                 expmonth: 9,
+                                 expyear: 2023,
+                                 external_mpi: null,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 match_avsa: null,
+                                 mcc6012: null,
+                                 merchantid: 11223344,
+                                 sdk: MyClient 1.3.0,
+                                 ship_to: null,
+                                 threedsecure: null,
+                                 trans_info: null,
+                                 trans_type: null)
+```
+
+

data/docs/AuthResponse.md

@@ -0,0 +1,69 @@
+# CityPayApiClient::AuthResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | The amount of the transaction processed. | [optional] 
+**atrn** | **String** | A reference number provided by the acquirer for a transaction it can be used to cross reference transactions with an Acquirers reporting panel.  | [optional] 
+**atsd** | **String** | Additional Transaction Security Data used for ecommerce transactions to decipher security capabilities and attempts against a transaction. | [optional] 
+**authcode** | **String** | The authorisation code as returned by the card issuer or acquiring bank when a transaction has successfully   been authorised. Authorisation codes contain alphanumeric values. Whilst the code confirms authorisation it   should not be used to determine whether a transaction was successfully processed. For instance an auth code   may be returned when a transaction has been subsequently declined due to a CSC mismatch.  | [optional] 
+**authen_result** | **String** | The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are | Value | Description | |-------|-------------| | Y | Authentication Successful. The Cardholder's password was successfully validated. | | N | Authentication Failed. Customer failed or cancelled authentication, transaction denied. | | A | Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated | | U | Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem |  | [optional] 
+**authorised** | **Boolean** | A boolean definition that indicates that the transaction was authorised. It will return false if the transaction  was declined, rejected or cancelled due to CSC matching failures. Attention should be referenced to the AuthResult and Response code for accurate determination of the result.  | [optional] 
+**avs_result** | **String** | The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline.   | Code | Description |  |------|------------|  | Y | Address and 5 digit post code match |  | M | Street address and Postal codes match for international transaction |  | U | No AVS data available from issuer auth system |  | A | Addres matches, post code does not |  | I | Address information verified for international transaction |  | Z | 5 digit post code matches, Address does not |  | W | 9 digit post code matches, Address does not |  | X | Postcode and address match |  | B | Postal code not verified due to incompatible formats |  | P | Postal codes match. Street address not verified due to to incompatible formats |  | E | AVS Error |  | C | Street address and Postal code not verified due to incompatible formats |  | D | Street address and postal codes match |  |   | No information |  | N | Neither postcode nor address match |  | R | Retry, System unavailble or Timed Out |  | S | AVS Service not supported by issuer or processor |  | G | Issuer does not participate in AVS |  | [optional] 
+**bin_commercial** | **Boolean** | Determines whether the bin range was found to be a commercial or business card. | [optional] 
+**bin_debit** | **Boolean** | Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card. | [optional] 
+**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.   | Code | Description |  |------|------------|  |   | No information |  | M | Card verification data matches |  | N | Card verification data was checked but did not match |  | P | Card verification was not processed |  | S | The card verification data should be on the card but the merchant indicates that it is not |  | U | The card issuer is not certified |  | [optional] 
+**currency** | **String** | The currency the transaction was processed in. This is an `ISO4217` alpha currency value. | [optional] 
+**datetime** | **DateTime** | 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] 
+**identifier** | **String** | The identifier provided within the request. | [optional] 
+**live** | **Boolean** | Used to identify that a tranasction was processed on a live authorisation platform. | [optional] 
+**maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] 
+**merchantid** | **Integer** | The merchant id that processed this transaction. | [optional] 
+**result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value   | Code | Abbrev | Description |  |------|-------|-------------|  | 0 | Declined | Declined |  | 1 | Accepted | Accepted |  | 2 | Rejected | Rejected |  | 3 | Not Attempted | Not Attempted |  | 4 | Referred | Referred |  | 5 | PinRetry | Perform PIN Retry |  | 6 | ForSigVer | Force Signature Verification |  | 7 | Hold | Hold |  | 8 | SecErr | Security Error |  | 9 | CallAcq | Call Acquirer |  | 10 | DNH | Do Not Honour |  | 11 | RtnCrd | Retain Card |  | 12 | ExprdCrd | Expired Card |  | 13 | InvldCrd | Invalid Card No |  | 14 | PinExcd | Pin Tries Exceeded |  | 15 | PinInvld | Pin Invalid |  | 16 | AuthReq | Authentication Required |  | 17 | AuthenFail | Authentication Failed |  | 18 | Verified | Card Verified |  | 19 | Cancelled | Cancelled |  | 20 | Un | Unknown |  | [optional] 
+**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.  | [optional] 
+**result_message** | **String** | The message regarding the result which provides further narrative to the result code.  | [optional] 
+**scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [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.  | Id | Description | |----|-------------| | O | Transaction is open for settlement | | A | Transaction is assigned for settlement and can no longer be voided | | S | Transaction has been settled   | | D | Transaction has been declined | | R | Transaction has been rejected | | P | Transaction has been authorised only and awaiting a capture. Used in pre-auth situations | | C | Transaction has been cancelled | | E | Transaction has expired | | I | Transaction has been initialised but no action was able to be carried out | | H | Transaction is awaiting authorisation | | . | Transaction is on hold | | V | Transaction has been verified |  | [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] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AuthResponse.new(amount: 3600,
+                                 atrn: null,
+                                 atsd: null,
+                                 authcode: 001245A,
+                                 authen_result: null,
+                                 authorised: true,
+                                 avs_result: null,
+                                 bin_commercial: null,
+                                 bin_debit: null,
+                                 bin_description: null,
+                                 cavv: null,
+                                 context: aspiu352908ns47n343598bads,
+                                 csc_result: null,
+                                 currency: GBP,
+                                 datetime: 2020-01-02T18:32:28Z,
+                                 eci: null,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 live: true,
+                                 maskedpan: 4***********0002,
+                                 merchantid: 11223344,
+                                 result: 1,
+                                 result_code: 0,
+                                 result_message: Accepted Transaction,
+                                 scheme: Visa,
+                                 sha256: null,
+                                 trans_status: null,
+                                 transno: 78416)
+```
+
+

data/docs/AuthenRequired.md

@@ -0,0 +1,21 @@
+# CityPayApiClient::AuthenRequired
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acs_url** | **String** | The url of the Access Control Server (ACS) to forward the user to.  | [optional] 
+**md** | **String** | Merchant Data (MD) which should be sent to the ACS to establish and reference the authentication session.  | [optional] 
+**pareq** | **String** | The Payer Authentication Request packet which should be `POSTed` to the Url of the ACS to establish the authentication session. Data should be sent untouched.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::AuthenRequired.new(acs_url: https://acs.cardissuer.com/3dsv1,
+                                 md: null,
+                                 pareq: eNrNWdnOo0qSfpXSmUuf0+w2tFy/lOyYxYDZ79h3sAEbm6cfbFfV+bu6pqe7R2qNJeQkiIwlMyK+...)
+```
+
+

data/docs/CResAuthRequest.md

@@ -0,0 +1,17 @@
+# CityPayApiClient::CResAuthRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cres** | **String** | The challenge response data forwarded by the ACS in 3D-Secure V2 processing. Data should be forwarded to CityPay unchanged for subsequent authorisation and processing.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::CResAuthRequest.new(cres: x90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirbv66ycfSp8jNlvy7PkHbx44NEt3vo...)
+```
+
+

data/docs/CaptureRequest.md

@@ -0,0 +1,27 @@
+# CityPayApiClient::CaptureRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] 
+**amount** | **Integer** | The completion amount provided in the lowest unit of currency for the specific currency of the merchant, with a variable length to a maximum of 12 digits. No decimal points to be included. For example with GBP 75.45 use the value 7545. Please check that you do not supply divisional characters such as 1,024 in the request which may be caused by some number formatters. If no amount is supplied, the original processing amount is used.  | [optional] 
+**identifier** | **String** | The identifier of the transaction to capture. If an empty value is supplied then a `trans_no` value must be supplied. | [optional] 
+**merchantid** | **Integer** | Identifies the merchant account to perform the capture for. | 
+**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
+**transno** | **Integer** | The transaction number of the transaction to look up and capture. If an empty value is supplied then an identifier value must be supplied. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::CaptureRequest.new(airline_data: null,
+                                 amount: 3600,
+                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+                                 merchantid: 11223344,
+                                 sdk: MyClient 1.3.0,
+                                 transno: 78416)
+```
+
+

data/docs/Card.md

@@ -0,0 +1,51 @@
+# CityPayApiClient::Card
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bin_commercial** | **Boolean** | Defines whether the card is a commercial card. | [optional] 
+**bin_corporate** | **Boolean** | Defines whether the card is a corporate business card. | [optional] 
+**bin_country_issued** | **String** | The determined country where the card was issued. | [optional] 
+**bin_credit** | **Boolean** | Defines whether the card is a credit card. | [optional] 
+**bin_currency** | **String** | The default currency determined for the card. | [optional] 
+**bin_debit** | **Boolean** | Defines whether the card is a debit card. | [optional] 
+**bin_description** | **String** | A description of the bin on the card to identify what type of product the card is. | [optional] 
+**bin_eu** | **Boolean** | Defines whether the card is regulated within the EU. | [optional] 
+**card_id** | **String** | The id of the card that is returned. Should be used for referencing the card when perform any changes. | [optional] 
+**card_status** | **String** | The status of the card such, valid values are  - ACTIVE the card is active for processing  - INACTIVE the card is not active for processing  - EXPIRED for cards that have passed their expiry date.  | [optional] 
+**default** | **Boolean** | Determines if the card is the default card for the account and should be regarded as the first option to be used for processing. | [optional] 
+**expmonth** | **Integer** | The expiry month of the card. | [optional] 
+**expyear** | **Integer** | The expiry year of the card. | [optional] 
+**label** | **String** | A label which identifies this card. | [optional] 
+**label2** | **String** | A label which also provides the expiry date of the card. | [optional] 
+**last4digits** | **String** | The last 4 digits of the card to aid in identification. | [optional] 
+**scheme** | **String** | The scheme that issued the card. | [optional] 
+**token** | **String** | A token that can be used to process against the card. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::Card.new(bin_commercial: null,
+                                 bin_corporate: null,
+                                 bin_country_issued: null,
+                                 bin_credit: null,
+                                 bin_currency: null,
+                                 bin_debit: null,
+                                 bin_description: null,
+                                 bin_eu: null,
+                                 card_id: null,
+                                 card_status: null,
+                                 default: null,
+                                 expmonth: 9,
+                                 expyear: 2023,
+                                 label: Visa/0002,
+                                 label2: Visa/0002,Exp:2304,
+                                 last4digits: 2,
+                                 scheme: Visa,
+                                 token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr)
+```
+
+

data/docs/CardHolderAccount.md

@@ -0,0 +1,31 @@
+# CityPayApiClient::CardHolderAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The account id of the card holder account provided by the merchant which uniquely identifies the account.  | 
+**cards** | [**Array<Card>**](Card.md) |  | [optional] 
+**contact** | [**ContactDetails**](ContactDetails.md) |  | 
+**date_created** | **DateTime** | The date and time the account was created. | [optional] 
+**default_card_id** | **String** | The id of the default card. | [optional] 
+**default_card_index** | **String** | The index in the array of the default card. | [optional] 
+**status** | **String** | Defines the status of the account for processing valid values are   - ACTIVE for active accounts that are able to process  - DISABLED for accounts that are currently disabled for processing.  | [optional] 
+**unique_id** | **String** | A unique id of the card holder account which uniquely identifies the stored account. This value is not searchable. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'CityPayApiClient'
+
+instance = CityPayApiClient::CardHolderAccount.new(account_id: aaabbb-cccddd-eee,
+                                 cards: null,
+                                 contact: null,
+                                 date_created: 2020-01-02T18:32:28Z,
+                                 default_card_id: null,
+                                 default_card_index: null,
+                                 status: null,
+                                 unique_id: null)
+```
+
+

data/docs/CardHolderAccountApi.md

@@ -0,0 +1,515 @@
+# CityPayApiClient::CardHolderAccountApi
+
+All URIs are relative to *https://api.citypay.com/v6*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_card_delete_request**](CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /account/{accountid}/card/{cardId} | Card Deletion
+[**account_card_register_request**](CardHolderAccountApi.md#account_card_register_request) | **POST** /account/{accountid}/register | Card Registration
+[**account_card_status_request**](CardHolderAccountApi.md#account_card_status_request) | **POST** /account/{accountid}/card/{cardId}/status | Card Status
+[**account_change_contact_request**](CardHolderAccountApi.md#account_change_contact_request) | **POST** /account/{accountid}/contact | Contact Details Update
+[**account_create**](CardHolderAccountApi.md#account_create) | **POST** /account/create | Account Create
+[**account_delete_request**](CardHolderAccountApi.md#account_delete_request) | **DELETE** /account/{accountid} | Account Deletion
+[**account_retrieve_request**](CardHolderAccountApi.md#account_retrieve_request) | **GET** /account/{accountid} | Account Retrieval
+[**account_status_request**](CardHolderAccountApi.md#account_status_request) | **POST** /account/{accountid}/status | Account Status
+[**charge_request**](CardHolderAccountApi.md#charge_request) | **POST** /charge | Charge
+
+
+
+## account_card_delete_request
+
+> Acknowledgement account_card_delete_request(accountid, card_id)
+
+Card Deletion
+
+Deletes a card from the account. The card will be marked for deletion before a subsequent purge will clear the card permanently. 
+
+### 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::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
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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** | **String**| The id of the card that is presented by a call to retrieve a card holder account. | 
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## account_card_register_request
+
+> CardHolderAccount account_card_register_request(accountid, register_card)
+
+Card Registration
+
+Allows for a card to be registered for the account. The card will be added for future  processing and will be available as a tokenised value for future processing.  The card will be validated for  0. Being a valid card number (luhn check) 0. Having a valid expiry date 0. Being a valid bin value. 
+
+### 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::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.
+register_card = CityPayApiClient::RegisterCard.new # RegisterCard | 
+
+begin
+  #Card Registration
+  result = api_instance.account_card_register_request(accountid, register_card)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_card_register_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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. | 
+ **register_card** | [**RegisterCard**](RegisterCard.md)|  | 
+
+### Return type
+
+[**CardHolderAccount**](CardHolderAccount.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## account_card_status_request
+
+> Acknowledgement account_card_status_request(accountid, card_id, card_status)
+
+Card Status
+
+Updates the status of a card for processing. The following values are available  | Status | Description |  |--------|-------------| | Active | The card is active for processing and can be used for charging against with a valid token | | Inactive | The card is inactive for processing and cannot be used for processing, it will require reactivation before being used to charge | | Expired | The card has expired either due to the expiry date no longer being valid or due to a replacement card being issued | 
+
+### 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::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.
+card_status = CityPayApiClient::CardStatus.new # CardStatus | 
+
+begin
+  #Card Status
+  result = api_instance.account_card_status_request(accountid, card_id, card_status)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_card_status_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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** | **String**| The id of the card that is presented by a call to retrieve a card holder account. | 
+ **card_status** | [**CardStatus**](CardStatus.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
+
+
+## account_change_contact_request
+
+> CardHolderAccount account_change_contact_request(accountid, contact_details)
+
+Contact Details Update
+
+Allows for the ability to change the contact details for an account.
+
+### 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::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.
+contact_details = CityPayApiClient::ContactDetails.new # ContactDetails | 
+
+begin
+  #Contact Details Update
+  result = api_instance.account_change_contact_request(accountid, contact_details)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_change_contact_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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. | 
+ **contact_details** | [**ContactDetails**](ContactDetails.md)|  | 
+
+### Return type
+
+[**CardHolderAccount**](CardHolderAccount.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## account_create
+
+> CardHolderAccount account_create(account_create)
+
+Account Create
+
+Creates a new card holder account and initialises the account ready for adding cards.
+
+### 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::CardHolderAccountApi.new
+account_create = CityPayApiClient::AccountCreate.new # AccountCreate | 
+
+begin
+  #Account Create
+  result = api_instance.account_create(account_create)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_create** | [**AccountCreate**](AccountCreate.md)|  | 
+
+### Return type
+
+[**CardHolderAccount**](CardHolderAccount.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## account_delete_request
+
+> Acknowledgement account_delete_request(accountid)
+
+Account Deletion
+
+Allows for the deletion of an account. The account will marked for deletion and subsequent purging. No further transactions will be alowed to be processed or actioned against this account. 
+
+### 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::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.
+
+begin
+  #Account Deletion
+  result = api_instance.account_delete_request(accountid)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_delete_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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. | 
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## account_retrieve_request
+
+> CardHolderAccount account_retrieve_request(accountid)
+
+Account Retrieval
+
+Allows for the retrieval of a card holder account for the given `id`. Should duplicate accounts exist for the same `id`, the first account created with that `id` will be returned.  The account can be used for tokenisation processing by listing all cards assigned to the account. The returned cards will include all `active`, `inactive` and `expired` cards. This can be used to  enable a card holder to view their wallet and make constructive choices on which card to use. 
+
+### 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::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.
+
+begin
+  #Account Retrieval
+  result = api_instance.account_retrieve_request(accountid)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_retrieve_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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. | 
+
+### Return type
+
+[**CardHolderAccount**](CardHolderAccount.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## account_status_request
+
+> Acknowledgement account_status_request(accountid, account_status)
+
+Account Status
+
+Updates the status of an account. An account can have the following statuses applied  | Status | Description | |--------|-------------| | Active | The account is active for processing | | Disabled | The account has been disabled and cannot be used for processing. The account will require reactivation to continue procesing | 
+
+### 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::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.
+account_status = CityPayApiClient::AccountStatus.new # AccountStatus | 
+
+begin
+  #Account Status
+  result = api_instance.account_status_request(accountid, account_status)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->account_status_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountid** | **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. | 
+ **account_status** | [**AccountStatus**](AccountStatus.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
+
+
+## charge_request
+
+> Decision charge_request(charge_request)
+
+Charge
+
+A charge process obtains an authorisation using a tokenised value which represents a stored card  on a card holder account.  A card must previously be registered by calling `/account-register-card` with the card details  or retrieved using `/account-retrieve`  Tokens are generated whenever a previously registered list of cards are retrieved. Each token has, by design a  relatively short time to live of 30 minutes. This is both to safe guard the merchant and card holder from  replay attacks. Tokens are also restricted to your account, preventing malicious actors from stealing details for use elsewhere.    If a token is reused after it has expired it will be rejected and a new token will be required.   Tokenisation can be used for   - repeat authorisations on a previously stored card - easy authorisations just requiring CSC values to be entered - can be used for credential on file style payments - can require full 3-D Secure authentication to retain the liability shift - wallet style usage. 
+
+### 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::CardHolderAccountApi.new
+charge_request = CityPayApiClient::ChargeRequest.new # ChargeRequest | 
+
+begin
+  #Charge
+  result = api_instance.charge_request(charge_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Exception when calling CardHolderAccountApi->charge_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **charge_request** | [**ChargeRequest**](ChargeRequest.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
+