citypay_api_client 1.0.2 → 1.1.1

data/docs/CardStatus.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**card_status** | **String** | The status of the card to set, valid values are ACTIVE or INACTIVE. | [optional] 
-**default** | **Boolean** | Defines if the card is set as the default. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_status** | **String** | The status of the card to set, valid values are ACTIVE or INACTIVE. | [optional] |
+| **default** | **Boolean** | Defines if the card is set as the default. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::CardStatus.new(card_status: null,
-                                 default: null)
+instance = CityPayApiClient::CardStatus.new(
+  card_status: null,
+  default: null
+)
 ```
 
-

data/docs/ChargeRequest.md

@@ -2,40 +2,45 @@
 
 ## 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] 
-**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 posession 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 32 to 127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  | 
-**match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.   Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.  `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.  `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.  `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] 
-**merchantid** | **Integer** | Identifies the merchant account to perform processing for. | 
-**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
-**token** | **String** | A tokenised form of a card that belongs to a card holder's account and that has been previously registered. The token is time based and will only be active for a short duration. The value is therefore designed not to be stored remotely for future  use.  Tokens will start with ct and are resiliently tamper proof using HMacSHA-256. No sensitive card data is stored internally within the token.  Each card will contain a different token and the value may be different on any retrieval call.  The value can be presented for payment as a selection value to an end user in a web application.  | 
-**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] 
+| 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] |
+| **cardholder_agreement** | **String** | Merchant-initiated transactions (MITs) are payments you trigger, where the cardholder has previously consented to you carrying out such payments. These may be scheduled (such as recurring payments and installments) or unscheduled (like account top-ups triggered by balance thresholds and no-show charges).  Scheduled --- These are regular payments using stored card details, like installments or a monthly subscription fee.  - `I` Instalment - A single purchase of goods or services billed to a cardholder in multiple transactions, over a period of time agreed by the cardholder and you.  - `R` Recurring - Transactions processed at fixed, regular intervals not to exceed one year between transactions, representing an agreement between a cardholder and you to purchase goods or services provided over a period of time.  Unscheduled --- These are payments using stored card details that do not occur on a regular schedule, like top-ups for a digital wallet triggered by the balance falling below a certain threshold.  - `A` Reauthorisation - a purchase made after the original purchase. A common scenario is delayed/split shipments.  - `C` Unscheduled Payment - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. This includes account top-ups triggered by balance thresholds.  - `D` Delayed Charge - A delayed charge is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental account charge after original services are rendered.  - `L` Incremental - An incremental authorisation is typically found in hotel and car rental environments, where the cardholder has agreed to pay for any service incurred during the duration of the contract. An incremental authorisation is where you need to seek authorisation of further funds in addition to what you have originally requested. A common scenario is additional services charged to the contract, such as extending a stay in a hotel.  - `S` Resubmission - When the original purchase occurred, but you were not able to get authorisation at the time the goods or services were provided. It should be only used where the goods or services have already been provided, but the authorisation request is declined for insufficient funds.  - `X` No-show - A no-show is a transaction where you are enabled to charge for services which the cardholder entered into an agreement to purchase, but the cardholder did not meet the terms of the agreement.  | [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 posession 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.  |  |
+| **initiation** | **String** | Transactions charged using the API are defined as:  **Cardholder Initiated**: A _cardholder initiated transaction_ (CIT) is where the cardholder selects the card for use for a purchase using previously stored details. An example would be a customer buying an item from your website after being present with their saved card details at checkout.  **Merchant Intiated**: A _merchant initiated transaction_ (MIT) is an authorisation initiated where you as the  merchant submit a cardholders previously stored details without the cardholder's participation. An example would  be a subscription to a membership scheme to debit their card monthly.  MITs have different reasons such as reauthorisation, delayed, unscheduled, incremental, recurring, instalment, no-show or resubmission.  The following values apply   - `M` - specifies that the transaction is initiated by the merchant   - `C` - specifies that the transaction is initiated by the cardholder  Where transactions are merchant initiated, a valid cardholder agreement must be defined.  | [optional] |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **merchantid** | **Integer** | Identifies the merchant account to perform processing for. |  |
+| **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] |
+| **token** | **String** | A tokenised form of a card that belongs to a card holder's account and that has been previously registered. The token is time based and will only be active for a short duration. The value is therefore designed not to be stored remotely for future use.   Tokens will start with ct and are resiliently tamper proof using HMacSHA-256. No sensitive card data is stored internally within the token.   Each card will contain a different token and the value may be different on any retrieval call.   The value can be presented for payment as a selection value to an end user in a web application.  |  |
+| **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::ChargeRequest.new(amount: 3600,
-                                 avs_postcode_policy: null,
-                                 csc: 12,
-                                 csc_policy: null,
-                                 currency: GBP,
-                                 duplicate_policy: null,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 match_avsa: null,
-                                 merchantid: 11223344,
-                                 sdk: MyClient 1.3.0,
-                                 token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr,
-                                 trans_info: null,
-                                 trans_type: null)
+instance = CityPayApiClient::ChargeRequest.new(
+  amount: 3600,
+  avs_postcode_policy: null,
+  cardholder_agreement: null,
+  csc: 10,
+  csc_policy: null,
+  currency: GBP,
+  duplicate_policy: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  initiation: null,
+  match_avsa: null,
+  merchantid: 11223344,
+  threedsecure: null,
+  token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr,
+  trans_info: null,
+  trans_type: null
+)
 ```
 
-

data/docs/CheckBatchStatus.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::CheckBatchStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_id** | **Array<Integer>** |  |  |
+| **client_account_id** | **String** | The batch account id to obtain the batch for. Defaults to your client id if not provided. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::CheckBatchStatus.new(
+  batch_id: null,
+  client_account_id: AC1
+)
+```
+

