citypay_api_client 1.1.1 → 1.1.2

data/docs/PaylinkApi.md

@@ -5,13 +5,13 @@ All URIs are relative to *https://api.citypay.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**token_adjustment_request**](PaylinkApi.md#token_adjustment_request) | **POST** /paylink/{token}/adjustment | Paylink Token Adjustment |
+| [**token_changes_request**](PaylinkApi.md#token_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit |
 | [**token_close_request**](PaylinkApi.md#token_close_request) | **PUT** /paylink/{token}/close | Close Paylink Token |
 | [**token_create_bill_payment_request**](PaylinkApi.md#token_create_bill_payment_request) | **POST** /paylink/bill-payment | Create Bill Payment Paylink Token |
 | [**token_create_request**](PaylinkApi.md#token_create_request) | **POST** /paylink/create | Create Paylink Token |
 | [**token_purge_attachments_request**](PaylinkApi.md#token_purge_attachments_request) | **PUT** /paylink/{token}/purge-attachments | Purges any attachments for a Paylink Token |
 | [**token_reconciled_request**](PaylinkApi.md#token_reconciled_request) | **PUT** /paylink/{token}/reconciled | Reconcile Paylink Token |
 | [**token_reopen_request**](PaylinkApi.md#token_reopen_request) | **PUT** /paylink/{token}/reopen | Reopen Paylink Token |
-| [**token_status_changes_request**](PaylinkApi.md#token_status_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit |
 | [**token_status_request**](PaylinkApi.md#token_status_request) | **GET** /paylink/{token}/status | Paylink Token Status |
 
 
@@ -21,7 +21,11 @@ All URIs are relative to *https://api.citypay.com*
 
 Paylink Token Adjustment
 
-Adjusts a TokenRequest's amount value when for instance   1. a Token is created and the shopping cart is updated 2. an invoice is adjusted either due to part payment or due to increased incurred costs. 
+Adjusts a TokenRequest's amount value when for instance 
+
+1. a Token is created and the shopping cart is updated
+2. an invoice is adjusted either due to part payment or due to increased incurred costs.
+
 
 ### Examples
 
@@ -85,13 +89,83 @@ end
 - **Accept**: application/json, text/xml
 
 
+## token_changes_request
+
+> <PaylinkTokenStatusChangeResponse> token_changes_request(paylink_token_status_change_request)
+
+Paylink Token Audit
+
+Allows for the changes to a pre-existing token.
+
+### Examples
+
+```ruby
+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
+end
+
+api_instance = CityPayApiClient::PaylinkApi.new
+paylink_token_status_change_request = CityPayApiClient::PaylinkTokenStatusChangeRequest.new({after: Time.now, merchantid: 11223344}) # PaylinkTokenStatusChangeRequest | 
+
+begin
+  # Paylink Token Audit
+  result = api_instance.token_changes_request(paylink_token_status_change_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaylinkApi->token_changes_request: #{e}"
+end
+```
+
+#### Using the token_changes_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaylinkTokenStatusChangeResponse>, Integer, Hash)> token_changes_request_with_http_info(paylink_token_status_change_request)
+
+```ruby
+begin
+  # Paylink Token Audit
+  data, status_code, headers = api_instance.token_changes_request_with_http_info(paylink_token_status_change_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaylinkTokenStatusChangeResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling PaylinkApi->token_changes_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **paylink_token_status_change_request** | [**PaylinkTokenStatusChangeRequest**](PaylinkTokenStatusChangeRequest.md) |  |  |
+
+### Return type
+
+[**PaylinkTokenStatusChangeResponse**](PaylinkTokenStatusChangeResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
 ## token_close_request
 
 > <Acknowledgement> token_close_request(token)
 
 Close Paylink Token
 
-Marks a Paylink Token as closed. This closes the Token for any future action and the Token will not appear in any status request calls. 
+Marks a Paylink Token as closed. This closes the Token for any future action and the Token will not appear in any status
+request calls.
+
 
 ### Examples
 
@@ -159,7 +233,177 @@ end
 
 Create Bill Payment Paylink Token
 
-CityPay Paylink supports invoice and bill payment services by allowing merchants to raise an invoice in their systems and associate the invoice with a Paylink checkout token. CityPay will co-ordinate the checkout flow in relationship with your customer. Our bill payment solution may be used to streamline the payment flow with cardholders to allow your invoice to be paid promptly and via multiple payment channels such as Card Payment, Apple Pay or Google Pay.  The bill payment service allows  1. setting up notification paths to an end customer, such as SMS or Email 2. enabling attachments to be included with Paylink tokens 3. produce chaser notifications for unpaid invoices 4. provide callbacks for notification of the payment of an invoice 5. support part payments against an invoice 6. support of field guards to protect the payment screen 7. support of status reporting on tokens 8. URL short codes for SMS notifications  <img src=\"../images/merchant-BPS-workflow.png\" alt=\"Paylink BPSv2 Overview\" width=\"50%\"/>    ### Notification Paths  Notification paths can be provided which identify the channels for communication of the invoice availability. Up to 3 notification paths may be provided per request.  Each notification uses a template to generate the body of the message. This allows for variable text to be sent out and customised for each call.  SMS messages use URL Short Codes (USC) as a payment link to the invoice payment page. This allows for a standard payment URL to be shortened for optimised usage in SMS. For instance a URL of `https://checkout.citypay.com/PL1234/s348yb8yna4a48n2f8nq2f3msgyng-psn348ynaw8ynaw/en` becomes `citypay.com/Za48na3x`. Each USC is unique however it is a requirement that each USC generated is protected with Field Guards to ensure that sensitive data (such as customer contact details and GDPR) is protected.  To send a notification path, append a `notification-path` property to the request.  ```json  {   \"sms_notification_path\": {       \"to\": \"+441534884000\"   },   \"email_notification_path\": {       \"to\": [\"help-desk@citypay.com\"],       \"cc\": [\"third-party@citypay.com\"],       \"reply\": [\"help@my-company.com\"]   } } ```  Notification paths trigger a number of events which are stored as part of the timeline of events of a Paylink token  - `BillPaymentSmsNotificationQueued` - identifies when an SMS notification has been queued for delivery - `BillPaymentSmsNotificationSent` - identifies when an SMS notification has been sent to the upstream network - `BillPaymentSmsNotificationDelivered` - identifies when an SMS notification has been delivered as notified by the upstream network - `BillPaymentSmsNotificationUndelivered` - identifies when an SMS notification has undelivered notification is provided by the upstream network - `BillPaymentSmsNotificationFailure` - identifies when an SMS notification has failed - `BillPaymentEmailNotificationQueued` -  identifies when an email notification has been queued for delivery - `BillPaymentEmailNotificationSent` -  identifies when an email notification has been accepted by our SMS forwarder - `BillPaymentEmailNotificationFailure` - identifies when an email notification has failed delivery   #### SMS Notification Path  SMS originated from a CityPay pool of numbers and by default only sends to country codes where the service is registered. SMSs may contain a From field which is configured as part of you onboarding and have a name associated to identify the service origin. For example if your business is titled `Health Surgery Ltd` the SMS may be sent to originate from `Health Surgery`.   SMS is also configured for a \"polite mode\". This mode ensures that SMSs aren't sent in the middle of the night when backend services ordinarily run. SMSs will be queued until the time range is deemed as polite. Normally this is between 8am and 9pm.  | Field    | Type     | Usage    | Description                                                                                     | |----------|----------|----------|-------------------------------------------------------------------------------------------------| | template | string   | Reserved | An optional template name to use a template other than the default.                             | | to       | string   | Reserved | The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format to send the message to. |  #### Email Notification Paths  | Field    | Type     | Usage    | Description                                                                                     | |----------|----------|----------|-------------------------------------------------------------------------------------------------| | template | string   | Reserved | An optional template name to use a template other than the default.                             | | to       | string[] | Required | An array of email addresses to be used for delivery. A maximum of 5 addresses can be added.     | | cc       | string[] | Required | An array of email addresses to be used for cc delivery. A maximum of 5 addresses can be added.  | | bcc      | string[] | Required | An array of email addresses to be used for bcc delivery. A maximum of 5 addresses can be added. | | reply_to | string[] | Required | An array of email addresses to be used for the Reply-To header of an email.     |   ### Field Guards  To ensure that invoices are paid by the intended recipient, Paylink supports the addition of Field Guards.  A Field Guard is an intended field which is to be used as a form of guarded authentication. More than 1 field can be requested.  <img src=\"../images/paylink-field-guards.png\" alt=\"Paylink Field Guards\" width=\"50%\"/>  To determine the source value of the field, each field name is searched in the order of  - identifier - cardholder data such as name - custom parameters - pass through data  If no field values are found, the token request returns a D041 validation error.  #### Authentication and Validation  When values are entered by the user, resultant comparisons are performed by  1. Transliteration of both the source value and entered value. For example, names with accents (e.g. é will become e) 2. Only Alphanumeric values are retained any whitespace or special characters are ignored 3. Case is ignored  Should all values match, the user is authenticated and can continue to the payment form rendered by the Paylink server.  On successful login, an event will be added to include that the access guard validated access.  #### Access-Key  To ensure that a user does not need to re-enter these values multiple times, a cookie is pushed to the user’s browser with an access-key digest value. This value will be presented to the server on each refresh therefore allowing the guard to accept the call. Each value is uniquely stored per merchant account and cannot be shared cross merchant. The lifetime of the cookie is set to 24 hours.  #### Brute Force Prevention  To prevent multiple calls hitting the server, attempting a brute force attack, the login process  1. is fronted by a contemporary web application firewall 2. creates an event for each token when access was denied 3. should the number of failed events breach more than 5 in 30 minutes, the token is locked for an hour 4. should the number of events breach more than 20 the token is fully locked  ### Attachments  Attachments can be included in the request in 2 ways  1. Via a data element direct in the request 2. Via a URL upload to a provided pre-signed URL  The decision of which option is dependent on the size of the attachments. Should the attachment size be greater than 32kb a URL upload is required. Small attachments can be included in the JSON request. This is to prevent our web firewall from blocking your request and to also ensure efficiency of larger file uploads.  There is a maximum of 3 attachments that can be added to a request.  ```json     [{       \"filename\": \"invoice1.pdf\",       \"mime-type\": \"application/pdf\"     },{       \"filename\": \"invoice2.pdf\",       \"data\": \"b4sE64Enc0dEd...=\",       \"mime-type\": \"application/pdf\"     }] ```  | Field     | Type   | Usage    | Description                                                                                                                                          | |-----------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------| | filename  | string | Required | The name of the attachment normally taken from the filename. You should not include the filename path as appropriate                                 | | data      | string | Optional | base64 encoding of the file if less than 32kb in size                                                                                                | | mime-type | string | Required | The mime type of the attachment as defined in [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110.html). Currently only `application/pdf` is supported |   #### Attachment Result  A result of an attachment specifies whether the attachment was successfully added or whether a further upload is requried  | Field  | Type   | Usage    | Description                                                                                                                                       | |--------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------| | result | string | Required | `OK` should the file have uploaded or `UPLOAD` if the file is required to be uploaded.                                                            | | name   | string | Required | The filename that was specified in the upload process                                                                                             | | url    | string | Optional | Should an upload be required, this URL is available for an upload to be issued. The URL is only available for uploads for 24 hours from creation. | 
+CityPay Paylink supports invoice and bill payment services by allowing merchants to raise an invoice in their systems and
+associate the invoice with a Paylink checkout token. CityPay will co-ordinate the checkout flow in relationship with
+your customer. Our bill payment solution may be used to streamline the payment flow with cardholders to allow your
+invoice to be paid promptly and via multiple payment channels such as Card Payment, Apple Pay or Google Pay.
+
+The bill payment service allows
+
+1. setting up notification paths to an end customer, such as SMS or Email
+2. enabling attachments to be included with Paylink tokens
+3. produce chaser notifications for unpaid invoices
+4. provide callbacks for notification of the payment of an invoice
+5. support part payments against an invoice
+6. support of field guards to protect the payment screen
+7. support of status reporting on tokens
+8. URL short codes for SMS notifications
+
+<img src="images/merchant-BPS-workflow.png" alt="Paylink BPSv2 Overview" width="50%"/> 
+
+
+### Notification Paths
+
+Notification paths can be provided which identify the channels for communication of the invoice availability.
+Up to 3 notification paths may be provided per request.
+
+Each notification uses a template to generate the body of the message. This allows for variable text to be sent out and
+customised for each call.
+
+SMS messages use URL Short Codes (USC) as a payment link to the invoice payment page. This allows for a standard payment
+URL to be shortened for optimised usage in SMS. For instance a URL of `https://checkout.citypay.com/PL1234/s348yb8yna4a48n2f8nq2f3msgyng-psn348ynaw8ynaw/en`
+becomes `citypay.com/Za48na3x`. Each USC is unique however it is a requirement that each USC generated is protected
+with Field Guards to ensure that sensitive data (such as customer contact details and GDPR) is protected.
+
+To send a notification path, append a `notification-path` property to the request.
+
+```json
+ {
+  "sms_notification_path": {
+      "to": "+441534884000"
+  },
+  "email_notification_path": {
+      "to": ["help-desk@citypay.com"],
+      "cc": ["third-party@citypay.com"],
+      "reply": ["help@my-company.com"]
+  }
+}
+```
+
+Notification paths trigger a number of events which are stored as part of the timeline of events of a Paylink token
+
+- `BillPaymentSmsNotificationQueued` - identifies when an SMS notification has been queued for delivery
+- `BillPaymentSmsNotificationSent` - identifies when an SMS notification has been sent to the upstream network
+- `BillPaymentSmsNotificationDelivered` - identifies when an SMS notification has been delivered as notified by the upstream network
+- `BillPaymentSmsNotificationUndelivered` - identifies when an SMS notification has undelivered notification is provided by the upstream network
+- `BillPaymentSmsNotificationFailure` - identifies when an SMS notification has failed
+- `BillPaymentEmailNotificationQueued` -  identifies when an email notification has been queued for delivery
+- `BillPaymentEmailNotificationSent` -  identifies when an email notification has been accepted by our SMS forwarder
+- `BillPaymentEmailNotificationFailure` - identifies when an email notification has failed delivery
+
+
+#### SMS Notification Path
+
+SMS originated from a CityPay pool of numbers and by default only sends to country codes where the service is registered.
+SMSs may contain a From field which is configured as part of you onboarding and have a name associated to identify the service
+origin. For example if your business is titled `Health Surgery Ltd` the SMS may be sent to originate from `Health Surgery`. 
+
+SMS is also configured for a "polite mode". This mode ensures that SMSs aren't sent in the middle of the night when backend
+services ordinarily run. SMSs will be queued until the time range is deemed as polite. Normally this is between 8am and 9pm.
+
+| Field    | Type     | Usage    | Description                                                                                     |
+|----------|----------|----------|-------------------------------------------------------------------------------------------------|
+| template | string   | Reserved | An optional template name to use a template other than the default.                             |
+| to       | string   | Reserved | The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format to send the message to. |
+
+#### Email Notification Paths
+
+| Field    | Type     | Usage    | Description                                                                                     |
+|----------|----------|----------|-------------------------------------------------------------------------------------------------|
+| template | string   | Reserved | An optional template name to use a template other than the default.                             |
+| to       | string[] | Required | An array of email addresses to be used for delivery. A maximum of 5 addresses can be added.     |
+| cc       | string[] | Required | An array of email addresses to be used for cc delivery. A maximum of 5 addresses can be added.  |
+| bcc      | string[] | Required | An array of email addresses to be used for bcc delivery. A maximum of 5 addresses can be added. |
+| reply_to | string[] | Required | An array of email addresses to be used for the Reply-To header of an email.     |
+
+
+### Field Guards
+
+To ensure that invoices are paid by the intended recipient, Paylink supports the addition of Field Guards.
+
+A Field Guard is an intended field which is to be used as a form of guarded authentication. More than 1 field can be
+requested.
+
+<img src="images/paylink-field-guards.png" alt="Paylink Field Guards" width="50%"/>
+
+To determine the source value of the field, each field name is searched in the order of
+
+- identifier
+- cardholder data such as name
+- custom parameters
+- pass through data
+
+If no field values are found, the token request returns a D041 validation error.
+
+#### Authentication and Validation
+
+When values are entered by the user, resultant comparisons are performed by
+
+1. Transliteration of both the source value and entered value. For example, names with accents (e.g. é will become e)
+2. Only Alphanumeric values are retained any whitespace or special characters are ignored
+3. Case is ignored
+
+Should all values match, the user is authenticated and can continue to the payment form rendered by the Paylink server.
+
+On successful login, an event will be added to include that the access guard validated access.
+
+#### Access-Key
+
+To ensure that a user does not need to re-enter these values multiple times, a cookie is pushed to the user’s
+browser with an access-key digest value. This value will be presented to the server on each refresh therefore
+allowing the guard to accept the call. Each value is uniquely stored per merchant account and cannot be shared cross
+merchant. The lifetime of the cookie is set to 24 hours.
+
+#### Brute Force Prevention
+
+To prevent multiple calls hitting the server, attempting a brute force attack, the login process
+
+1. is fronted by a contemporary web application firewall
+2. creates an event for each token when access was denied
+3. should the number of failed events breach more than 5 in 30 minutes, the token is locked for an hour
+4. should the number of events breach more than 20 the token is fully locked
+
+### Attachments
+
+Attachments can be included in the request in 2 ways
+
+1. Via a data element direct in the request
+2. Via a URL upload to a provided pre-signed URL
+
+The decision of which option is dependent on the size of the attachments. Should the attachment size be greater than
+32kb a URL upload is required. Small attachments can be included in the JSON request. This is to prevent our web
+firewall from blocking your request and to also ensure efficiency of larger file uploads.
+
+There is a maximum of 3 attachments that can be added to a request.
+
+```json
+    [{
+      "filename": "invoice1.pdf",
+      "mime-type": "application/pdf"
+    },{
+      "filename": "invoice2.pdf",
+      "data": "b4sE64Enc0dEd...=",
+      "mime-type": "application/pdf"
+    }]
+```
+
+| Field     | Type   | Usage    | Description                                                                                                                                          |
+|-----------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| filename  | string | Required | The name of the attachment normally taken from the filename. You should not include the filename path as appropriate                                 |
+| data      | string | Optional | base64 encoding of the file if less than 32kb in size                                                                                                |
+| mime-type | string | Required | The mime type of the attachment as defined in [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110.html). Currently only `application/pdf` is supported |
+
+
+#### Attachment Result
+
+A result of an attachment specifies whether the attachment was successfully added or whether a further upload is requried
+
+| Field  | Type   | Usage    | Description                                                                                                                                       |
+|--------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
+| result | string | Required | `OK` should the file have uploaded or `UPLOAD` if the file is required to be uploaded.                                                            |
+| name   | string | Required | The filename that was specified in the upload process                                                                                             |
+| url    | string | Optional | Should an upload be required, this URL is available for an upload to be issued. The URL is only available for uploads for 24 hours from creation. |
+
 
 ### Examples
 
@@ -363,7 +607,7 @@ end
 
 Reconcile Paylink Token
 
-Marks a Paylink Token as reconciled when reconcilation is performed on the merchant's side.
+Marks a Paylink Token as reconciled when reconciliation is performed on the merchant's side.
 
 ### Examples
 
@@ -493,74 +737,6 @@ end
 - **Accept**: application/json, text/xml
 
 
-## token_status_changes_request
-
-> <PaylinkTokenStatusChangeResponse> token_status_changes_request(paylink_token_status_change_request)
-
-Paylink Token Audit
-
-Obtains any changes on Paylink Tokens since a given date and time. This allows for a merchant to regularly check on  activity over a collection of Paylink Tokens and to check on any events that may have occurred. If a Token is `Closed`  it is not considered.  Only statuses that have been appended since the given date and time is returned. 
-
-### Examples
-
-```ruby
-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
-end
-
-api_instance = CityPayApiClient::PaylinkApi.new
-paylink_token_status_change_request = CityPayApiClient::PaylinkTokenStatusChangeRequest.new({after: Time.now, merchantid: 11223344}) # PaylinkTokenStatusChangeRequest | 
-
-begin
-  # Paylink Token Audit
-  result = api_instance.token_status_changes_request(paylink_token_status_change_request)
-  p result
-rescue CityPayApiClient::ApiError => e
-  puts "Error when calling PaylinkApi->token_status_changes_request: #{e}"
-end
-```
-
-#### Using the token_status_changes_request_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<PaylinkTokenStatusChangeResponse>, Integer, Hash)> token_status_changes_request_with_http_info(paylink_token_status_change_request)
-
-```ruby
-begin
-  # Paylink Token Audit
-  data, status_code, headers = api_instance.token_status_changes_request_with_http_info(paylink_token_status_change_request)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <PaylinkTokenStatusChangeResponse>
-rescue CityPayApiClient::ApiError => e
-  puts "Error when calling PaylinkApi->token_status_changes_request_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **paylink_token_status_change_request** | [**PaylinkTokenStatusChangeRequest**](PaylinkTokenStatusChangeRequest.md) |  |  |
-
-### Return type
-
-[**PaylinkTokenStatusChangeResponse**](PaylinkTokenStatusChangeResponse.md)
-
-### Authorization
-
-[cp-api-key](../README.md#cp-api-key)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, text/xml
-- **Accept**: application/json, text/xml
-
-
 ## token_status_request
 
 > <PaylinkTokenStatus> token_status_request(token)

data/docs/PaylinkCustomParam.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **field_type** | **String** | the type of html5 field, defaults to 'text'. | [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 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] |
@@ -21,6 +22,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkCustomParam.new(
+  entry_mode: null,
   field_type: null,
   group: null,
   label: null,

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. | [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/PaylinkTokenRequestModel.md

@@ -10,9 +10,11 @@
 | **cart** | [**PaylinkCart**](PaylinkCart.md) |  | [optional] |
 | **client_version** | **String** | The clientVersion field is used to specify the version of your application that has invoked the Paylink payment process. This feature is typically used for tracing issues relating to application deployments, or any Paylink integration module or plugin. | [optional] |
 | **config** | [**PaylinkConfig**](PaylinkConfig.md) |  | [optional] |
+| **currency** | **String** | A currency for the token. This value should be only used on multi-currency accounts and be an appropriate currency which the account is configured for. | [optional] |
 | **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. |  |
+| **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] |
 
@@ -28,9 +30,11 @@ instance = CityPayApiClient::PaylinkTokenRequestModel.new(
   cart: null,
   client_version: null,
   config: null,
+  currency: GBP,
   email: card.holder@citypay.com,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   merchantid: 11223344,
+  recurring: null,
   subscription_id: null,
   tx_type: null
 )

data/docs/RegisterCard.md

@@ -19,7 +19,7 @@ instance = CityPayApiClient::RegisterCard.new(
   cardnumber: 4000 0000 0000 0002,
   default: null,
   expmonth: 9,
-  expyear: 2025,
+  expyear: 2027,
   name_on_card: MR NE BODY
 )
 ```

data/docs/ThreeDSecure.md

@@ -11,7 +11,7 @@
 | **browser_language** | **String** | BrowserLanguage field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **browser_screen_height** | **String** | BrowserScreenHeight field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **browser_screen_width** | **String** | BrowserScreenWidth field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
-| **browser_tz** | **String** | BrowserTZ field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
+| **browser_tz** | **String** | BrowserTZ offset field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **cp_bx** | **String** | Required for 3DSv2.  Browser extension value produced by the citypay.js `bx` function. See [https://sandbox.citypay.com/3dsv2/bx](https://sandbox.citypay.com/3dsv2/bx) for  details.  | [optional] |
 | **downgrade1** | **Boolean** | Where a merchant is configured for 3DSv2, setting this option will attempt to downgrade the transaction to  3DSv1.  | [optional] |
 | **merchant_termurl** | **String** | A controller URL for 3D-Secure processing that any response from an authentication request or challenge request should be sent to.  The controller should forward on the response from the URL back via this API for subsequent processing.  | [optional] |

data/docs/TokenisationResponseModel.md

@@ -11,9 +11,9 @@
 | **eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.  | [optional] |
 | **identifier** | **String** | The identifier provided within the request. | [optional] |
 | **maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] |
-| **scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
 | **sig_id** | **String** | A Base58 encoded SHA-256 digest generated from the token value Base58 decoded and appended with the nonce value UTF-8 decoded. | [optional] |
-| **token** | **String** | The token used for presentment to authorisation later in the procsesing flow. | [optional] |
+| **token** | **String** | The token used for presentment to authorisation later in the processing flow. | [optional] |
 
 ## Example
 

data/docs/images/citypay-logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 520.89 113.5"><defs><style>.cls-1{fill:#003b71;}.cls-2{fill:#d7c724;}</style></defs><title>citypay-logo</title><g id="Layer_2" data-name="Layer 2"><g id="Standard"><path class="cls-1" d="M139,27a45.23,45.23,0,0,1,18.67,4L156.33,44.7a39.52,39.52,0,0,0-15.57-3.22c-10.82,0-19.11,5.56-19.11,16.26,0,10.14,7.85,16.44,18.61,16.44a37.32,37.32,0,0,0,16.32-3.89l1.86,14.09a44.68,44.68,0,0,1-19.23,4.39c-19.54,0-33.44-12.61-33.44-31C105.77,38.51,119.86,27,139,27Z"/><path class="cls-2" d="M168.15,9.15a9.12,9.12,0,1,1,18.24,0,9.12,9.12,0,0,1-18.24,0Z"/><rect class="cls-1" x="169.33" y="28.19" width="15.89" height="59.35"/><path class="cls-1" d="M220.58,41.36V65.78c0,6.18,3.46,8.9,8.78,8.9a40.29,40.29,0,0,0,10.07-1.42l1.49,13.16a44.2,44.2,0,0,1-14.35,2.35c-13,0-21.82-6.74-21.82-20.71V41.36h-10V28.19h10.07v-19h15.4v19h17.18V41.36Z"/><path class="cls-1" d="M292.17,28.19h17.62l-28,67.45C277,107,269.73,113.5,257,113.5a25.67,25.67,0,0,1-11.32-2.6l2-12.73a20,20,0,0,0,7.48,1.55c6.62,0,11.32-4.64,13.17-12.12L243.77,28.19h17.55L276.84,71.4Z"/><path class="cls-1" d="M378,58.11c0,17.93-11.93,30.66-28.74,30.66-8.72,0-15.33-3-19.29-7.48v31H314.13V28.19H329.4l.31,7.17c3.9-4.94,10-8.41,19.54-8.41C366.06,27,378,40.06,378,58.11ZM346,74.55c9.4,0,16.08-7.1,16.08-16.5,0-9.58-6.62-16.88-16.08-16.88S329.9,48.59,329.9,58.05,336.7,74.55,346,74.55Z"/><path class="cls-1" d="M384.35,57.74c0-18,12.3-30.79,28.62-30.79,9.21,0,15.45,3.53,19.35,8.41l.31-7.17h15.51V87.54H432.63l-.31-7.17c-3.9,4.94-10.14,8.4-19.35,8.4C396.65,88.77,384.35,75.73,384.35,57.74Zm31.71-16.63c-9.52,0-15.95,7.17-15.95,16.63s6.43,16.94,15.95,16.94,16.2-7.42,16.2-16.94S425.52,41.11,416.06,41.11Z"/><path class="cls-1" d="M503.27,28.19h17.62l-28,67.45c-4.76,11.37-12.05,17.86-24.79,17.86a25.62,25.62,0,0,1-11.31-2.6l2-12.73a20,20,0,0,0,7.48,1.55c6.61,0,11.31-4.64,13.17-12.12L454.86,28.19h17.56L487.94,71.4Z"/><path class="cls-2" d="M51.29,80l1.32-.26a30.92,30.92,0,0,0,0-60.65l-1.32-.27v-16l1.87.27A46.84,46.84,0,0,1,93.53,49.4a46.37,46.37,0,0,1-8.21,26.41A47.05,47.05,0,0,1,64.79,92.52L54.33,108.71l-3,4.79Z"/><path class="cls-1" d="M40.28,95.68C17.31,92.3,0,72.41,0,49.4A47.13,47.13,0,0,1,40.16,3.13l2.28-.25v16l-1.63.25a30.87,30.87,0,0,0-.07,60.57l1.7.24v16Z"/><path class="cls-1" d="M46.55,69.05C35.24,69.05,26,60.27,26,49.47S35.24,29.9,46.55,29.9s20.52,8.78,20.52,19.57S57.87,69.05,46.55,69.05Z"/></g></g></svg>