citypay_api_client 1.1.2 → 1.1.4

data/docs/TransactionReportRequest.md

@@ -0,0 +1,50 @@
+# CityPayApiClient::TransactionReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields** | **Array<String>** |  | [optional] |
+| **from** | **Time** | The date and time of transactions from. |  |
+| **include_authorised** | **Boolean** | Include transactions fully authorised in the results. | [optional] |
+| **include_cancelled** | **Boolean** | Include transactions that were cancelled in the results. | [optional] |
+| **include_declined** | **Boolean** | Include transactions that were declined or not honoured in the results. | [optional] |
+| **include_rejected** | **Boolean** | Include transactions that were rejected due to validation issues. | [optional] |
+| **include_unfulfilled** | **Boolean** | Includes transactions that were initiated but not completed—e.g. those pending authentication or challenge responses that were never fulfilled. | [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] |
+| **merchantid** | **Integer** | The merchant id of the transactions to review. |  |
+| **mode** | **String** | Defines a preset profile for the level of detail in the returned fields. This simplifies response formatting for common use cases. Available values:  - `basic` (default): Returns a minimal, high-level view with key fields for reporting or dashboards.  - `extended`: Adds fields useful for customer support, settlement analysis, or more in-depth tracking, while still omitting sensitive personal or low-level fields.  - `full`: Returns all available transaction fields, including internal flags, personal data (where applicable), and detailed metadata. Use with care.  | [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 [trans_no,date_when,amount]. By default, fields are ordered by OrderByExpression(trans_no,ASC). To order in descending order, prefix with '-' or suffix with ' DESC'. | [optional] |
+| **pii_masked** | **Boolean** | Defines whether personal identifiable information is masked which it is by default. | [optional] |
+| **type_refund** | **Boolean** | Include refunds in the results. | [optional] |
+| **type_sale** | **Boolean** | Include sales in the results. | [optional] |
+| **type_verify** | **Boolean** | Include verifications in the results. | [optional] |
+| **_until** | **Time** | The date and time of transactions until. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::TransactionReportRequest.new(
+  fields: null,
+  from: 2025-01-02T18:32:28Z,
+  include_authorised: null,
+  include_cancelled: null,
+  include_declined: null,
+  include_rejected: null,
+  include_unfulfilled: null,
+  max_results: 50,
+  merchantid: 11223344,
+  mode: null,
+  next_token: n34liuwn435tUAGFNg34yn...,
+  order_by: date,
+  pii_masked: null,
+  type_refund: null,
+  type_sale: null,
+  type_verify: null,
+  _until: 2025-01-03T18:32:28Z
+)
+```
+

data/docs/VerificationRequest.md

@@ -0,0 +1,76 @@
+# CityPayApiClient::VerificationRequest
+
+## 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] |
+| **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.  - `N` Not Applicable - For all other transactions the value will be not applicable.  | [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.  | [optional] |
+| **cp_card_token** | **String** | The card token previously stored and created by the /tokenise route. | [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] |
+| **event_management** | [**EventDataModel**](EventDataModel.md) |  | [optional] |
+| **expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12.  | [optional] |
+| **expyear** | **Integer** | The year of expiry of the card.  | [optional] |
+| **external_mpi** | [**ExternalMPI**](ExternalMPI.md) |  | [optional] |
+| **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
+| **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] |
+| **mcc6012** | [**MCC6012**](MCC6012.md) |  | [optional] |
+| **merchantid** | **Integer** | Identifies the merchant account to perform processing for. |  |
+| **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] |
+| **payment_intent_id** | **String** | A payment intent id previously registered that this transaction is linked to. | [optional] |
+| **pre_auth** | **String** | A policy value which determines whether a pre auth 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.  Enforces pre-authorisation when it does not pre-auth by default.   `2` to bypass. Bypasses pre-authorisation when it is enabled to pre auth by default.   `3` to ignore. The same as the default policy (0). Although it currently mirrors the default, this option is included for compatibility with other policies.  | [optional] |
+| **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **Array<String>** |  | [optional] |
+| **threeds_token** | **String** | The threedsecure token generated by a call to /areq which may or may not be challenged. | [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] |
+| **uuid** | **String** | A uuid for the session. The value tracks through 3ds session and therefore should be a valid v4 uuid. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::VerificationRequest.new(
+  airline_data: null,
+  amount: 19995,
+  avs_postcode_policy: 0,
+  bill_to: null,
+  cardholder_agreement: null,
+  cardnumber: 4000 0000 0000 0002,
+  cp_card_token: tVQZbn00000000B3qMJB...o8by328,
+  csc: 10,
+  csc_policy: 0,
+  currency: GBP,
+  duplicate_policy: null,
+  event_management: null,
+  expmonth: 9,
+  expyear: 2028,
+  external_mpi: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  initiation: null,
+  match_avsa: null,
+  mcc6012: null,
+  merchantid: 11223344,
+  name_on_card: MR NE BODY,
+  payment_intent_id: p13t1111222233334444,
+  pre_auth: null,
+  ship_to: null,
+  tag: null,
+  threeds_token: tdsp8q9n84yqn34rynq38yn...8u3n4,
+  threedsecure: null,
+  trans_info: info-example-value,
+  trans_type: A,
+  uuid: 123e4567-e89b-12d3-a456-426614174000
+)
+```
+

data/docs/WebHookChannelCreateRequest.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::WebHookChannelCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_name** | **String** | The name of the channel we are creating.  |  |
+| **clientid** | **String** | The client id that the hook is being registered for.  |  |
+| **config** | [**HttpConfig**](HttpConfig.md) |  |  |
+| **endpoint_id** | **String** | The id of the endpoint being used. The channel configuration is dependant upon the endpoint type.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookChannelCreateRequest.new(
+  channel_name: null,
+  clientid: PC12345,
+  config: null,
+  endpoint_id: null
+)
+```
+

data/docs/WebHookChannelCreateResponse.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::WebHookChannelCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Object** | The resultant config object. | [optional] |
+| **endpoint_id** | **String** | The id of the endpoint being used. | [optional] |
+| **web_channel_id** | **String** | The id returned for the generated channel. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookChannelCreateResponse.new(
+  config: null,
+  endpoint_id: null,
+  web_channel_id: wc_4ERJ5kV7nX2hT9m
+)
+```
+

data/docs/WebHookChannelDeleteRequest.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::WebHookChannelDeleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_channel_id** | **String** | The id of the channel to be deleted.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookChannelDeleteRequest.new(
+  web_channel_id: wc_4ERJ5kV7nX2hT9m
+)
+```
+

data/docs/WebHookSubscriptionRequest.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::WebHookSubscriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | **Array<String>** |  | [optional] |
+| **clientid** | **String** | The client id that the hook is being registered for.  |  |
+| **live** | **Boolean** | Specifies if the key is to be used for production. Defaults to false.  | [optional] |
+| **merchant_id** | **Array<Integer>** |  | [optional] |
+| **triggers** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookSubscriptionRequest.new(
+  channels: null,
+  clientid: PC12345,
+  live: true,
+  merchant_id: null,
+  triggers: null
+)
+```
+

data/docs/WebHookSubscriptionResponse.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::WebHookSubscriptionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_hook_id** | **String** | The id returned for the generated web hook subscription. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookSubscriptionResponse.new(
+  web_hook_id: hk_Zf3UbQp8cY6LsRwY1
+)
+```
+

data/docs/WebHookUnsubscribeRequest.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::WebHookUnsubscribeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clientid** | **String** | The client id that the hook is registered for.  |  |
+| **web_hook_id** | **String** | The webhook id that is to be removed.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::WebHookUnsubscribeRequest.new(
+  clientid: PC12345,
+  web_hook_id: hk_Zf3UbQp8cY6LsRwY1
+)
+```
+

data/docs/WebHooks.md

@@ -0,0 +1,313 @@
+# CityPayApiClient::WebHooks
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**web_hook_channel_create_request**](WebHooks.md#web_hook_channel_create_request) | **POST** /hooks/channel/create | Web Hook Channel Create Request |
+| [**web_hook_channel_delete_request**](WebHooks.md#web_hook_channel_delete_request) | **POST** /hooks/channel/delete | Web Hook Channel Delete Request |
+| [**web_hook_subscription_request**](WebHooks.md#web_hook_subscription_request) | **POST** /hooks/subscribe | Web Hook Subscription Request |
+| [**web_hook_unsubscribe_request**](WebHooks.md#web_hook_unsubscribe_request) | **POST** /hooks/unsubscribe | Web Hook Unsubscribe Request |
+
+
+## web_hook_channel_create_request
+
+> <WebHookChannelCreateResponse> web_hook_channel_create_request(web_hook_channel_create_request)
+
+Web Hook Channel Create Request
+
+A WebHookChannel is required to establish a connection with our event notification system. The channel serves as the
+communication link between your application and the events generated by the payment gateway. When you register a
+WebHookChannel, you're defining the endpoint where we will deliver notifications, such as payment events.
+
+The WebHookChannel encapsulates important configuration details like the endpoint type (e.g., HTTP), the client ID,
+and security parameters. However, the channel itself does not specify which events will
+be sent but should be considered as the pipeline for receiving those events. After registering a channel, you can then
+configure triggers separately using a subscription request to define which specific payment events
+should flow through this channel.
+
+
+### Examples
+
+```ruby
+require 'time'
+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::WebHooks.new
+web_hook_channel_create_request = CityPayApiClient::WebHookChannelCreateRequest.new({channel_name: 'channel_name_example', clientid: 'PC12345', config: CityPayApiClient::HttpConfig.new({url: 'https://yoursite.com/path'}), endpoint_id: 'endpoint_id_example'}) # WebHookChannelCreateRequest | 
+
+begin
+  # Web Hook Channel Create Request
+  result = api_instance.web_hook_channel_create_request(web_hook_channel_create_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_channel_create_request: #{e}"
+end
+```
+
+#### Using the web_hook_channel_create_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebHookChannelCreateResponse>, Integer, Hash)> web_hook_channel_create_request_with_http_info(web_hook_channel_create_request)
+
+```ruby
+begin
+  # Web Hook Channel Create Request
+  data, status_code, headers = api_instance.web_hook_channel_create_request_with_http_info(web_hook_channel_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebHookChannelCreateResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_channel_create_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_hook_channel_create_request** | [**WebHookChannelCreateRequest**](WebHookChannelCreateRequest.md) |  |  |
+
+### Return type
+
+[**WebHookChannelCreateResponse**](WebHookChannelCreateResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## web_hook_channel_delete_request
+
+> <Acknowledgement> web_hook_channel_delete_request(web_hook_channel_delete_request)
+
+Web Hook Channel Delete Request
+
+The WebHookChannelDeleteRequest allows you to remove an existing WebHookChannel from the event notification system. 
+By specifying the channel ID, you can deactivate the communication link between your application and the payment 
+gateway’s event system. Deleting a channel effectively halts any further notifications being sent to the associated 
+endpoint, ensuring that no additional events are processed through that channel.
+
+
+### Examples
+
+```ruby
+require 'time'
+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::WebHooks.new
+web_hook_channel_delete_request = CityPayApiClient::WebHookChannelDeleteRequest.new({web_channel_id: 'wc_4ERJ5kV7nX2hT9m'}) # WebHookChannelDeleteRequest | 
+
+begin
+  # Web Hook Channel Delete Request
+  result = api_instance.web_hook_channel_delete_request(web_hook_channel_delete_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_channel_delete_request: #{e}"
+end
+```
+
+#### Using the web_hook_channel_delete_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Acknowledgement>, Integer, Hash)> web_hook_channel_delete_request_with_http_info(web_hook_channel_delete_request)
+
+```ruby
+begin
+  # Web Hook Channel Delete Request
+  data, status_code, headers = api_instance.web_hook_channel_delete_request_with_http_info(web_hook_channel_delete_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Acknowledgement>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_channel_delete_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_hook_channel_delete_request** | [**WebHookChannelDeleteRequest**](WebHookChannelDeleteRequest.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
+
+
+## web_hook_subscription_request
+
+> <WebHookSubscriptionResponse> web_hook_subscription_request(web_hook_subscription_request)
+
+Web Hook Subscription Request
+
+The WebHookSubscriptionRequest is used to define and activate event triggers for an existing WebHookChannel. This 
+request specifies the events or conditions that your application wants to be notified about, ensuring that only 
+relevant event data flows through the channel.
+
+
+### Examples
+
+```ruby
+require 'time'
+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::WebHooks.new
+web_hook_subscription_request = CityPayApiClient::WebHookSubscriptionRequest.new({clientid: 'PC12345'}) # WebHookSubscriptionRequest | 
+
+begin
+  # Web Hook Subscription Request
+  result = api_instance.web_hook_subscription_request(web_hook_subscription_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_subscription_request: #{e}"
+end
+```
+
+#### Using the web_hook_subscription_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebHookSubscriptionResponse>, Integer, Hash)> web_hook_subscription_request_with_http_info(web_hook_subscription_request)
+
+```ruby
+begin
+  # Web Hook Subscription Request
+  data, status_code, headers = api_instance.web_hook_subscription_request_with_http_info(web_hook_subscription_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebHookSubscriptionResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_subscription_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_hook_subscription_request** | [**WebHookSubscriptionRequest**](WebHookSubscriptionRequest.md) |  |  |
+
+### Return type
+
+[**WebHookSubscriptionResponse**](WebHookSubscriptionResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## web_hook_unsubscribe_request
+
+> <Acknowledgement> web_hook_unsubscribe_request(web_hook_unsubscribe_request)
+
+Web Hook Unsubscribe Request
+
+The WebHookUnsubscribeRequest is used to remove an existing webhook subscription from the system. This allows clients 
+to stop receiving event notifications for specific webhook subscriptions that are no longer needed.
+
+
+### Examples
+
+```ruby
+require 'time'
+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::WebHooks.new
+web_hook_unsubscribe_request = CityPayApiClient::WebHookUnsubscribeRequest.new({clientid: 'PC12345', web_hook_id: 'hk_Zf3UbQp8cY6LsRwY1'}) # WebHookUnsubscribeRequest | 
+
+begin
+  # Web Hook Unsubscribe Request
+  result = api_instance.web_hook_unsubscribe_request(web_hook_unsubscribe_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_unsubscribe_request: #{e}"
+end
+```
+
+#### Using the web_hook_unsubscribe_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Acknowledgement>, Integer, Hash)> web_hook_unsubscribe_request_with_http_info(web_hook_unsubscribe_request)
+
+```ruby
+begin
+  # Web Hook Unsubscribe Request
+  data, status_code, headers = api_instance.web_hook_unsubscribe_request_with_http_info(web_hook_unsubscribe_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Acknowledgement>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling WebHooks->web_hook_unsubscribe_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **web_hook_unsubscribe_request** | [**WebHookUnsubscribeRequest**](WebHookUnsubscribeRequest.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
+