citypay_api_client 1.0.3 → 1.1.2

data/docs/PaylinkAttachmentRequest.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::PaylinkAttachmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | base64 encoding of the file if less than 32kb in size. | [optional] |
+| **filename** | **String** | The name of the attachment normally taken from the filename. You should not include the filename path as appropriate. |  |
+| **mime_type** | **String** | 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. |  |
+| **name** | **String** | A name for the file to identify it to the card holder when it is displayed in the payment form. For example Invoice, Statement. | [optional] |
+| **retention** | **Integer** | The retention period in days of the attachment. Defaults to 180 days. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkAttachmentRequest.new(
+  data: null,
+  filename: null,
+  mime_type: null,
+  name: null,
+  retention: null
+)
+```
+

data/docs/PaylinkAttachmentResult.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::PaylinkAttachmentResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the attachment. |  |
+| **result** | **String** | The result of an uploaded attachment such as `OK` or `UPLOAD`. |  |
+| **url** | **String** | If the attachment is to be uploaded, a URL that can be used for Multipart upload of the attachment. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkAttachmentResult.new(
+  name: null,
+  result: null,
+  url: null
+)
+```
+

data/docs/PaylinkBillPaymentTokenRequest.md

@@ -0,0 +1,32 @@
+# CityPayApiClient::PaylinkBillPaymentTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addressee** | **String** | Who the bill payment request intended for. This should be a readable name such as a person or company. | [optional] |
+| **attachments** | [**Array<PaylinkAttachmentRequest>**](PaylinkAttachmentRequest.md) |  | [optional] |
+| **descriptor** | **String** | A descriptor for the bill payment used to describe what the payment request is for for instance \"Invoice\".  The descriptor can be used as descriptive text on emails or the payment page. For instance an invoice may have a button saying \"View Invoice\" or an email may say \"to pay your Invoice online\".  | [optional] |
+| **due** | **Date** | A date that the invoice is due. This can be displayed on the payment page. | [optional] |
+| **email_notification_path** | [**PaylinkEmailNotificationPath**](PaylinkEmailNotificationPath.md) |  | [optional] |
+| **memo** | **String** | A memo that can be added to the payment page and email to provide to the customer. | [optional] |
+| **request** | [**PaylinkTokenRequestModel**](PaylinkTokenRequestModel.md) |  |  |
+| **sms_notification_path** | [**PaylinkSMSNotificationPath**](PaylinkSMSNotificationPath.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkBillPaymentTokenRequest.new(
+  addressee: null,
+  attachments: null,
+  descriptor: null,
+  due: null,
+  email_notification_path: null,
+  memo: null,
+  request: null,
+  sms_notification_path: null
+)
+```
+

data/docs/PaylinkCardHolder.md

@@ -0,0 +1,36 @@
+# CityPayApiClient::PaylinkCardHolder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_headers** | **String** | The accept headers string generated by the Customer Browser. This field may be used to lock the payment process to the customer's browser. If the customer were to attempt to use a different browser an error will be generated. | [optional] |
+| **address** | [**PaylinkAddress**](PaylinkAddress.md) |  | [optional] |
+| **company** | **String** | The company name for the card holder. | [optional] |
+| **email** | **String** | The cardholder's email address. This field can be used to send a receipt to the payment cardholder. If this value is not supplied, no email will be sent. | [optional] |
+| **firstname** | **String** | The first name of the card holder. | [optional] |
+| **lastname** | **String** | The last name or surname of the card holder. | [optional] |
+| **mobile_no** | **String** | The mobile number of the cardholder. This can be used for data collection via the Paylink Payment Form or to send an SMS on completion of a transaction. This feature is a licensable option and is not configured by default. | [optional] |
+| **remote_addr** | **String** | Specifies the remote IP address of the customer's browser. This field may be used to lock the payment form to the customer's IP address. Should the address change or a malicious third party attempted to hijack the transaction, an error will be generated. | [optional] |
+| **title** | **String** | A title for the card holder such as Mr, Mrs, Ms, M. Mme. etc. | [optional] |
+| **user_agent** | **String** | Specifies the user agent string of the Customer Browser. This field may be used to lock the payment form to the browser. Should a different user agent attempt to process the transaction or a malicious third party attempted to hijack the transaction, an error is generated. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkCardHolder.new(
+  accept_headers: null,
+  address: null,
+  company: Acme Ltd,
+  email: card.holder@citypay.com,
+  firstname: John,
+  lastname: Smith,
+  mobile_no: 447790123456,
+  remote_addr: null,
+  title: Mr,
+  user_agent: null
+)
+```
+

data/docs/PaylinkCart.md

@@ -0,0 +1,30 @@
+# CityPayApiClient::PaylinkCart
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contents** | [**Array<PaylinkCartItemModel>**](PaylinkCartItemModel.md) |  | [optional] |
+| **coupon** | **String** | A coupon redeemed with the transaction. | [optional] |
+| **mode** | **Integer** | The mode field specifies the behaviour or functionality of the cart.  Valid values are:   0 - No cart - No cart is shown  1 - Read-only - The cart is shown with a breakdown of the item details provided by objects in the contents array.  2 - Selection cart - The cart is shown as a drop-down box of available cart items that the customer can a single item select from.  3 - Dynamic cart - a text box is rendered to enable the operator to input an amount.  4 - Multi cart - The cart is displayed with items rendered with selectable quantities.  | [optional] |
+| **product_description** | **String** | Specifies a description about the product or service that is the subject of the transaction. It will be rendered in the header of the page with no labels. | [optional] |
+| **product_information** | **String** | Specifies information about the product or service that is the subject of the transaction. It will be rendered in the header of the page. | [optional] |
+| **shipping** | **Integer** | The shipping amount of the transaction in the lowest denomination of currency. | [optional] |
+| **tax** | **Integer** | The tax amount of the transaction in the lowest denomination of currency. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkCart.new(
+  contents: null,
+  coupon: null,
+  mode: null,
+  product_description: null,
+  product_information: null,
+  shipping: null,
+  tax: null
+)
+```
+

data/docs/PaylinkCartItemModel.md

@@ -0,0 +1,32 @@
+# CityPayApiClient::PaylinkCartItemModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The net amount of the item. The Paylink Payment Form does not multiply this figure by the value provided by the count value for the cart item, this is principally to avoid rounding errors to introduce discrepancies between the value of the goods charged for and the total amount represented by the collection of cart items. | [optional] |
+| **brand** | **String** | The brand of the item such as Nike. | [optional] |
+| **category** | **String** | The category of the item such as shoes. | [optional] |
+| **count** | **Integer** | The count of how many of this item is being purchased, should the cart be editable, this value should be the default count required. The Paylink Payment Form assumes a count of 1 in the event that no value for the count field is provided for a cart item. | [optional] |
+| **label** | **String** | The label which describes the item. | [optional] |
+| **max** | **Integer** | For an editable cart, the maximum number of items that can be purchased, defaults to 5. | [optional] |
+| **sku** | **String** | The stock control unit value. | [optional] |
+| **variant** | **String** | The variant field refers to the variant of the cart item to enable similar items to be distinguished according to certain criteria. For example, similar items may be distinguished in terms of size, weight and power. The Paylink Payment Form does not constrain the value of the variant field to a particular set of metrics. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkCartItemModel.new(
+  amount: null,
+  brand: null,
+  category: null,
+  count: null,
+  label: null,
+  max: null,
+  sku: null,
+  variant: null
+)
+```
+

data/docs/PaylinkConfig.md

@@ -0,0 +1,60 @@
+# CityPayApiClient::PaylinkConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acs_mode** | **String** | Specifies the approach to be adopted by the Paylink form when displaying a 3-D Secure challenge window. The values may be  iframe: shows the 3-D Secure ACS in an iframe dialog, neatly embedding it in Paylink. This provides a more seamless flow for the cardholder who is able to validate and authenticate their card using a dialog provided by their card issuer.  inline: an inline mode transfers the full browser window to the authentication server, allowing the payment cardholder to see their payment card issuer's URL and the certificate status in the browser. If you request an iframe mode and the browser width is deemed as being small (< 768px) then an inline mode will be enforced. This is to ensure that mobile users have an improved user experience.  | [optional] |
+| **custom_params** | [**Array<PaylinkCustomParam>**](PaylinkCustomParam.md) |  | [optional] |
+| **descriptor** | **String** | Directly specify the merchant descriptor used for the transaction to be displayed on the payment page. | [optional] |
+| **expire_in** | **String** | Specifies a period of time in seconds after which the token cannot be used. A value of 0 defines that the token will never expire. The API will convert an expiry time based on a string value. For instance:   s - Time in seconds, for example 90s.   m - Time in minutes, for example 20m.   h - Time in hours, for example 4h.   w - Time in weeks, for example 4w.   M - Time in months, for example 6M.   y - Time in years, for example 1y.   Defaults to 30 minutes.  | [optional] |
+| **field_guard** | [**Array<PaylinkFieldGuardModel>**](PaylinkFieldGuardModel.md) |  | [optional] |
+| **lock_params** | **Array<String>** |  | [optional] |
+| **merch_logo** | **String** | A URL of a logo to include in the form. The URL should be delivered using HTTPS. | [optional] |
+| **merch_terms** | **String** | A URL of the merchant terms and conditions for payment. If a value is supplied, a checkbox will be required to be completed to confirm that the cardholder agrees to these conditions before payment. A modal dialogue is displayed with the content of the conditions displayed. | [optional] |
+| **options** | **Array<String>** |  | [optional] |
+| **part_payments** | [**PaylinkPartPayments**](PaylinkPartPayments.md) |  | [optional] |
+| **pass_through_data** | **Hash<String, String>** |  | [optional] |
+| **pass_through_headers** | **Hash<String, String>** |  | [optional] |
+| **postback** | **String** | Specifies a URL to use for a call back when the payment is completed. see Postback Handling }. | [optional] |
+| **postback_password** | **String** | A password to be added to the postback for HTTP Basic Authentication. | [optional] |
+| **postback_policy** | **String** | The policy setting for the postback see Postback Handling. | [optional] |
+| **postback_username** | **String** | A username to be added to the postback for HTTP Basic Authentication. | [optional] |
+| **redirect_delay** | **Integer** | A value which can delay the redirection in seconds. A value of 0 will redirect immediately. | [optional] |
+| **redirect_failure** | **String** | A URL which the browser is redirected to on non-completion of a transaction. | [optional] |
+| **redirect_success** | **String** | A URL which the browser is redirected to on authorisation of a transaction. | [optional] |
+| **renderer** | **String** | The Paylink renderer engine to use. | [optional] |
+| **return_params** | **Boolean** | If a value of true is specified, any redirection will include the transaction result in parameters. It is recommended to use the postback integration rather than redirection parameters. | [optional] |
+| **ui** | [**PaylinkUI**](PaylinkUI.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkConfig.new(
+  acs_mode: null,
+  custom_params: null,
+  descriptor: null,
+  expire_in: null,
+  field_guard: null,
+  lock_params: null,
+  merch_logo: null,
+  merch_terms: null,
+  options: null,
+  part_payments: null,
+  pass_through_data: null,
+  pass_through_headers: null,
+  postback: null,
+  postback_password: null,
+  postback_policy: null,
+  postback_username: null,
+  redirect_delay: null,
+  redirect_failure: null,
+  redirect_success: null,
+  renderer: null,
+  return_params: null,
+  ui: null
+)
+```
+

data/docs/PaylinkCustomParam.md

@@ -0,0 +1,38 @@
+# CityPayApiClient::PaylinkCustomParam
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkCustomParam.new(
+  entry_mode: null,
+  field_type: null,
+  group: null,
+  label: null,
+  locked: null,
+  name: null,
+  order: null,
+  pattern: null,
+  placeholder: null,
+  required: null,
+  value: null
+)
+```
+

data/docs/PaylinkEmailNotificationPath.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::PaylinkEmailNotificationPath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bcc** | **Array<String>** |  | [optional] |
+| **cc** | **Array<String>** |  | [optional] |
+| **reply_to** | **Array<String>** |  | [optional] |
+| **template** | **String** | An optional template name to use a template other than the default. | [optional] |
+| **to** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkEmailNotificationPath.new(
+  bcc: null,
+  cc: null,
+  reply_to: null,
+  template: null,
+  to: null
+)
+```
+

data/docs/PaylinkErrorCode.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::PaylinkErrorCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | An error code identifying the error. |  |
+| **msg** | **String** | An error message describing the error. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkErrorCode.new(
+  code: null,
+  msg: null
+)
+```
+

data/docs/PaylinkFieldGuardModel.md

@@ -0,0 +1,30 @@
+# CityPayApiClient::PaylinkFieldGuardModel
+
+## Properties
+
+| 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] |
+| **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] |
+| **name** | **String** | A field name which is used to refer to a field which is guarded. | [optional] |
+| **regex** | **String** | A JavaScript regular expression value which can be used to validate the data provided in the field guard entry form. Used for validating entry. | [optional] |
+| **value** | **String** | A value directly associated with the field guard. Any value provided at this level will be considered as sensitive and not logged. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkFieldGuardModel.new(
+  field_type: null,
+  label: null,
+  maxlen: null,
+  minlen: null,
+  name: null,
+  regex: null,
+  value: null
+)
+```
+

data/docs/PaylinkPartPayments.md

@@ -0,0 +1,28 @@
+# CityPayApiClient::PaylinkPartPayments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **String** | Determines if part payments is enabled. Default is false. | [optional] |
+| **floor** | **String** | The floor amount specifies a value that the minimum rate cannot go under. If 0 the amount of min rate is applied. | [optional] |
+| **max** | **String** | a maximum percentage to charge i.e. 90%. | [optional] |
+| **max_rate** | **String** | a rate as fixed or percentage. | [optional] |
+| **min** | **String** | a minimum percentage to charge i.e. 10. | [optional] |
+| **min_rate** | **String** | a rate as fixed or percentage. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkPartPayments.new(
+  enabled: null,
+  floor: null,
+  max: null,
+  max_rate: null,
+  min: null,
+  min_rate: null
+)
+```
+

