citypay_api_client 1.1.1 → 1.1.3

data/docs/CardHolderAccountApi.md

@@ -18,11 +18,13 @@ All URIs are relative to *https://api.citypay.com*
 
 ## account_card_delete_request
 
-> <Acknowledgement> account_card_delete_request(accountid, card_id)
+> <Acknowledgement> account_card_delete_request(accountid, card_id, opts)
 
 Card Deletion
 
-Deletes a card from the account. The card will be marked for deletion before a subsequent purge will clear the card permanently. 
+Deletes a card from the account. The card will be marked for deletion before a subsequent
+purge will clear the card permanently.
+
 
 ### Examples
 
@@ -37,10 +39,13 @@ 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.
+opts = {
+  force: true # Boolean | Requests that the item is forced immediately.
+}
 
 begin
   # Card Deletion
-  result = api_instance.account_card_delete_request(accountid, card_id)
+  result = api_instance.account_card_delete_request(accountid, card_id, opts)
   p result
 rescue CityPayApiClient::ApiError => e
   puts "Error when calling CardHolderAccountApi->account_card_delete_request: #{e}"
@@ -51,12 +56,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Acknowledgement>, Integer, Hash)> account_card_delete_request_with_http_info(accountid, card_id)
+> <Array(<Acknowledgement>, Integer, Hash)> account_card_delete_request_with_http_info(accountid, card_id, opts)
 
 ```ruby
 begin
   # Card Deletion
-  data, status_code, headers = api_instance.account_card_delete_request_with_http_info(accountid, card_id)
+  data, status_code, headers = api_instance.account_card_delete_request_with_http_info(accountid, card_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Acknowledgement>
@@ -71,6 +76,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **accountid** | **String** | The account id that refers to the customer&#39;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. |  |
+| **force** | **Boolean** | Requests that the item is forced immediately. | [optional] |
 
 ### Return type
 
@@ -92,7 +98,15 @@ end
 
 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. 
+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.
+
 
 ### Examples
 
@@ -106,7 +120,7 @@ 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({cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025}) # RegisterCard | 
+register_card = CityPayApiClient::RegisterCard.new({cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027}) # RegisterCard | 
 
 begin
   # Card Registration
@@ -162,7 +176,14 @@ end
 
 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 | 
+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 |
+
 
 ### Examples
 
@@ -372,7 +393,9 @@ end
 
 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. 
+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.
+
 
 ### Examples
 
@@ -440,7 +463,8 @@ end
 
 Account Exists
 
-Checks that an account exists and is active by providing the account id as a url parameter. 
+Checks that an account exists and is active by providing the account id as a url parameter.
+
 
 ### Examples
 
@@ -508,7 +532,13 @@ end
 
 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. 
+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.
+
 
 ### Examples
 
@@ -576,7 +606,13 @@ end
 
 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 | 
+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 |
+
 
 ### Examples
 
@@ -646,7 +682,30 @@ end
 
 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    _Should an account be used with 3DSv2, the card holder name should also be stored alongside the card as this is a required field with both Visa and MasterCard for risk analysis._. 
+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
+ 
+
+_Should an account be used with 3DSv2, the card holder name should also be stored alongside the card as this is a
+required field with both Visa and MasterCard for risk analysis._.
+
 
 ### Examples
 
@@ -659,7 +718,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
-charge_request = CityPayApiClient::ChargeRequest.new({amount: 3600, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, token: 'ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr'}) # ChargeRequest | 
+charge_request = CityPayApiClient::ChargeRequest.new({amount: 19995, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, token: 'ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr'}) # ChargeRequest | 
 
 begin
   # Charge

data/docs/ChargeRequest.md

@@ -5,16 +5,17 @@
 | 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] |
+| **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] |
 | **cardholder_agreement** | **String** | Merchant-initiated transactions (MITs) are payments you trigger, where the cardholder has previously consented to you carrying out such payments. These may be scheduled (such as recurring payments and installments) or unscheduled (like account top-ups triggered by balance thresholds and no-show charges).  Scheduled --- These are regular payments using stored card details, like installments or a monthly subscription fee.  - `I` Instalment - A single purchase of goods or services billed to a cardholder in multiple transactions, over a period of time agreed by the cardholder and you.  - `R` Recurring - Transactions processed at fixed, regular intervals not to exceed one year between transactions, representing an agreement between a cardholder and you to purchase goods or services provided over a period of time.  Unscheduled --- These are payments using stored card details that do not occur on a regular schedule, like top-ups for a digital wallet triggered by the balance falling below a certain threshold.  - `A` Reauthorisation - a purchase made after the original purchase. A common scenario is delayed/split shipments.  - `C` Unscheduled Payment - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. This includes account top-ups triggered by balance thresholds.  - `D` Delayed Charge - A delayed charge is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental account charge after original services are rendered.  - `L` Incremental - An incremental authorisation is typically found in hotel and car rental environments, where the cardholder has agreed to pay for any service incurred during the duration of the contract. An incremental authorisation is where you need to seek authorisation of further funds in addition to what you have originally requested. A common scenario is additional services charged to the contract, such as extending a stay in a hotel.  - `S` Resubmission - When the original purchase occurred, but you were not able to get authorisation at the time the goods or services were provided. It should be only used where the goods or services have already been provided, but the authorisation request is declined for insufficient funds.  - `X` No-show - A no-show is a transaction where you are enabled to charge for services which the cardholder entered into an agreement to purchase, but the cardholder did not meet the terms of the agreement.  | [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] |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
 | **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
-| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
 | **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
 | **initiation** | **String** | Transactions charged using the API are defined as:  **Cardholder Initiated**: A _cardholder initiated transaction_ (CIT) is where the cardholder selects the card for use for a purchase using previously stored details. An example would be a customer buying an item from your website after being present with their saved card details at checkout.  **Merchant Intiated**: A _merchant initiated transaction_ (MIT) is an authorisation initiated where you as the  merchant submit a cardholders previously stored details without the cardholder's participation. An example would  be a subscription to a membership scheme to debit their card monthly.  MITs have different reasons such as reauthorisation, delayed, unscheduled, incremental, recurring, instalment, no-show or resubmission.  The following values apply   - `M` - specifies that the transaction is initiated by the merchant   - `C` - specifies that the transaction is initiated by the cardholder  Where transactions are merchant initiated, a valid cardholder agreement must be defined.  | [optional] |
-| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **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. |  |
+| **tag** | **Array<String>** |  | [optional] |
 | **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [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] |
@@ -26,7 +27,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::ChargeRequest.new(
-  amount: 3600,
+  amount: 19995,
   avs_postcode_policy: null,
   cardholder_agreement: null,
   csc: 10,
@@ -37,6 +38,7 @@ instance = CityPayApiClient::ChargeRequest.new(
   initiation: null,
   match_avsa: null,
   merchantid: 11223344,
+  tag: null,
   threedsecure: null,
   token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr,
   trans_info: null,

data/docs/ContactDetails.md

@@ -4,19 +4,19 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **address1** | **String** | The first line of the address for the shipping contact. | [optional] |
-| **address2** | **String** | The second line of the address for the shipping contact. | [optional] |
-| **address3** | **String** | The third line of the address for the shipping contact. | [optional] |
-| **area** | **String** | The area such as city, department, parish for the shipping contact. | [optional] |
-| **company** | **String** | The company name for the shipping contact if the contact is a corporate contact. | [optional] |
+| **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 shipping contact which may be used for correspondence. | [optional] |
-| **firstname** | **String** | The first name  of the shipping contact. | [optional] |
-| **lastname** | **String** | The last name or surname of the shipping contact. | [optional] |
-| **mobile_no** | **String** | A mobile number for the shipping contact the mobile number is often required by delivery companies to ensure they are able to be in contact when required. | [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 shipping contact. | [optional] |
-| **title** | **String** | A title for the shipping contact such as Mr, Mrs, Ms, M. Mme. etc. | [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] |
 
 ## Example
 

data/docs/Decision.md

@@ -4,7 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **authen_required** | [**AuthenRequired**](AuthenRequired.md) |  | [optional] |
 | **auth_response** | [**AuthResponse**](AuthResponse.md) |  | [optional] |
 | **request_challenged** | [**RequestChallenged**](RequestChallenged.md) |  | [optional] |
 
@@ -14,7 +13,6 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::Decision.new(
-  authen_required: null,
   auth_response: null,
   request_challenged: null
 )

data/docs/DirectPostApi.md

@@ -17,7 +17,10 @@ All URIs are relative to *https://api.citypay.com*
 
 Handles a CRes response from ACS, returning back the result of authorisation
 
-Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData`
+value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to
+perform a `Direct Post` integration who wish to handle the challenge flow themselves.
+
 
 ### Examples
 
