citypay_api_client 1.1.2 → 1.1.4

data/docs/PaylinkCustomParam.md

@@ -4,17 +4,18 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **entry_mode** | **String** | The type of entry mode. A value of 'pre' will pre-render the custom parameter before the payment screen. Any other value will result in the custom parameter being displayed on the payment screen. | [optional] |
-| **field_type** | **String** | the type of html5 field, defaults to 'text'. Other options are 'dob' for a date of birth series of select list entry. | [optional] |
-| **group** | **String** | a group the parameter is linked with, allows for grouping with a title. | [optional] |
-| **label** | **String** | a label to show alongside the input. | [optional] |
-| **locked** | **Boolean** | whether the parameter is locked from entry. | [optional] |
-| **name** | **String** | the name of the custom parameter used to converse with the submitter. |  |
-| **order** | **Integer** | an index order for the parameter. | [optional] |
-| **pattern** | **String** | a regex pattern to validate the custom parameter with. | [optional] |
-| **placeholder** | **String** | a placehold value to display in the input. | [optional] |
-| **required** | **Boolean** | whether the field is required. | [optional] |
-| **value** | **String** | a default value for the field. | [optional] |
+| **auth_meta_data** | **Boolean** | Determines if the custom parameter is stored as meta data against an authorisation allowing for that authorisation to be searched and queried by the result of this value. Defaults to false. | [optional] |
+| **entry_mode** | **String** | The type of entry mode. A value of `pre` will pre-render the custom parameter before the payment screen. Any other value will result in the custom parameter being displayed on the payment screen. | [optional] |
+| **field_type** | **String** | The type of html field, defaulting to `text`. Options are:   - `dob`      A date of birth field as a series of select list entries  - `text`     Allows the user to enter any text.  - `password` A field where the characters are masked to protect the input, typically used for passwords.  - `email`    Used for input fields that should contain an email address.  - `number`   For numeric input, can include controls for incrementing or decrementing the number.  - `tel`      For telephone numbers.  - `url`      A text field for entering a URL.  - `hidden`   Not visible to the user, but its value is sent when the form is submitted.  - `checkbox` A check box allowing single values to be selected/deselected.  - `radio`    Allows the user to select one of a limited number of choices.  - `select`   Renders as select items  Select Options:  Select options are constructed by providing a list of values in the value custom parameter field. Each value is delimited by a pipe character `|`. Value items can also be delimited with `:` as a value label pair.  For instance, a sports club requires identifying it's age group for membership entry:  <CodeGroup title=\"Select Examples\" label=\"ProcessBatchRequest\">    ```json {{ title: 'Basic Values' }}      { \"label\" : \"Age Group\",        \"fieldType\": \"select\",        \"value\" : \"Under 18|18-30|30-50|50+\" }...       <select>          <option value=\"Under 18\">Under 18</option>          <option value=\"18-30\">18-30</option>          <option value=\"30-50\">30-50</option>          <option value=\"50+\">50+</option>      </select>    ```    ```json {{ title: 'Label and Values' }}      { \"label\" : \"Age Group\",        \"fieldType\": \"select\",        \"value\" : \"0:Under 18|1:18-30|2:30-50|3:50+\" }...       <select>          <option value=\"0\">Under 18</option>          <option value=\"1\">18-30</option>          <option value=\"2\">30-50</option>          <option value=\"3\">50+</option>      </select>    ``` </CodeGroup>  Fields may be requested as optional. If a select is required to be optional, provide a value such as `:Select an Option|options...` at the front of the list.  | [optional] |
+| **group** | **String** | A value which groups items for layout. The value should be a string title for rendering such as \"Your Account Info\". If no value is provided, the parameter is added to a default parameter group. Group names are ordered alphabetically when rendered. | [optional] |
+| **label** | **String** | A label to show alongside the input. If this value is not supplied, the name value will be used. | [optional] |
+| **locked** | **Boolean** | States whether the field is locked, preventing entry or amendment by the person completing the form. | [optional] |
+| **name** | **String** | Refers to the rendered HTML form element name. The value of this field is used in the postback and redirect dataset. |  |
+| **order** | **Integer** | A value which allows you to order the position of elements in a grouping. Values will order in ascending order. Negative values are possible. | [optional] |
+| **pattern** | **String** | A string value which specifies the validation logic of the form element, for example a value of QA[0-9]{3,4} will require a value such as QA221 or QA4433. | [optional] |
+| **placeholder** | **String** | A value to set as the placeholder attribute which will render in the browser. | [optional] |
+| **required** | **Boolean** | A boolean value that states whether the field is required or optional. When an element is required, validation will be performed on the end user's input form. | [optional] |
+| **value** | **String** | An initial value for the parameter as it appears on the Form. If your parameter is hidden, the value will be required. | [optional] |
 
 ## Example
 
