citypay_api_client 1.0.2 → 1.1.1

data/docs/RefundRequest.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::RefundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to refund in the lowest unit of currency with a variable length to a maximum of 12 digits.  The amount should be the total amount required to refund for the transaction up to the original processed amount.  No decimal points are to be included and no divisional characters such as 1,024.  For example with GBP £1,021.95 the amount value is 102195.  |  |
+| **identifier** | **String** | The identifier of the refund 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.  |  |
+| **merchantid** | **Integer** | Identifies the merchant account to perform the refund for. |  |
+| **refund_ref** | **Integer** | A reference to the original transaction number that is wanting to be refunded. The original  transaction must be on the same merchant id, previously authorised.  |  |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::RefundRequest.new(
+  amount: 3600,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344,
+  refund_ref: 8322,
+  trans_info: null
+)
+```
+

data/docs/RegisterCard.md

@@ -2,22 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cardnumber** | **String** | The primary number of the card. | 
-**default** | **Boolean** | Determines whether the card should be the new default card. | [optional] 
-**expmonth** | **Integer** | The expiry month of the card. | 
-**expyear** | **Integer** | The expiry year of the card. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cardnumber** | **String** | The primary number of the card. |  |
+| **default** | **Boolean** | Determines whether the card should be the new default card. | [optional] |
+| **expmonth** | **Integer** | The expiry month of the card. |  |
+| **expyear** | **Integer** | The expiry year of the card. |  |
+| **name_on_card** | **String** | The card holder name as it appears on the card. The value is required if the account is to be used for 3dsv2 processing, otherwise it is optional. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::RegisterCard.new(cardnumber: 4000 0000 0000 0002,
-                                 default: null,
-                                 expmonth: 9,
-                                 expyear: 2023)
+instance = CityPayApiClient::RegisterCard.new(
+  cardnumber: 4000 0000 0000 0002,
+  default: null,
+  expmonth: 9,
+  expyear: 2025,
+  name_on_card: MR NE BODY
+)
 ```
 
-

data/docs/RequestChallenged.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**acs_url** | **String** | The url of the Access Control Server (ACS) to forward the user to.  | [optional] 
-**creq** | **String** | The challenge request data which is encoded for usage by the ACS. | [optional] 
-**merchantid** | **Integer** | The merchant id that processed this transaction. | [optional] 
-**three_d_server_trans_id** | **String** | The 3DSv2 trans id reference for the challenge process. | [optional] 
-**transno** | **Integer** | The transaction number for the challenge, ordered incrementally from 1 for every merchant_id.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acs_url** | **String** | The url of the Access Control Server (ACS) to forward the user to.  | [optional] |
+| **creq** | **String** | The challenge request data which is encoded for usage by the ACS. | [optional] |
+| **merchantid** | **Integer** | The merchant id that processed this transaction. | [optional] |
+| **threedserver_trans_id** | **String** | The 3DSv2 trans id reference for the challenge process. May be used to create the ThreeDSSessionData value to send to the ACS. | [optional] |
+| **transno** | **Integer** | The transaction number for the challenge, ordered incrementally from 1 for every merchant_id.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::RequestChallenged.new(acs_url: https://acs.cardissuer.com/3dsv1,
-                                 creq: null,
-                                 merchantid: 11223344,
-                                 three_d_server_trans_id: null,
-                                 transno: 78416)
+instance = CityPayApiClient::RequestChallenged.new(
+  acs_url: https://acs.cardissuer.com/3dsv1,
+  creq: null,
+  merchantid: 11223344,
+  threedserver_trans_id: null,
+  transno: 78416
+)
 ```
 
-

data/docs/RetrieveRequest.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**identifier** | **String** | The identifier of the transaction to retrieve. Optional if a transaction number is provided. | [optional] 
-**merchantid** | **Integer** | The merchant account to retrieve data for. | 
-**transno** | **Integer** | The transaction number of a transaction to retrieve. Optional if an identifier is supplied. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | The identifier of the transaction to retrieve. Optional if a transaction number is provided. | [optional] |
+| **merchantid** | **Integer** | The merchant account to retrieve data for. |  |
+| **transno** | **Integer** | The transaction number of a transaction to retrieve. Optional if an identifier is supplied. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::RetrieveRequest.new(identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 merchantid: 11223344,
-                                 transno: 78416)
+instance = CityPayApiClient::RetrieveRequest.new(
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344,
+  transno: 78416
+)
 ```
 
-

data/docs/ThreeDSecure.md