@@ -87,7 +90,10 @@ No authorization required
 
 Handles a CRes response from ACS, returning back a token for future authorisation
 
-Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData`
+value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to
+perform a `Direct Post` integration who wish to handle the challenge flow themselves.
+
 
 ### Examples
 
@@ -157,7 +163,8 @@ No authorization required
 
 Direct Post Auth Request
 
-Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/direct/auth?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+Used to initiate a direct post request transaction flow.
+
 
 ### Examples
 
@@ -166,14 +173,14 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
-direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 19995, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
 
 begin
   # Direct Post Auth Request
@@ -214,7 +221,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 
@@ -228,7 +235,8 @@ end
 
 Direct Post Tokenise Request
 
-Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/v6/direct?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+Used to initiate a direct post request transaction flow.
+
 
 ### Examples
 
@@ -237,14 +245,14 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
-direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 19995, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
 
 begin
   # Direct Post Tokenise Request
@@ -285,7 +293,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 
@@ -299,7 +307,9 @@ end
 
 Direct Post Token Request
 
-Perform a request for authorisation for a previously generated token. This flow will return an authorisation response stating that the transaction was approved or declined. 
+Perform a request for authorisation for a previously generated token. This flow will return an authorisation
+response stating that the transaction was approved or declined.
+
 
 ### Examples
 
@@ -308,10 +318,10 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
@@ -356,7 +366,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 

data/docs/DirectPostRequest.md

@@ -5,23 +5,24 @@
 | 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] |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
 | **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
 | **cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.  |  |
-| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
-| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
 | **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
-| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
 | **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.  |  |
 | **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
 | **mac** | **String** | A message authentication code ensures the data is authentic and that the intended amount has not been tampered with. The mac value is generated using a hash-based mac value. The following algorithm is used. - A key (k) is derived from your licence key - A value (v) is produced by concatenating the nonce, amount value and identifier, such as a purchase   with nonce `0123456789ABCDEF` an amount of £275.95 and an identifier of OD-12345678 would become   `0123456789ABCDEF27595OD-12345678` and extracting the UTF-8 byte values - The result from HMAC_SHA256(k, v) is hex-encoded (upper-case) - For instance, a licence key of `LK123456789`, a nonce of `0123456789ABCDEF`, an amount of `27595` and an identifier of `OD-12345678`  would generate a MAC of `163DBAB194D743866A9BCC7FC9C8A88FCD99C6BBBF08D619291212D1B91EE12E`.  |  |
-| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
 | **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] |
 | **nonce** | **String** | A random value Hex string (uppercase) which is provided to the API to perform a digest. The value will be used in any digest function.  | [optional] |
 | **redirect_failure** | **String** | The URL used to redirect back to your site when a transaction has been rejected or declined. Required if a url-encoded request.  | [optional] |
 | **redirect_success** | **String** | The URL used to redirect back to your site when a transaction has been tokenised or authorised. Required if a url-encoded request.  | [optional] |
 | **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **Array<String>** |  | [optional] |
 | **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] |
 | **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
 | **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
@@ -32,7 +33,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::DirectPostRequest.new(
-  amount: 3600,
+  amount: 19995,
   avs_postcode_policy: null,
   bill_to: null,
   cardnumber: 4000 0000 0000 0002,
@@ -41,7 +42,7 @@ instance = CityPayApiClient::DirectPostRequest.new(
   currency: GBP,
   duplicate_policy: null,
   expmonth: 9,
-  expyear: 2025,
+  expyear: 2027,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   mac: 3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D,
   match_avsa: null,
@@ -50,6 +51,7 @@ instance = CityPayApiClient::DirectPostRequest.new(
   redirect_failure: https://pay.mystore.com/continue_failure,
   redirect_success: https://pay.mystore.com/continue_success,
   ship_to: null,
+  tag: null,
   threedsecure: null,
   trans_info: null,
   trans_type: null

data/docs/EventDataModel.md

@@ -16,10 +16,10 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::EventDataModel.new(
-  event_end_date: null,
+  event_end_date: Mon Apr 22 00:00:00 UTC 2024,
   event_id: null,
   event_organiser_id: null,
-  event_start_date: null,
+  event_start_date: Mon Apr 22 00:00:00 UTC 2024,
   payment_type: null
 )
 ```