@@ -22,17 +23,18 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkCustomParam.new(
+  auth_meta_data: true,
   entry_mode: null,
-  field_type: null,
-  group: null,
-  label: null,
+  field_type: text,
+  group: Extra Information,
+  label: Custom Field 1,
   locked: null,
-  name: null,
-  order: null,
+  name: custom_field_1,
+  order: 1,
   pattern: null,
-  placeholder: null,
-  required: null,
-  value: null
+  placeholder: Enter a Custom Value,
+  required: true,
+  value: initial-value
 )
 ```
 

data/docs/PaylinkErrorCode.md

@@ -13,8 +13,8 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkErrorCode.new(
-  code: null,
-  msg: null
+  code: 1,
+  msg: An example error response
 )
 ```
 

data/docs/PaylinkFieldGuardModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **field_type** | **String** | A type of HTML element that should be displayed such as text, password, url. Any HTML5 input type value may be supplied.  If a value of `date` is supplied the value format should be an ISO format YYYY-MM-DD format date i.e. 2024-03-01 If a value of `datetime-local` is supplied, the value format should be an ISO format YYYY-MM-DDTHH:mm i.e. 2024-06-01T19:30.  | [optional] |
+| **field_type** | **String** | A type of HTML element that should be displayed such as text, password, url. Any HTML5 input type value may be supplied.  - If a value of `date` is supplied the value format should be an ISO format YYYY-MM-DD format date i.e. 2024-03-01 - If a value of `datetime-local` is supplied, the value format should be an ISO format YYYY-MM-DDTHH:mm i.e. 2024-06-01T19:30.  | [optional] |
 | **label** | **String** | A label for the field guard to display on the authentication page. | [optional] |
 | **maxlen** | **Integer** | A maximum length of any value supplied in the field guard form. Used for validating entry. | [optional] |
 | **minlen** | **Integer** | A minimum length of any value supplied in the field guard form. Used for validating entry. | [optional] |

data/docs/PaylinkResendNotificationRequest.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::PaylinkResendNotificationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **Boolean** | Resends the bill payment email provided on the Paylink create token notification path. Emails can be sent up to 5 times per token. | [optional] |
+| **sms** | **Boolean** | Resends the bill payment SMS provided on the Paylink create token notification path. An SMS cannot be resent if it was previously sent less than 1 minute ago. There is a limit of 3 retries per token.  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkResendNotificationRequest.new(
+  email: null,
+  sms: null
+)
+```
+

data/docs/PaylinkStateEvent.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **datetime** | **Time** | the date and time of the event. | [optional] |
 | **message** | **String** | a message associated with the event. | [optional] |
-| **state** | **Time** | The name of the event that was actioned. | [optional] |
+| **state** | **String** | The name of the event that was actioned. | [optional] |
 
 ## Example
 
@@ -14,9 +14,9 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkStateEvent.new(
-  datetime: null,
-  message: null,
-  state: null
+  datetime: 2025-07-30T15:54:29Z,
+  message: message on this state,
+  state: FormInput
 )
 ```
 

data/docs/PaylinkTokenCreated.md

@@ -4,14 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **attachments** | [**PaylinkAttachmentResult**](PaylinkAttachmentResult.md) |  | [optional] |
+| **attachments** | [**Array<PaylinkAttachmentResult>**](PaylinkAttachmentResult.md) |  | [optional] |
 | **bps** | **String** | true if BPS has been enabled on this token. | [optional] |
 | **date_created** | **Time** | Date and time the token was generated. | [optional] |
 | **errors** | [**Array<PaylinkErrorCode>**](PaylinkErrorCode.md) |  | [optional] |
 | **id** | **String** | A unique id of the request. |  |
 | **identifier** | **String** | The identifier as presented in the TokenRequest. | [optional] |
+| **merchantid** | **Integer** | The merchant id of the token. | [optional] |
 | **mode** | **String** | Determines whether the token is `live` or `test`. | [optional] |
-| **qr_code** | **String** | A URL of a qrcode which can be used to refer to the token URL. | [optional] |
+| **qrcode** | **String** | A URL of a qrcode which can be used to refer to the token URL. | [optional] |
 | **result** | **Integer** | The result field contains the result for the Paylink Token Request. 0 - indicates that an error was encountered while creating the token. 1 - which indicates that a Token was successfully created. |  |
 | **server_version** | **String** | the version of the server performing the call. | [optional] |
 | **source** | **String** | The incoming IP address of the call. | [optional] |