data/docs/CheckBatchStatusResponse.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::CheckBatchStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batches** | [**Array<Batch>**](Batch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::CheckBatchStatusResponse.new(
+  batches: null
+)
+```
+

data/docs/ContactDetails.md

@@ -2,40 +2,41 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address1** | **String** | The first line of the address for the card holder. | [optional] 
-**address2** | **String** | The second line of the address for the card holder. | [optional] 
-**address3** | **String** | The third line of the address for the card holder. | [optional] 
-**area** | **String** | The area such as city, department, parish for the card holder. | [optional] 
-**company** | **String** | The company name for the card holder if the contact is a corporate contact. | [optional] 
-**country** | **String** | The country code in ISO 3166 format. The country value may be used for fraud analysis and for   acceptance of the transaction.  | [optional] 
-**email** | **String** | An email address for the card holder which may be used for correspondence. | [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** | A mobile number for the card holder the mobile number is often required by delivery companies to ensure they are able to be in contact when required. | [optional] 
-**postcode** | **String** | The postcode or zip code of the address which may be used for fraud analysis. | [optional] 
-**telephone_no** | **String** | A telephone number for the card holder. | [optional] 
-**title** | **String** | A title for the card holder such as Mr, Mrs, Ms, M. Mme. etc. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | The first line of the address for the shipping contact. | [optional] |
+| **address2** | **String** | The second line of the address for the shipping contact. | [optional] |
+| **address3** | **String** | The third line of the address for the shipping contact. | [optional] |
+| **area** | **String** | The area such as city, department, parish for the shipping contact. | [optional] |
+| **company** | **String** | The company name for the shipping contact if the contact is a corporate contact. | [optional] |
+| **country** | **String** | The country code in ISO 3166 format. The country value may be used for fraud analysis and for   acceptance of the transaction.  | [optional] |
+| **email** | **String** | An email address for the shipping contact which may be used for correspondence. | [optional] |
+| **firstname** | **String** | The first name  of the shipping contact. | [optional] |
+| **lastname** | **String** | The last name or surname of the shipping contact. | [optional] |
+| **mobile_no** | **String** | A mobile number for the shipping contact the mobile number is often required by delivery companies to ensure they are able to be in contact when required. | [optional] |
+| **postcode** | **String** | The postcode or zip code of the address which may be used for fraud analysis. | [optional] |
+| **telephone_no** | **String** | A telephone number for the shipping contact. | [optional] |
+| **title** | **String** | A title for the shipping contact such as Mr, Mrs, Ms, M. Mme. etc. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::ContactDetails.new(address1: 79 Parliament St,
-                                 address2: Westminster,
-                                 address3: null,
-                                 area: London,
-                                 company: Acme Ltd,
-                                 country: GB,
-                                 email: card.holder@citypay.com,
-                                 firstname: John,
-                                 lastname: Smith,
-                                 mobile_no: 447790123456,
-                                 postcode: L1 789,
-                                 telephone_no: 442030123456,
-                                 title: Mr)
+instance = CityPayApiClient::ContactDetails.new(
+  address1: 79 Parliament St,
+  address2: Westminster,
+  address3: null,
+  area: London,
+  company: Acme Ltd,
+  country: GB,
+  email: card.holder@citypay.com,
+  firstname: John,
+  lastname: Smith,
+  mobile_no: 447790123456,
+  postcode: L1 789,
+  telephone_no: 442030123456,
+  title: Mr
+)
 ```
 
-

data/docs/Decision.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authen_required** | [**AuthenRequired**](AuthenRequired.md) |  | [optional] 
-**auth_response** | [**AuthResponse**](AuthResponse.md) |  | [optional] 
-**request_challenged** | [**RequestChallenged**](RequestChallenged.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authen_required** | [**AuthenRequired**](AuthenRequired.md) |  | [optional] |
+| **auth_response** | [**AuthResponse**](AuthResponse.md) |  | [optional] |
+| **request_challenged** | [**RequestChallenged**](RequestChallenged.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::Decision.new(authen_required: null,
-                                 auth_response: null,
-                                 request_challenged: null)
+instance = CityPayApiClient::Decision.new(
+  authen_required: null,
+  auth_response: null,
+  request_challenged: null
+)
 ```
 
-