data/docs/MerchantBatchReportRequest.md

@@ -0,0 +1,28 @@
+# CityPayApiClient::MerchantBatchReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_from** | **Date** | Start date (YYYY-MM-DD) for batch retrieval range, inclusive. Maximum value is 3 years ago. | [optional] |
+| **date_until** | **Date** | End date (YYYY-MM-DD) for batch retrieval range, inclusive. | [optional] |
+| **max_results** | **Integer** | The maximum number of results to return in a single response. This value is used to limit the size of data returned by the API, enhancing performance and manageability. Values should be between 5 and 250. | [optional] |
+| **merchant_id** | **Array<Integer>** |  | [optional] |
+| **next_token** | **String** | A token that identifies the starting point of the page of results to be returned. An empty value indicates the start of the dataset. When supplied, it is validated and used to fetch the subsequent page of results. This token is typically obtained from the response of a previous pagination request. | [optional] |
+| **order_by** | **String** | Specifies the field by which results are ordered. Available fields are [merchant_id,batch_no,net_amount]. By default, fields are ordered by OrderByExpression(merchant_id,ASC),OrderByExpression(batch_no,ASC). To order in descending order, prefix with '-' or suffix with ' DESC'. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::MerchantBatchReportRequest.new(
+  date_from: Wed Jan 24 00:00:00 UTC 2024,
+  date_until: Wed Jan 31 00:00:00 UTC 2024,
+  max_results: 50,
+  merchant_id: null,
+  next_token: n34liuwn435tUAGFNg34yn...,
+  order_by: date
+)
+```
+

data/docs/MerchantBatchReportResponse.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::MerchantBatchReportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batches** | [**Array<MerchantBatchResponse>**](MerchantBatchResponse.md) |  |  |
+| **count** | **Integer** | The count of items returned in this page. | [optional] |
+| **max_results** | **Integer** | The max results requested in this page. | [optional] |
+| **next_token** | **String** | A token that identifies the starting point of the page of results to be returned. An empty value indicates the start of the dataset. When supplied, it is validated and used to fetch the subsequent page of results. This token is typically obtained from the response of a previous pagination request. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::MerchantBatchReportResponse.new(
+  batches: null,
+  count: 25,
+  max_results: 50,
+  next_token: n34liuwn435tUAGFNg34yn...
+)
+```
+