@@ -27,17 +28,18 @@ require 'citypay_api_client'
 instance = CityPayApiClient::PaylinkTokenCreated.new(
   attachments: null,
   bps: null,
-  date_created: null,
+  date_created: 2025-07-30T15:54:29Z,
   errors: null,
-  id: null,
-  identifier: null,
-  mode: null,
-  qr_code: null,
-  result: null,
-  server_version: null,
-  source: null,
-  token: null,
-  url: null,
+  id: 00000000-0000-0000-0000-000000000000,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344,
+  mode: test,
+  qrcode: https://payments.citypay.com/AAAAAAA/AAAZZZCCCDDDEEE/qrcode,
+  result: 0,
+  server_version: x.x.x,
+  source: x.x.x.x,
+  token: AAAZZZCCCDDDEEE,
+  url: https://payments.citypay.com/AAAAAAA/AAAZZZCCCDDDEEE,
   usc: null
 )
 ```

data/docs/PaylinkTokenRequestModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **accountno** | **String** | Specifies an alpha-numeric account number that the Paylink service uses when creating a Cardholder Account. The value should be no longer than 20 characters in length. | [optional] |
+| **accountno** | **String** | To be able to use credential on file (COF) services. A cardholder account may be created once the payment has been authorised, this is then stored \"on file\" for subsequent charging for example re-authorisation, unscheduled payment, delayed charges, incremental authorisation, recurring payments, resubmission or no-show style agreements.  Specifies an alpha-numeric account number that the Paylink service uses when creating a Cardholder Account. The value should be no longer than 20 characters in length.  | [optional] |
 | **amount** | **Integer** | Specifies the intended value of the transaction in the lowest denomination with no spacing characters or decimal point. This is the net total to be processed. An example of £74.95 would be presented as 7495. |  |
 | **cardholder** | [**PaylinkCardHolder**](PaylinkCardHolder.md) |  | [optional] |
 | **cart** | [**PaylinkCart**](PaylinkCart.md) |  | [optional] |
@@ -14,6 +14,7 @@
 | **email** | **String** | The email field is used for the Merchant to be notified on completion of the transaction . The value may be supplied to override the default stored value. Emails sent to this address by the Paylink service should not be forwarded on to the cardholder as it may contain certain information that is used by the Paylink service to validate and authenticate Paylink Token Requests: for example, the Merchant ID and the licence key.  | [optional] |
 | **identifier** | **String** | Identifies a particular transaction linked to a Merchant account. It enables accurate duplicate checking within a pre-configured time period, as well as transaction reporting and tracing. The identifier should be unique to prevent payment card processing attempts from being rejected due to duplication.  |  |
 | **merchantid** | **Integer** | The merchant id you wish to process this transaction with. |  |
+| **payment_intent_id** | **String** | A payment intent id already previously registered for this token. | [optional] |
 | **recurring** | **Boolean** | True if the intent of this cardholder initiated transaction is to establish a recurring payment model, processable as merchant initiated transactions. | [optional] |
 | **subscription_id** | **String** | an id associated with a subscription to link the token request against. | [optional] |
 | **tx_type** | **String** | A value to override the transaction type if requested by your account manager. | [optional] |
@@ -34,6 +35,7 @@ instance = CityPayApiClient::PaylinkTokenRequestModel.new(
   email: card.holder@citypay.com,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   merchantid: 11223344,
+  payment_intent_id: p13t1111222233334444,
   recurring: null,
   subscription_id: null,
   tx_type: null

data/docs/PaylinkTokenStatus.md

@@ -27,7 +27,7 @@
 | **is_validated** | **Boolean** | whether the token generation was successfully validated. | [optional] |
 | **last_event_date_time** | **Time** | the date and time that the session last had an event actioned against it. | [optional] |
 | **last_payment_result** | **String** | the result of the last payment if one exists. | [optional] |
-| **mid** | **String** | identifies the merchant account. | [optional] |
+| **mid** | **Integer** | identifies the merchant account. | [optional] |
 | **payment_attempts_count** | **Integer** | the number of attempts made to pay. | [optional] |
 | **state_history** | [**Array<PaylinkStateEvent>**](PaylinkStateEvent.md) |  | [optional] |
 | **token** | **String** | the token value which uniquely identifies the session. | [optional] |
@@ -41,10 +41,10 @@ require 'citypay_api_client'
 instance = CityPayApiClient::PaylinkTokenStatus.new(
   amount_paid: null,
   auth_code: null,
-  card: null,
-  created: null,
-  datetime: null,
-  identifier: null,
+  card: Visa/0002,
+  created: 2025-07-30T15:54:29Z,
+  datetime: 2025-07-30T15:54:29Z,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   is_attachment: null,
   is_cancelled: null,
   is_closed: null,
@@ -60,9 +60,9 @@ instance = CityPayApiClient::PaylinkTokenStatus.new(
   is_request_challenged: null,
   is_sms_sent: null,
   is_validated: null,
-  last_event_date_time: null,
+  last_event_date_time: 2025-07-30T15:54:29Z,
   last_payment_result: null,
-  mid: null,
+  mid: 11223344,
   payment_attempts_count: null,
   state_history: null,
   token: null,

data/docs/PaylinkTokenStatusChangeRequest.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **after** | **Time** | identifies the date and time to lookup changes after. |  |
-| **max_results** | **Integer** | the maximum number of results between 5 and 250 to return. Default is 50. | [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 to review tokens for. |  |
-| **next_token** | **String** | the next token value when more results are available. | [optional] |
-| **order_by** | **Array<String>** |  | [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 [p.id]. By default, fields are ordered by OrderByExpression(p.id,ASC). To order in descending order, prefix with '-' or suffix with ' DESC'. | [optional] |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkTokenStatusChangeRequest.new(
-  after: null,
-  max_results: null,
+  after: 2025-07-30T15:54:29Z,
+  max_results: 50,
   merchantid: 11223344,
-  next_token: null,
-  order_by: null
+  next_token: n34liuwn435tUAGFNg34yn...,
+  order_by: date
 )
 ```
 

