citypay_api_client 1.1.1 → 1.1.3

data/docs/PaylinkTokenCreated.md

@@ -11,7 +11,7 @@
 | **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] |
+| **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 +27,17 @@ require 'citypay_api_client'
 instance = CityPayApiClient::PaylinkTokenCreated.new(
   attachments: null,
   bps: null,
-  date_created: null,
+  date_created: 2024-04-22T13:29:14Z,
   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,
+  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

@@ -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/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: 2024-04-22T13:29:14Z,
+  datetime: 2024-04-22T13:29:14Z,
+  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: 2024-04-22T13:29:14Z,
   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: 2024-04-22T13:29:14Z,
+  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/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/RefundRequest.md

@@ -16,7 +16,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::RefundRequest.new(
-  amount: 3600,
+  amount: 19995,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   merchantid: 11223344,
   refund_ref: 8322,

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/RemittanceData.md

@@ -0,0 +1,28 @@
+# CityPayApiClient::RemittanceData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | Represents the date and time when the remittance was processed. This timestamp follows the ISO 8601 format for datetime representation. | [optional] |
+| **net_amount** | **Integer** | Represents the net amount after accounting for refunds. This is calculated as SalesAmount - RefundAmount and expressed in the smallest currency unit. | [optional] |
+| **refund_amount** | **Integer** | The total amount refunded to customers. | [optional] |
+| **refund_count** | **Integer** | The total number of refund transactions processed. This figure helps in understanding the frequency of refunds relative to sales. | [optional] |
+| **sales_amount** | **Integer** | The total monetary amount of sales transactions. | [optional] |
+| **sales_count** | **Integer** | Indicates the total number of sales transactions that occurred. This count provides insight into the volume of sales. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::RemittanceData.new(
+  date_created: 2020-01-02T18:32:28Z,
+  net_amount: 11874500,
+  refund_amount: 11874500,
+  refund_count: 11874500,
+  sales_amount: 11874500,
+  sales_count: 11874500
+)
+```
+

data/docs/RemittanceReportRequest.md

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

data/docs/RemittanceReportResponse.md

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

data/docs/RemittedClientData.md

@@ -0,0 +1,44 @@
+# CityPayApiClient::RemittedClientData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batches** | [**Array<MerchantBatchResponse>**](MerchantBatchResponse.md) |  |  |
+| **clientid** | **String** | The client id that the remittance data is for. | [optional] |
+| **date** | **Date** | The date of the remittance. | [optional] |
+| **date_created** | **Time** | The date time that the remittance was created. | [optional] |
+| **net_amount** | **Integer** | Represents the net amount after accounting for refunds. This is calculated as SalesAmount - RefundAmount and expressed in the smallest currency unit. | [optional] |
+| **processed_amount** | **Integer** | The total monetary amount processed consisting of sale and refund transactions. | [optional] |
+| **processed_count** | **Integer** | Indicates the total number of sales and refund transactions that occurred. This count provides insight into the volume of processing. | [optional] |
+| **refund_amount** | **Integer** | The total amount refunded to customers. | [optional] |
+| **refund_count** | **Integer** | The total number of refund transactions processed. This figure helps in understanding the frequency of refunds relative to sales. | [optional] |
+| **remittances** | [**Array<RemittanceData>**](RemittanceData.md) |  |  |
+| **sales_amount** | **Integer** | The total monetary amount of sales transactions. | [optional] |
+| **sales_count** | **Integer** | Indicates the total number of sales transactions that occurred. This count provides insight into the volume of sales. | [optional] |
+| **settlement_implementation** | **String** | The name of the implementation. | [optional] |
+| **uuid** | **String** | The uuid of the settlement file processed on. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::RemittedClientData.new(
+  batches: null,
+  clientid: PC12345,
+  date: Thu Jan 02 00:00:00 UTC 2020,
+  date_created: 2020-01-02T18:32:28Z,
+  net_amount: 11874500,
+  processed_amount: 11874500,
+  processed_count: 11874500,
+  refund_amount: 11874500,
+  refund_count: 11874500,
+  remittances: null,
+  sales_amount: 11874500,
+  sales_count: 11874500,
+  settlement_implementation: null,
+  uuid: 123e4567-e89b-12d3-a456-426614174000
+)
+```
+