data/docs/MerchantBatchResponse.md

@@ -0,0 +1,30 @@
+# CityPayApiClient::MerchantBatchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_closed** | **Time** | The date and time when the batch was closed. This is represented in ISO 8601 format (e.g., YYYY-MM-DDTHH:MM:SSZ) and indicates when the batch processing was completed. | [optional] |
+| **batch_no** | **String** | The incremental identifier of the batch. This number is used to track and reference the batch in subsequent operations or inquiries. | [optional] |
+| **batch_status** | **String** | A descriptive string detailing the current status of the batch. This status provides a human-readable explanation of the batch's processing state. | [optional] |
+| **batch_status_code** | **String** | A batch status code that represents the processing state of the batch. Batches will be one of  - 'O' defining the batch is open for settlement and not yet settled  - 'X' defines that the batch is external to our systems and managed elsewhere  - 'C' defines that the batch is cancelled and not settled  - 'S' defines that the batch has been settled and remitted.  | [optional] |
+| **currency** | **String** | The currency of the batch. | [optional] |
+| **merchantid** | **Integer** | The Merchant ID (MID) associated with the batch. This identifier specifies which merchant account the batch was processed for, linking transactions to the merchant. | [optional] |
+| **net_summary** | [**NetSummaryResponse**](NetSummaryResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::MerchantBatchResponse.new(
+  batch_closed: 2024-04-22T13:29:14Z,
+  batch_no: null,
+  batch_status: null,
+  batch_status_code: null,
+  currency: GBP,
+  merchantid: 11223344,
+  net_summary: null
+)
+```
+

data/docs/NetSummaryResponse.md

@@ -0,0 +1,32 @@
+# CityPayApiClient::NetSummaryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_items_amount** | **String** | The total value of refund (credit) transaction items. Represents the sum of funds returned to customers. | [optional] |
+| **credit_items_count** | **Integer** | The count of refund (credit) transaction items. Reflects the number of refund transactions processed. | [optional] |
+| **credit_items_value** | **Integer** | The total value of refund (credit) transaction items. Represents the sum of funds returned to customers. | [optional] |
+| **debit_items_amount** | **String** | The total value of charge (debit) transaction items. Represents the sum of funds received from charges. | [optional] |
+| **debit_items_count** | **Integer** | The count of charge (debit) transaction items. Indicates the number of charge transactions processed. | [optional] |
+| **debit_items_value** | **Integer** | The total value of charge (debit) transaction items. Represents the sum of funds received from charges. | [optional] |
+| **net_amount** | **Integer** | The absolute net value, reflecting the net gain or loss from transactions. | [optional] |
+| **total_count** | **Integer** | The total count of all transaction items. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::NetSummaryResponse.new(
+  credit_items_amount: £75.89,
+  credit_items_count: 12345,
+  credit_items_value: 11874500,
+  debit_items_amount: £75.89,
+  debit_items_count: 12345,
+  debit_items_value: 11874500,
+  net_amount: 11874500,
+  total_count: 12345
+)
+```
+