@@ -2,24 +2,41 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accept_headers** | **String** | The content of the HTTP accept header as sent to the merchant from the cardholder's user agent. This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.  | [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. Required if 3DSv1 or 3DSv2 is required.  | [optional] 
-**tds_policy** | **String** | A policy value which determines whether ThreeDSecure is enforced or bypassed. Note that this will only work for e-commerce transactions and accounts that have 3DSecure enabled and fully registered with Visa, MasterCard or American Express. It is useful when transactions may be wanted to bypass processing rules.  Note that this may affect the liability shift of transactions and may occur a higher fee with the acquiring bank.  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 will be enabled for 3DS processing  `2` to bypass. Transactions that are bypassed will switch off 3DS processing.  | [optional] 
-**user_agent** | **String** | The content of the HTTP user-agent header as sent to the merchant from the cardholder's user agent. This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_headers** | **String** | Required for 3DSv1. Optional if the `cp_bx` value is provided otherwise required for 3Dv2 processing operating in browser authentication mode.  The `cp_bx` value will override any value supplied to this field.  The content of the HTTP accept header as sent to the merchant from the cardholder's user agent.  This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.  | [optional] |
+| **browser_color_depth** | **String** | BrowserColorDepth field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
+| **browser_ip** | **String** | BrowserIP field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
+| **browser_java_enabled** | **String** | BrowserJavaEnabled field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
+| **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] |
+| **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] |
+| **tds_policy** | **String** | A policy value which determines whether ThreeDSecure is enforced or bypassed. Note that this will only work for e-commerce transactions and accounts that have 3DSecure enabled and fully registered with Visa, MasterCard or American Express. It is useful when transactions may be wanted to bypass processing rules.  Note that this may affect the liability shift of transactions and may occur a higher fee with the acquiring bank.  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 will be enabled for 3DS processing   `2` to bypass. Transactions that are bypassed will switch off 3DS processing.  | [optional] |
+| **user_agent** | **String** | Required for 3DSv1.  Optional if the `cp_bx` value is provided otherwise required 3Dv2 processing operating in browser authentication mode.  The `cp_bx` value will override any value supplied to this field.  The content of the HTTP user-agent header as sent to the merchant from the cardholder's user agent.  This value will be validated by the ACS when the card holder authenticates themselves to verify that no intermediary is performing this action. Required for 3DSv1.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::ThreeDSecure.new(accept_headers: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9,
-                                 downgrade1: null,
-                                 merchant_termurl: null,
-                                 tds_policy: null,
-                                 user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36)
+instance = CityPayApiClient::ThreeDSecure.new(
+  accept_headers: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9,
+  browser_color_depth: null,
+  browser_ip: null,
+  browser_java_enabled: null,
+  browser_language: null,
+  browser_screen_height: null,
+  browser_screen_width: null,
+  browser_tz: null,
+  cp_bx: FjaW50b3NoOyBJbnRlbCBNYWMgT1MgWCAx...,
+  downgrade1: null,
+  merchant_termurl: https://mysite.com/acs/return,
+  tds_policy: null,
+  user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36
+)
 ```
 
-

data/docs/TokenisationResponseModel.md

@@ -0,0 +1,36 @@
+# CityPayApiClient::TokenisationResponseModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authen_result** | **String** | The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are:  <table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>Y</td> <td>Authentication Successful. The Cardholder's password was successfully validated.</td> </tr> <tr> <td>N</td> <td>Authentication Failed. Customer failed or cancelled authentication, transaction denied.</td> </tr> <tr> <td>A</td> <td>Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated.</td> </tr> <tr> <td>U</td> <td>Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem.</td> </tr> </table>  | [optional] |
+| **bin_commercial** | **Boolean** | Determines whether the bin range was found to be a commercial or business card. | [optional] |
+| **bin_debit** | **Boolean** | Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card. | [optional] |
+| **bin_description** | **String** | A description of the bin range found for the card. | [optional] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::TokenisationResponseModel.new(
+  authen_result: null,
+  bin_commercial: null,
+  bin_debit: null,
+  bin_description: Platinum Card,
+  eci: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  maskedpan: 4***********0002,
+  scheme: Visa,
+  sig_id: YWV3ZmF3ZWZhd2VmYXdmMmZhZWYzYWVn,
+  token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr
+)
+```
+

data/docs/VoidRequest.md

@@ -2,22 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**identifier** | **String** | The identifier of the transaction to void. If an empty value is supplied then a `trans_no` value must be supplied. | [optional] 
-**merchantid** | **Integer** | Identifies the merchant account to perform the void for. | 
-**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
-**transno** | **Integer** | The transaction number of the transaction to look up and void. If an empty value is supplied then an identifier value must be supplied. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | The identifier of the transaction to void. If an empty value is supplied then a `trans_no` value must be supplied. | [optional] |
+| **merchantid** | **Integer** | Identifies the merchant account to perform the void for. |  |
+| **transno** | **Integer** | The transaction number of the transaction to look up and void. If an empty value is supplied then an identifier value must be supplied. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::VoidRequest.new(identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 merchantid: 11223344,
-                                 sdk: MyClient 1.3.0,
-                                 transno: 78416)
+instance = CityPayApiClient::VoidRequest.new(
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344,
+  transno: 78416
+)
 ```
 
-