data/docs/PaylinkSMSNotificationPath.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::PaylinkSMSNotificationPath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **String** | An optional template name to use a template other than the default. | [optional] |
+| **to** | **String** | The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format to send the message to. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkSMSNotificationPath.new(
+  template: null,
+  to: null
+)
+```
+

data/docs/PaylinkStateEvent.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::PaylinkStateEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkStateEvent.new(
+  datetime: null,
+  message: null,
+  state: null
+)
+```
+

data/docs/PaylinkTokenCreated.md

@@ -0,0 +1,44 @@
+# CityPayApiClient::PaylinkTokenCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachments** | [**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] |
+| **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] |
+| **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] |
+| **token** | **String** | A token generated for the request used to refer to the transaction in consequential calls. |  |
+| **url** | **String** | The Paylink token URL used to checkout by the card holder. | [optional] |
+| **usc** | **String** | A UrlShortCode (USC) used for short links. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkTokenCreated.new(
+  attachments: null,
+  bps: null,
+  date_created: null,
+  errors: null,
+  id: null,
+  identifier: null,
+  mode: null,
+  qr_code: null,
+  result: null,
+  server_version: null,
+  source: null,
+  token: null,
+  url: null,
+  usc: null
+)
+```
+

data/docs/PaylinkTokenRequestModel.md

@@ -0,0 +1,42 @@
+# CityPayApiClient::PaylinkTokenRequestModel
+
+## Properties
+
+| 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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkTokenRequestModel.new(
+  accountno: null,
+  amount: null,
+  cardholder: null,
+  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/PaylinkTokenStatus.md

@@ -0,0 +1,72 @@
+# CityPayApiClient::PaylinkTokenStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_paid** | **Integer** | the amount that has been paid against the session. | [optional] |
+| **auth_code** | **String** | an authorisation code if the transaction was processed and isPaid is true. | [optional] |
+| **card** | **String** | a description of the card that was used for payment if paid. | [optional] |
+| **created** | **Time** | the date and time that the session was created. | [optional] |
+| **datetime** | **Time** | the date and time of the current status. | [optional] |
+| **identifier** | **String** | the merchant identifier, to help identifying the token. | [optional] |
+| **is_attachment** | **Boolean** | true if an attachment exists. | [optional] |
+| **is_cancelled** | **Boolean** | true if the session was cancelled either by the user or by a system request. | [optional] |
+| **is_closed** | **Boolean** | true if the token has been closed. | [optional] |
+| **is_customer_receipt_email_sent** | **Boolean** | true if a customer receipt has been sent. | [optional] |
+| **is_email_sent** | **Boolean** | true if an email was sent. | [optional] |
+| **is_expired** | **Boolean** | true if the session has expired. | [optional] |
+| **is_form_viewed** | **Boolean** | true if the form was ever displayed to the addressee. | [optional] |
+| **is_merchant_notification_email_sent** | **Boolean** | true if a merchant notification receipt was sent. | [optional] |
+| **is_open_for_payment** | **Boolean** | true if the session is still open for payment or false if it has been closed. | [optional] |
+| **is_paid** | **Boolean** | whether the session has been paid and therefore can be considered as complete. | [optional] |
+| **is_payment_attempted** | **Boolean** | true if payment has been attempted. | [optional] |
+| **is_postback_ok** | **Boolean** | true if a post back was executed successfully. | [optional] |
+| **is_request_challenged** | **Boolean** | true if the request has been challenged using 3-D Secure. | [optional] |
+| **is_sms_sent** | **Boolean** | true if an SMS was sent. | [optional] |
+| **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] |
+| **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] |
+| **trans_no** | **Integer** | a transaction number if the transacstion was processed and isPaid is true. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkTokenStatus.new(
+  amount_paid: null,
+  auth_code: null,
+  card: null,
+  created: null,
+  datetime: null,
+  identifier: null,
+  is_attachment: null,
+  is_cancelled: null,
+  is_closed: null,
+  is_customer_receipt_email_sent: null,
+  is_email_sent: null,
+  is_expired: null,
+  is_form_viewed: null,
+  is_merchant_notification_email_sent: null,
+  is_open_for_payment: null,
+  is_paid: null,
+  is_payment_attempted: null,
+  is_postback_ok: null,
+  is_request_challenged: null,
+  is_sms_sent: null,
+  is_validated: null,
+  last_event_date_time: null,
+  last_payment_result: null,
+  mid: null,
+  payment_attempts_count: null,
+  state_history: null,
+  token: null,
+  trans_no: null
+)
+```
+

data/docs/PaylinkTokenStatusChangeRequest.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::PaylinkTokenStatusChangeRequest
+
+## Properties
+
+| 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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkTokenStatusChangeRequest.new(
+  after: null,
+  max_results: null,
+  merchantid: 11223344,
+  next_token: null,
+  order_by: null
+)
+```
+

data/docs/PaylinkTokenStatusChangeResponse.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::PaylinkTokenStatusChangeResponse
+
+## Properties
+
+| 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] |
+| **tokens** | [**Array<PaylinkTokenStatus>**](PaylinkTokenStatus.md) |  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkTokenStatusChangeResponse.new(
+  next_token: null,
+  tokens: null
+)
+```
+