data/docs/PaylinkTokenStatusChangeResponse.md

@@ -4,7 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **next_token** | **String** | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.  | [optional] |
+| **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] |
 | **tokens** | [**Array<PaylinkTokenStatus>**](PaylinkTokenStatus.md) |  |  |
 
 ## Example
@@ -13,7 +15,9 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkTokenStatusChangeResponse.new(
-  next_token: null,
+  count: 25,
+  max_results: 50,
+  next_token: n34liuwn435tUAGFNg34yn...,
   tokens: null
 )
 ```

data/docs/PaymentIntent.md

@@ -0,0 +1,42 @@
+# CityPayApiClient::PaymentIntent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195.  |  |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
+| **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [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] |
+| **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.  |  |
+| **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] |
+| **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **Array<String>** |  | [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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntent.new(
+  amount: 19995,
+  avs_postcode_policy: null,
+  bill_to: null,
+  csc: 10,
+  csc_policy: null,
+  currency: GBP,
+  duplicate_policy: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  match_avsa: null,
+  ship_to: null,
+  tag: null,
+  trans_info: null,
+  trans_type: null
+)
+```
+

data/docs/PaymentIntentApi.md

@@ -0,0 +1,154 @@
+# CityPayApiClient::PaymentIntentApi
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_payment_intent**](PaymentIntentApi.md#create_payment_intent) | **POST** /v6/intent/create | Create a Payment Intent |
+| [**get_payment_intent**](PaymentIntentApi.md#get_payment_intent) | **POST** /v6/intent/retrieve | Retrieves a Payment Intent |
+
+
+## create_payment_intent
+
+> <PaymentIntentReference> create_payment_intent(payment_intent_request_model)
+
+Create a Payment Intent
+
+This endpoint initiates the creation of a payment intent, which is a precursor to processing a payment. A payment intent
+captures the details of a prospective payment transaction, including the payment amount, currency, and associated
+billing and shipping information.
+
+
+### 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::PaymentIntentApi.new
+payment_intent_request_model = CityPayApiClient::PaymentIntentRequestModel.new({amount: 19995, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95'}) # PaymentIntentRequestModel | 
+
+begin
+  # Create a Payment Intent
+  result = api_instance.create_payment_intent(payment_intent_request_model)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaymentIntentApi->create_payment_intent: #{e}"
+end
+```
+
+#### Using the create_payment_intent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentIntentReference>, Integer, Hash)> create_payment_intent_with_http_info(payment_intent_request_model)
+
+```ruby
+begin
+  # Create a Payment Intent
+  data, status_code, headers = api_instance.create_payment_intent_with_http_info(payment_intent_request_model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentIntentReference>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaymentIntentApi->create_payment_intent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_intent_request_model** | [**PaymentIntentRequestModel**](PaymentIntentRequestModel.md) |  |  |
+
+### Return type
+
+[**PaymentIntentReference**](PaymentIntentReference.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## get_payment_intent
+
+> <PaymentIntentResponseModel> get_payment_intent(find_payment_intent_request)
+
+Retrieves a Payment Intent
+
+Obtains a payment intent.
+
+### 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::PaymentIntentApi.new
+find_payment_intent_request = CityPayApiClient::FindPaymentIntentRequest.new # FindPaymentIntentRequest | 
+
+begin
+  # Retrieves a Payment Intent
+  result = api_instance.get_payment_intent(find_payment_intent_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaymentIntentApi->get_payment_intent: #{e}"
+end
+```
+
+#### Using the get_payment_intent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentIntentResponseModel>, Integer, Hash)> get_payment_intent_with_http_info(find_payment_intent_request)
+
+```ruby
+begin
+  # Retrieves a Payment Intent
+  data, status_code, headers = api_instance.get_payment_intent_with_http_info(find_payment_intent_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentIntentResponseModel>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaymentIntentApi->get_payment_intent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **find_payment_intent_request** | [**FindPaymentIntentRequest**](FindPaymentIntentRequest.md) |  |  |
+
+### Return type
+
+[**PaymentIntentResponseModel**](PaymentIntentResponseModel.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+

data/docs/PaymentIntentReference.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::PaymentIntentReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_intent_id** | **String** | The intent id used for future referencing of the intent. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntentReference.new(
+  payment_intent_id: p13t1111222233334444
+)
+```
+

data/docs/PaymentIntentRequestModel.md

@@ -0,0 +1,50 @@
+# CityPayApiClient::PaymentIntentRequestModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adjustments** | [**Adjustments**](Adjustments.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] |
+| **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] |
+| **external_ref** | **String** | A unique identifier, such as an order ID or invoice number, provided by your accounting or billing system to link the payment intent with an external system reference. This ensures traceability across systems for audits and transaction validation. | [optional] |
+| **external_ref_source** | **String** | Specifies the originating source or system of the external reference, helping to categorise and trace the context of the external identifier, whether it comes from an internal system, third-party vendor, or external financial platform. | [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.  |  |
+| **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** | The merchant id of the intent, required if using the API key or not required if using a domain key. | [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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntentRequestModel.new(
+  adjustments: null,
+  amount: 19995,
+  avs_postcode_policy: 0,
+  bill_to: null,
+  csc_policy: 0,
+  currency: GBP,
+  duplicate_policy: null,
+  external_ref: ABC123,
+  external_ref_source: xero,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  match_avsa: null,
+  merchantid: 11223344,
+  pre_auth: null,
+  ship_to: null,
+  tag: null,
+  trans_info: info-example-value,
+  trans_type: A
+)
+```
+

data/docs/PaymentIntentResponseModel.md

@@ -0,0 +1,44 @@
+# CityPayApiClient::PaymentIntentResponseModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adjustments** | [**Adjustments**](Adjustments.md) |  | [optional] |
+| **amount** | **Integer** | An amount of the intent. | [optional] |
+| **created** | **Time** | A date time of when the intent was created. | [optional] |
+| **currency** | **String** | The currency of the intent. | [optional] |
+| **due** | **Date** | A due date of the intent. | [optional] |
+| **expires** | **Date** | An expiration date of the intent. | [optional] |
+| **external_ref** | **String** | An external reference of the intent. | [optional] |
+| **external_ref_source** | **String** | An external reference source of the intent. | [optional] |
+| **identifier** | **String** | An identifier of the intent. |  |
+| **intent_status** | **String** | A status of the intent such as `unknown`, `open`, `requires_payment_method`, `requires_confirmation`, `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `cancelled`, `requires_capture`, `failed`, `expired`, `requires_refund`, `refunded`. | [optional] |
+| **merchantid** | **Integer** | The merchant id of the intent. |  |
+| **payment_type** | **String** | A type of the intent such as `None`, `Single`, `Subscription`. | [optional] |
+| **payment_intent_id** | **String** | The id of the intent. |  |
+| **transactions** | [**AuthReference**](AuthReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntentResponseModel.new(
+  adjustments: null,
+  amount: 19995,
+  created: 2025-07-30T15:54:29Z,
+  currency: GBP,
+  due: Wed Jul 30 00:00:00 UTC 2025,
+  expires: Wed Jul 30 00:00:00 UTC 2025,
+  external_ref: ABC123,
+  external_ref_source: xero,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  intent_status: open,
+  merchantid: 11223344,
+  payment_type: null,
+  payment_intent_id: p13t1111222233334444,
+  transactions: null
+)
+```
+

data/docs/ProcessBatchRequest.md

@@ -15,7 +15,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::ProcessBatchRequest.new(
-  batch_date: Thu Jan 02 00:00:00 UTC 2020,
+  batch_date: Thu Jan 02 00:00:00 UTC 2025,
   batch_id: 35,
   client_account_id: AC1,
   transactions: null