citypay_api_client 1.1.1 → 1.1.2

data/docs/BatchProcessingApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://api.citypay.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**batch_process_request**](BatchProcessingApi.md#batch_process_request) | **POST** /v6/batch/process | Batch Process Request |
-| [**batch_report_request**](BatchProcessingApi.md#batch_report_request) | **POST** /v6/batch/retrieve | BatchReportRequest |
+| [**batch_retrieve_request**](BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | BatchReportRequest |
 | [**check_batch_status_request**](BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | CheckBatchStatus |
 
 
@@ -15,7 +15,11 @@ All URIs are relative to *https://api.citypay.com*
 
 Batch Process Request
 
-A batch process request is used to start the batch process workflow by uploading batch data and initialising a new batch for processing. Once validated the batch will be queued for processing and further updates can be received by a subsequent call to retrieve the batch status. 
+A batch process request is used to start the batch process workflow by uploading batch
+data and initialising a new batch for processing. Once validated the batch will be queued
+for processing and further updates can be received by a subsequent call to retrieve the batch
+status.
+
 
 ### Examples
 
@@ -77,13 +81,13 @@ end
 - **Accept**: application/json, text/xml
 
 
-## batch_report_request
+## batch_retrieve_request
 
-> <BatchReportResponseModel> batch_report_request(batch_report_request)
+> <BatchReportResponseModel> batch_retrieve_request(batch_report_request)
 
 BatchReportRequest
 
-The operation is used to retrieve a report of the result of a batch process.
+The report for a given batch.
 
 ### Examples
 
@@ -100,28 +104,28 @@ batch_report_request = CityPayApiClient::BatchReportRequest.new({batch_id: 35})
 
 begin
   # BatchReportRequest
-  result = api_instance.batch_report_request(batch_report_request)
+  result = api_instance.batch_retrieve_request(batch_report_request)
   p result
 rescue CityPayApiClient::ApiError => e
-  puts "Error when calling BatchProcessingApi->batch_report_request: #{e}"
+  puts "Error when calling BatchProcessingApi->batch_retrieve_request: #{e}"
 end
 ```
 
-#### Using the batch_report_request_with_http_info variant
+#### Using the batch_retrieve_request_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BatchReportResponseModel>, Integer, Hash)> batch_report_request_with_http_info(batch_report_request)
+> <Array(<BatchReportResponseModel>, Integer, Hash)> batch_retrieve_request_with_http_info(batch_report_request)
 
 ```ruby
 begin
   # BatchReportRequest
-  data, status_code, headers = api_instance.batch_report_request_with_http_info(batch_report_request)
+  data, status_code, headers = api_instance.batch_retrieve_request_with_http_info(batch_report_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BatchReportResponseModel>
 rescue CityPayApiClient::ApiError => e
-  puts "Error when calling BatchProcessingApi->batch_report_request_with_http_info: #{e}"
+  puts "Error when calling BatchProcessingApi->batch_retrieve_request_with_http_info: #{e}"
 end
 ```
 

data/docs/BatchTransactionResultModel.md

@@ -14,7 +14,9 @@
 | **message** | **String** | A response message pertaining to the transaction. |  |
 | **result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value  <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>  |  |
 | **result_code** | **String** | A result code of the transaction identifying the result of the transaction for success, rejection or decline. |  |
-| **scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme_id** | **String** | The name of the card scheme of the transaction such as VI or MC.  | [optional] |
+| **scheme_logo** | **String** | A url containing a logo of the card scheme.  | [optional] |
 | **transno** | **Integer** | The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.  | [optional] |
 
 ## Example
@@ -34,6 +36,8 @@ instance = CityPayApiClient::BatchTransactionResultModel.new(
   result: 1,
   result_code: 0,
   scheme: Visa,
+  scheme_id: MC,
+  scheme_logo: https://cdn.citypay.com/img/cs/visa-logo.svg,
   transno: 78416
 )
 ```

data/docs/Card.md

@@ -44,7 +44,7 @@ instance = CityPayApiClient::Card.new(
   date_created: 2020-01-02T18:32:28Z,
   default: null,
   expmonth: 9,
-  expyear: 2025,
+  expyear: 2027,
   label: Visa/0002,
   label2: Visa/0002,Exp:2304,
   last4digits: 2,

data/docs/CardHolderAccountApi.md

@@ -22,7 +22,9 @@ All URIs are relative to *https://api.citypay.com*
 
 Card Deletion
 
-Deletes a card from the account. The card will be marked for deletion before a subsequent purge will clear the card permanently. 
+Deletes a card from the account. The card will be marked for deletion before a subsequent
+purge will clear the card permanently.
+
 
 ### Examples
 
@@ -92,7 +94,15 @@ end
 
 Card Registration
 
-Allows for a card to be registered for the account. The card will be added for future  processing and will be available as a tokenised value for future processing.  The card will be validated for  0. Being a valid card number (luhn check) 0. Having a valid expiry date 0. Being a valid bin value. 
+Allows for a card to be registered for the account. The card will be added for future 
+processing and will be available as a tokenised value for future processing.
+
+The card will be validated for
+
+0. Being a valid card number (luhn check)
+0. Having a valid expiry date
+0. Being a valid bin value.
+
 
 ### Examples
 
@@ -106,7 +116,7 @@ end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
 accountid = 'accountid_example' # String | The account id that refers to the customer's account no. This value will have been provided when setting up the card holder account.
-register_card = CityPayApiClient::RegisterCard.new({cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025}) # RegisterCard | 
+register_card = CityPayApiClient::RegisterCard.new({cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027}) # RegisterCard | 
 
 begin
   # Card Registration
@@ -162,7 +172,14 @@ end
 
 Card Status
 
-Updates the status of a card for processing. The following values are available  | Status | Description |  |--------|-------------| | Active | The card is active for processing and can be used for charging against with a valid token | | Inactive | The card is inactive for processing and cannot be used for processing, it will require reactivation before being used to charge | | Expired | The card has expired either due to the expiry date no longer being valid or due to a replacement card being issued | 
+Updates the status of a card for processing. The following values are available
+
+| Status | Description | 
+|--------|-------------|
+| Active | The card is active for processing and can be used for charging against with a valid token |
+| Inactive | The card is inactive for processing and cannot be used for processing, it will require reactivation before being used to charge |
+| Expired | The card has expired either due to the expiry date no longer being valid or due to a replacement card being issued |
+
 
 ### Examples
 
@@ -372,7 +389,9 @@ end
 
 Account Deletion
 
-Allows for the deletion of an account. The account will marked for deletion and subsequent purging. No further transactions will be alowed to be processed or actioned against this account. 
+Allows for the deletion of an account. The account will marked for deletion and subsequent purging. No further
+transactions will be alowed to be processed or actioned against this account.
+
 
 ### Examples
 
@@ -440,7 +459,8 @@ end
 
 Account Exists
 
-Checks that an account exists and is active by providing the account id as a url parameter. 
+Checks that an account exists and is active by providing the account id as a url parameter.
+
 
 ### Examples
 
@@ -508,7 +528,13 @@ end
 
 Account Retrieval
 
-Allows for the retrieval of a card holder account for the given `id`. Should duplicate accounts exist for the same `id`, the first account created with that `id` will be returned.  The account can be used for tokenisation processing by listing all cards assigned to the account. The returned cards will include all `active`, `inactive` and `expired` cards. This can be used to  enable a card holder to view their wallet and make constructive choices on which card to use. 
+Allows for the retrieval of a card holder account for the given `id`. Should duplicate accounts exist
+for the same `id`, the first account created with that `id` will be returned.
+
+The account can be used for tokenisation processing by listing all cards assigned to the account.
+The returned cards will include all `active`, `inactive` and `expired` cards. This can be used to 
+enable a card holder to view their wallet and make constructive choices on which card to use.
+
 
 ### Examples
 
@@ -576,7 +602,13 @@ end
 
 Account Status
 
-Updates the status of an account. An account can have the following statuses applied  | Status | Description | |--------|-------------| | Active | The account is active for processing | | Disabled | The account has been disabled and cannot be used for processing. The account will require reactivation to continue procesing | 
+Updates the status of an account. An account can have the following statuses applied
+
+| Status | Description |
+|--------|-------------|
+| Active | The account is active for processing |
+| Disabled | The account has been disabled and cannot be used for processing. The account will require reactivation to continue procesing |
+
 
 ### Examples
 
@@ -646,7 +678,30 @@ end
 
 Charge
 
-A charge process obtains an authorisation using a tokenised value which represents a stored card  on a card holder account.  A card must previously be registered by calling `/account-register-card` with the card details  or retrieved using `/account-retrieve`  Tokens are generated whenever a previously registered list of cards are retrieved. Each token has, by design a  relatively short time to live of 30 minutes. This is both to safe guard the merchant and card holder from  replay attacks. Tokens are also restricted to your account, preventing malicious actors from stealing details for use elsewhere.    If a token is reused after it has expired it will be rejected and a new token will be required.   Tokenisation can be used for   - repeat authorisations on a previously stored card - easy authorisations just requiring CSC values to be entered - can be used for credential on file style payments - can require full 3-D Secure authentication to retain the liability shift - wallet style usage    _Should an account be used with 3DSv2, the card holder name should also be stored alongside the card as this is a required field with both Visa and MasterCard for risk analysis._. 
+A charge process obtains an authorisation using a tokenised value which represents a stored card 
+on a card holder account. 
+A card must previously be registered by calling `/account-register-card` with the card details 
+or retrieved using `/account-retrieve`
+
+Tokens are generated whenever a previously registered list of cards are retrieved. Each token has, by design a 
+relatively short time to live of 30 minutes. This is both to safe guard the merchant and card holder from 
+replay attacks. Tokens are also restricted to your account, preventing malicious actors from stealing details
+for use elsewhere.  
+
+If a token is reused after it has expired it will be rejected and a new token will be required.
+ 
+Tokenisation can be used for
+ 
+- repeat authorisations on a previously stored card
+- easy authorisations just requiring CSC values to be entered
+- can be used for credential on file style payments
+- can require full 3-D Secure authentication to retain the liability shift
+- wallet style usage
+ 
+
+_Should an account be used with 3DSv2, the card holder name should also be stored alongside the card as this is a
+required field with both Visa and MasterCard for risk analysis._.
+
 
 ### Examples
 

data/docs/ChargeRequest.md

@@ -15,6 +15,7 @@
 | **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. |  |
+| **tag** | **String** | A \"tag\" is a label that you can attach to a payment authorization. Tags can help you group transactions together based on certain criteria, like a work job or a ticket number. They can also assist in filtering transactions when you're generating reports.  Multiple Tags You can add more than one tag to a transaction by separating them with commas.  Limitations There is a maximum limit of 3 tags that can be added to a single transaction. Each tag can be no longer than 20 characters and alphanumeric with no spaces.  Example: Let's say you're a software company and you have different teams working on various projects. When a team makes a purchase or incurs an expense, they can tag the transaction with the project name, the team name, and the type of expense.  Project Name: Project_X Team Name: Team_A Type of Expense: Hardware So, the tag for a transaction might look like: Project_X,Team_A,Hardware  This way, when you're looking at your financial reports, you can easily filter transactions based on these tags to see how much each project or team is spending on different types of expenses.  | [optional] |
 | **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] |
@@ -37,6 +38,7 @@ instance = CityPayApiClient::ChargeRequest.new(
   initiation: null,
   match_avsa: null,
   merchantid: 11223344,
+  tag: null,
   threedsecure: null,
   token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr,
   trans_info: null,

data/docs/ContactDetails.md

@@ -4,19 +4,19 @@
 
 | 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] |
+| **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 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] |
+| **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 shipping contact. | [optional] |
-| **title** | **String** | A title for the shipping contact such as Mr, Mrs, Ms, M. Mme. etc. | [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] |
 
 ## Example
 

data/docs/DirectPostApi.md

@@ -17,7 +17,10 @@ All URIs are relative to *https://api.citypay.com*
 
 Handles a CRes response from ACS, returning back the result of authorisation
 
-Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData`
+value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to
+perform a `Direct Post` integration who wish to handle the challenge flow themselves.
+
 
 ### Examples
 
@@ -87,7 +90,10 @@ No authorization required
 
 Handles a CRes response from ACS, returning back a token for future authorisation
 
-Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData`
+value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to
+perform a `Direct Post` integration who wish to handle the challenge flow themselves.
+
 
 ### Examples
 
@@ -157,7 +163,15 @@ No authorization required
 
 Direct Post Auth Request
 
-Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/direct/auth?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+Used to initiate a direct post request transaction flow.
+
+<pre class="inline-code language-bash">
+<code>
+curl https://api.citypay.com/direct/auth?cp-domain-key=n834ytqp84y... \
+ -d "amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW
+</code>
+</pre>.
+
 
 ### Examples
 
@@ -166,14 +180,14 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
-direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
 
 begin
   # Direct Post Auth Request
@@ -214,7 +228,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 
@@ -228,7 +242,15 @@ end
 
 Direct Post Tokenise Request
 
-Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/v6/direct?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+Used to initiate a direct post request transaction flow.
+
+<pre class="inline-code language-bash">
+<code>
+curl https://api.citypay.com/v6/direct?cp-domain-key=n834ytqp84y... \
+ -d "amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW
+</code>
+</pre>.
+
 
 ### Examples
 
@@ -237,14 +259,14 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
-direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
 
 begin
   # Direct Post Tokenise Request
@@ -285,7 +307,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 
@@ -299,7 +321,9 @@ end
 
 Direct Post Token Request
 
-Perform a request for authorisation for a previously generated token. This flow will return an authorisation response stating that the transaction was approved or declined. 
+Perform a request for authorisation for a previously generated token. This flow will return an authorisation
+response stating that the transaction was approved or declined.
+
 
 ### Examples
 
@@ -308,10 +332,10 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::DirectPostApi.new
@@ -356,7 +380,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers
 

data/docs/DirectPostRequest.md

@@ -22,6 +22,7 @@
 | **redirect_failure** | **String** | The URL used to redirect back to your site when a transaction has been rejected or declined. Required if a url-encoded request.  | [optional] |
 | **redirect_success** | **String** | The URL used to redirect back to your site when a transaction has been tokenised or authorised. Required if a url-encoded request.  | [optional] |
 | **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **String** | A \"tag\" is a label that you can attach to a payment authorization. Tags can help you group transactions together based on certain criteria, like a work job or a ticket number. They can also assist in filtering transactions when you're generating reports.  Multiple Tags You can add more than one tag to a transaction by separating them with commas.  Limitations There is a maximum limit of 3 tags that can be added to a single transaction. Each tag can be no longer than 20 characters and alphanumeric with no spaces.  Example: Let's say you're a software company and you have different teams working on various projects. When a team makes a purchase or incurs an expense, they can tag the transaction with the project name, the team name, and the type of expense.  Project Name: Project_X Team Name: Team_A Type of Expense: Hardware So, the tag for a transaction might look like: Project_X,Team_A,Hardware  This way, when you're looking at your financial reports, you can easily filter transactions based on these tags to see how much each project or team is spending on different types of expenses.  | [optional] |
 | **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [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] |
@@ -41,7 +42,7 @@ instance = CityPayApiClient::DirectPostRequest.new(
   currency: GBP,
   duplicate_policy: null,
   expmonth: 9,
-  expyear: 2025,
+  expyear: 2027,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   mac: 3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D,
   match_avsa: null,
@@ -50,6 +51,7 @@ instance = CityPayApiClient::DirectPostRequest.new(
   redirect_failure: https://pay.mystore.com/continue_failure,
   redirect_success: https://pay.mystore.com/continue_success,
   ship_to: null,
+  tag: null,
   threedsecure: null,
   trans_info: null,
   trans_type: null

data/docs/OperationalFunctionsApi.md

@@ -17,7 +17,9 @@ All URIs are relative to *https://api.citypay.com*
 
 ACL Check Request
 
-Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and services such as AWS or Azure to check that those addresses are listed in the ACLs. 
+Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and
+services such as AWS or Azure to check that those addresses are listed in the ACLs.
+
 
 ### Examples
 
@@ -85,7 +87,9 @@ end
 
 Domain Key Check Request
 
-Checks the contents of a `domain key`. Can be used for operational processes to ensure that the properties of a  domain key meet their expectations. 
+Checks the contents of a `domain key`. Can be used for operational processes to ensure that the properties of a 
+domain key meet their expectations.
+
 
 ### Examples
 
@@ -153,7 +157,9 @@ end
 
 Domain Key Generation Request
 
-Generates a domain key based on the permissions of the calling `api-key`. Domain keys can be used in _Direct Post_ and `XHR` calls to the API services. 
+Generates a domain key based on the permissions of the calling `api-key`. Domain keys can be used in _Direct Post_ and
+`XHR` calls to the API services.
+
 
 ### Examples
 
@@ -221,7 +227,14 @@ end
 
 List Merchants Request
 
-An operational request to list current merchants for a client.  ### Sorting  Sorting can be performed by include a query parameter i.e. `/merchants/?sort=merchantid`  Fields that can be sorted are `merchantid` or `name`. 
+An operational request to list current merchants for a client.
+
+### Sorting
+
+Sorting can be performed by include a query parameter i.e. `/merchants/?sort=merchantid`
+
+Fields that can be sorted are `merchantid` or `name`.
+
 
 ### Examples
 
@@ -289,7 +302,14 @@ end
 
 Ping Request
 
-A ping request which performs a connection and authentication test to the CityPay API server. The request will return a standard Acknowledgement with a response code `044` to signify a successful ping.  The ping call is useful to confirm that you will be able to access  the API from behind any firewalls and that the permission model is granting access from your source. 
+A ping request which performs a connection and authentication test to the CityPay API server. The request
+will return a standard Acknowledgement with a response code `044` to signify a successful
+ping.
+
+The ping call is useful to confirm that you will be able to access 
+the API from behind any firewalls and that the permission
+model is granting access from your source.
+
 
 ### Examples
 
@@ -298,10 +318,10 @@ require 'time'
 require 'citypay_api_client'
 # setup authorization
 CityPayApiClient.configure do |config|
-  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
-
   # Configure API key authorization: cp-domain-key
   config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
 api_instance = CityPayApiClient::OperationalFunctionsApi.new
@@ -346,7 +366,7 @@ end
 
 ### Authorization
 
-[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
 
 ### HTTP request headers