citypay_api_client 1.1.2 → 1.1.3

data/docs/AuthorisationAndPaymentApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.citypay.com*
 | [**bin_range_lookup_request**](AuthorisationAndPaymentApi.md#bin_range_lookup_request) | **POST** /v6/bin | Bin Lookup |
 | [**c_res_request**](AuthorisationAndPaymentApi.md#c_res_request) | **POST** /v6/cres | CRes |
 | [**capture_request**](AuthorisationAndPaymentApi.md#capture_request) | **POST** /v6/capture | Capture |
+| [**create_payment_intent**](AuthorisationAndPaymentApi.md#create_payment_intent) | **POST** /v6/intent/create | Create a Payment Intent |
 | [**pa_res_request**](AuthorisationAndPaymentApi.md#pa_res_request) | **POST** /v6/pares | PaRes |
 | [**refund_request**](AuthorisationAndPaymentApi.md#refund_request) | **POST** /v6/refund | Refund |
 | [**retrieval_request**](AuthorisationAndPaymentApi.md#retrieval_request) | **POST** /v6/retrieve | Retrieval |
@@ -20,235 +21,7 @@ All URIs are relative to *https://api.citypay.com*
 
 Authorisation
 
-An authorisation process performs a standard transaction authorisation based on the provided parameters of its request.
-The CityPay gateway will route your transaction via an Acquiring bank for subsequent authorisation to the appropriate card 
-schemes such as Visa or MasterCard.
-
-The authorisation API should be used for server environments to process transactions on demand and in realtime. 
-
-The authorisation API can be used for multiple types of transactions including E-commerce, mail order, telephone order,
-customer present (keyed), continuous authority, pre-authorisation and others. CityPay will configure your account for 
-the appropriate coding and this will perform transparently by the gateway. 
-
-Data properties that are required, may depend on the environment you are conducting payment for. Our API aims to be
- flexible enough to cater for these structures. Our integration team will aid you in providing the necessary data to 
- transact. 
-
-```json
-{ 
-  "RequestChallenged": {
-    "acsurl": "https://bank.com/3DS/ACS",
-    "creq": "SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...",
-    "merchantid": 12345,
-    "transno": 1,
-    "threedserver_trans_id": "d652d8d2-d74a-4264-a051-a7862b10d5d6"
-  }               
-}
-```
- 
-## E-commerce workflows
- 
-For E-commerce transactions requiring 3DS, the API contains a fully accredited in built mechanism to handle authentication.
-
-The Api and gateway has been accredited extensively with both Acquirers and Card Schemes to simplify the nature of these calls
-into a simple structure for authentication, preventing integrators from performing lengthy and a costly accreditations with
-Visa and MasterCard.
-
-3D-secure has been around for a number of years and aims to shift the liability of a transaction away from a merchant back
-to the cardholder. A *liability shift* determines whether a card holder can charge back a transaction as unknown. Effectively
-the process asks for a card holder to authenticate the transaction prior to authorisation producing a Cardholder 
-verification value (CAVV) and ecommerce indicator (ECI) as evidence of authorisation.
-
-3DS version 1 has now been replaced by 3DS version 2 to provide secure customer authentication (SCA) in line with EU regulation.
-3DSv2 is being phased out and any accounts using version 1 of the protocol is expected to be migrated by March 2022. 
-
-Any new integrations should only consider 3DSv2 flows. 
-
-### 3DSv2
-
-```json
-{ 
-  "RequestChallenged": {
-    "acsurl": "https://bank.com/3DS/ACS",
-    "creq": "SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...",
-    "merchantid": 12345,
-    "transno": 1,
-    "threedserver_trans_id": "d652d8d2-d74a-4264-a051-a7862b10d5d6"
-  }               
-}
-```
-
-```xml
-<RequestChallenged>
-  <acsurl>https://bank.com/3DS/ACS</acsurl>
-  <creq>SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...</creq>
-  <merchantid>12345</merchantid>
-  <transno>1</transno>
-  <threedserver_trans_id>d652d8d2-d74a-4264-a051-a7862b10d5d6</threedserver_trans_id>
-</RequestChallenged>
-```
-
-CityPay support 3DS version 2.1 for Verified by Visa, MasterCard Identity Check and American Express SafeKey 2.1. Version
-2.2 is currently in development however this will be a seamless upgrade for all integrations.
-
-#### 3-D Secure - None
-
-![3DSv2 Frctionless Flow](images/3dsv2-no3d.png)
-
-A basic flow may involve no 3-D secure processing. This could happen if there is no ability to perform authentication.
-An enrollment check may apply an "attempted" resolution to processing. In this instance a transaction may not meet any
-liability shift. A transaction may result in a decline due to this. We are also able to prevent from transactions being
-presented for authorisation if this occurs. 
-
-#### 3-D Secure - Frictionless
-
-![3DSv2 Frctionless Flow](images/3dsv2-frictionless.png)
-
-E-commerce transactions supporting 3DSv2 can benefit from seamlessly authenticated transactions which may perform a 
-"frictionless" flow. This method will authenticate low risk transactions with minimal impact to a 
-standard authorisation flow. Our API simply performs this on behalf of you the developer, the merchant and cardholder.
-
-No redirection occurs and hence the flow is called frictionless and will appear as though a simple transaction 
-authorisation has occurred.
-
-#### 3-D Secure - Challenge
-
-![3DSv2 Frctionless Flow](images/3dsv2-challenge.png)
-
-A transaction that is deemed as higher risk my be "challenged". In this instance, the API will return a
-[request challenge](#requestchallenged) which will require your integration to forward the cardholder's browser to the 
-given [ACS url](#acsurl). This should be performed by posting the [creq](#creq) value (the challenge request value). 
-
-Once complete, the ACS will have already been in touch with our servers by sending us a result of the authentication
-known as `RReq`.
-
-To maintain session state, a parameter `threeDSSessionData` can be posted to the ACS url and will be returned alongside 
-the `CRes` value. This will ensure that any controller code will be able to isolate state between calls. This field
-is to be used by your own systems rather than ours and may be any value which can uniquely identify your cardholder's
-session. As an option, we do provide a `threedserver_trans_id` value in the `RequestChallenged` packet which can be used
-for the `threeDSSessionData` value as it is used to uniquely identify the 3D-Secure session. 
-
-A common method of maintaining state is to provide a session related query string value in the `merchant_termurl` value
-(also known as the `notificationUrl`). For example providing a url of `https://mystore.com/checkout?token=asny2348w4561..`
-could return the user directly back to their session with your environment.
-
-Once you have received a `cres` post from the ACS authentication service, this should be POSTed to the [cres](#cres) 
-endpoint to perform full authorisation processing. 
-
-Please note that the CRes returned to us is purely a mechanism of acknowledging that transactions should be committed for
-authorisation. The ACS by this point will have sent us the verification value (CAVV) to perform a liability shift. The CRes
-value will be validated for receipt of the CAVV and subsequently may return response codes illustrating this. 
-
-To forward the user to the ACS, we recommend a simple auto submit HTML form.
-
-> Simple auto submit HTML form
-
-```html
-<html lang="en">
-	<head>
-        <title>Forward to ACS</title>
-		<script type="text/javascript">
-        function onLoadEvent() { 
-            document.acs.submit(); 
-        }
-        </script>
-        <noscript>You will require JavaScript to be enabled to complete this transaction</noscript>
-    </head>
-    <body onload="onLoadEvent();">
-        <form name="acs" action="{{ACSURL from Response}}" method="POST">
-            <input type="hidden" name="creq" value="{{CReq Packet from Response}}" />
-            <input type="hidden" name="threeDSSessionData" value="{{session-identifier}}" />
-        </form>
-    </body>
-</html>
-```
-
-A full ACS test suite is available for 3DSv2 testing.
-        
-### Testing 3DSv2 Integrations
-
-The API provides a mock 3dsV2 handler which performs a number of scenarios based on the value of the CSC in the request.
-
-| CSC Value | Behaviour |
-|-----------|-----------|
-| 731       | Frictionless processing - Not authenticated |
-| 732       | Frictionless processing - Account verification count not be performed |        
-| 733       | Frictionless processing - Verification Rejected |        
-| 741       | Frictionless processing - Attempts Processing |        
-| 750       | Frictionless processing - Authenticated  |        
-| 761       | Triggers an error message |  
-| Any       | Challenge Request |       
-
-
-#### 3DSv1
-
-**Please note that 3DSv1 should now be considered as deprecated.**
-
-```json
-{ 
-  "AuthenticationRequired": {
-    "acsurl": "https://bank.com/3DS/ACS",
-    "pareq": "SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...",
-    "md": "WQgZXZlcnl0aGluZyBiZW"
-  }               
-}
-```
-
-```xml
-<AuthenticationRequired>
- <acsurl>https://bank.com/3DS/ACS</acsurl>
- <pareq>SXQgd2FzIHRoZSBiZXN0IG9mIHRpbWVzLCBpdCB3YXMgdGhlIHdvcnN00...</pareq>
- <md>WQgZXZlcnl0aGluZyBiZW</md>
-</AuthenticationRequired>
-```
-
-For E-commerce transactions requiring 3DSv1, the API contains a built in MPI which will be called to check whether the
-card is participating in 3DSv1 with Verified by Visa or MasterCard SecureCode. We only support Amex SafeKey with 3DSv2. Should the card be enrolled, a payer
-request (PAReq) value will be created and returned back as an [authentication required](#authenticationrequired) response object.
-
-Your system will need to process this authentication packet and forward the user's browser to an authentication server (ACS)
-to gain the user's authentication. Once complete, the ACS will produce a HTTP `POST` call back to the URL supplied in
-the authentication request as `merchant_termurl`. This URL should behave as a controller and handle the post data from the
-ACS and on a forked server to server HTTP request, forward this data to the [pares authentication url](#pares) for
-subsequent authorisation processing. You may prefer to provide a processing page whilst this is being processed.
-Processing with our systems should be relatively quick and be between 500ms - 3000ms however it is desirable to let
-the user see that something is happening rather than a pending browser.
-
-The main reason for ensuring that this controller is two fold:
-
-1. We are never in control of the user's browser in a server API call
-2. The controller is actioned on your site to ensure that any post actions from authorisation can be executed in real time
-
-To forward the user to the ACS, we recommend a simple auto submit HTML form.
-
-> Simple auto submit HTML form
-
-```html
-<html lang="en">
-	<head>
-        <title>Forward to ACS</title>
-		<script type="text/javascript">
-        function onLoadEvent() { 
-            document.acs.submit(); 
-        }
-        </script>
-        <noscript>You will require JavaScript to be enabled to complete this transaction</noscript>
-    </head>
-    <body onload="onLoadEvent();">
-        <form name="acs" action="{{ACSURL from Response}}" method="POST">
-            <input type="hidden" name="PaReq" value="{{PaReq Packet from Response}}" />
-            <input type="hidden" name="TermUrl" value="{{Your Controller}}" />
-            <input type="hidden" name="MD" value="{{MD From Response}}" />
-        </form>
-    </body>
-</html>
-```
-
-Please note that 3DSv1 is being phased out due to changes to strong customer authentication mechanisms. 3DSv2 addresses
-this and will solidify the authorisation and confirmation process.
-
-We provide a Test ACS for full 3DSv1 integration testing that simulates an ACS.
-
+Performs a request for authorisation for a card payment request.
 
 ### Examples
 
@@ -261,7 +34,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
-auth_request = CityPayApiClient::AuthRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest | 
+auth_request = CityPayApiClient::AuthRequest.new({amount: 19995, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest | 
 
 begin
   # Authorisation
@@ -549,6 +322,77 @@ end
 - **Accept**: application/json, text/xml
 
 
+## create_payment_intent
+
+> <PaymentIntentReference> create_payment_intent(payment_intent)
+
+Create a Payment Intent
+
+This endpoint initiates the creation of a payment intent, which is a precursor to processing a payment. A payment intent
+captures the details of a prospective payment transaction, including the payment amount, currency, and associated
+billing and shipping information.
+
+
+### Examples
+
+```ruby
+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
+end
+
+api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
+payment_intent = CityPayApiClient::PaymentIntent.new({amount: 19995, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95'}) # PaymentIntent | 
+
+begin
+  # Create a Payment Intent
+  result = api_instance.create_payment_intent(payment_intent)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling AuthorisationAndPaymentApi->create_payment_intent: #{e}"
+end
+```
+
+#### Using the create_payment_intent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentIntentReference>, Integer, Hash)> create_payment_intent_with_http_info(payment_intent)
+
+```ruby
+begin
+  # Create a Payment Intent
+  data, status_code, headers = api_instance.create_payment_intent_with_http_info(payment_intent)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentIntentReference>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling AuthorisationAndPaymentApi->create_payment_intent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_intent** | [**PaymentIntent**](PaymentIntent.md) |  |  |
+
+### Return type
+
+[**PaymentIntentReference**](PaymentIntentReference.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
 ## pa_res_request
 
 > <AuthResponse> pa_res_request(pa_res_auth_request)
@@ -646,7 +490,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
-refund_request = CityPayApiClient::RefundRequest.new({amount: 3600, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, refund_ref: 8322}) # RefundRequest | 
+refund_request = CityPayApiClient::RefundRequest.new({amount: 19995, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, refund_ref: 8322}) # RefundRequest | 
 
 begin
   # Refund

data/docs/Batch.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **batch_date** | **Date** | The date that the file was created in ISO-8601 format. |  |
 | **batch_id** | **Integer** | The batch id requested. | [optional] |
-| **batch_status** | **String** | The status of the batch. Possible values are - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
+| **batch_status** | **String** | The status of the batch. Possible values are:    - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
 
 ## Example
 

data/docs/BatchProcessingApi.md

@@ -5,8 +5,8 @@ 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_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 |
+| [**batch_retrieve_request**](BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | Batch Retrieve Request |
+| [**check_batch_status_request**](BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | Check Batch Status |
 
 
 ## batch_process_request
@@ -32,7 +32,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::BatchProcessingApi.new
-process_batch_request = CityPayApiClient::ProcessBatchRequest.new({batch_date: Date.parse('Thu Jan 02 00:00:00 UTC 2020'), batch_id: 35, transactions: [CityPayApiClient::BatchTransaction.new({account_id: 'aaabbb-cccddd-eee', amount: 3600})]}) # ProcessBatchRequest | 
+process_batch_request = CityPayApiClient::ProcessBatchRequest.new({batch_date: Date.parse('Thu Jan 02 00:00:00 UTC 2020'), batch_id: 35, transactions: [CityPayApiClient::BatchTransaction.new({account_id: 'aaabbb-cccddd-eee', amount: 19995})]}) # ProcessBatchRequest | 
 
 begin
   # Batch Process Request
@@ -85,9 +85,9 @@ end
 
 > <BatchReportResponseModel> batch_retrieve_request(batch_report_request)
 
-BatchReportRequest
+Batch Retrieve Request
 
-The report for a given batch.
+Obtains a batch and installment (BIS) report for a given batch id.
 
 ### Examples
 
@@ -103,7 +103,7 @@ api_instance = CityPayApiClient::BatchProcessingApi.new
 batch_report_request = CityPayApiClient::BatchReportRequest.new({batch_id: 35}) # BatchReportRequest | 
 
 begin
-  # BatchReportRequest
+  # Batch Retrieve Request
   result = api_instance.batch_retrieve_request(batch_report_request)
   p result
 rescue CityPayApiClient::ApiError => e
@@ -119,7 +119,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # BatchReportRequest
+  # Batch Retrieve Request
   data, status_code, headers = api_instance.batch_retrieve_request_with_http_info(batch_report_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -153,7 +153,7 @@ end
 
 > <CheckBatchStatusResponse> check_batch_status_request(check_batch_status)
 
-CheckBatchStatus
+Check Batch Status
 
 The operation is used to retrieve the status of a batch process.
 
@@ -168,10 +168,10 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::BatchProcessingApi.new
-check_batch_status = CityPayApiClient::CheckBatchStatus.new({batch_id: [78]}) # CheckBatchStatus | 
+check_batch_status = CityPayApiClient::CheckBatchStatus.new({batch_id: [37]}) # CheckBatchStatus | 
 
 begin
-  # CheckBatchStatus
+  # Check Batch Status
   result = api_instance.check_batch_status_request(check_batch_status)
   p result
 rescue CityPayApiClient::ApiError => e
@@ -187,7 +187,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # CheckBatchStatus
+  # Check Batch Status
   data, status_code, headers = api_instance.check_batch_status_request_with_http_info(check_batch_status)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/BatchReportResponseModel.md

@@ -7,7 +7,7 @@
 | **amount** | **Integer** | The total amount that the batch contains. |  |
 | **batch_date** | **Date** | The date and time of the batch in ISO-8601 format. |  |
 | **batch_id** | **Integer** | The batch id specified in the batch processing request. |  |
-| **batch_status** | **String** | The status of the batch. Possible values are - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
+| **batch_status** | **String** | The status of the batch. Possible values are:   - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
 | **client_account_id** | **String** | The batch account id that the batch was processed with. |  |
 | **transactions** | [**Array<BatchTransactionResultModel>**](BatchTransactionResultModel.md) |  |  |
 
@@ -17,7 +17,7 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::BatchReportResponseModel.new(
-  amount: 3600,
+  amount: 19995,
   batch_date: Thu Jan 02 00:00:00 UTC 2020,
   batch_id: 35,
   batch_status: COMPLETE,

data/docs/BatchTransaction.md

@@ -16,7 +16,7 @@ require 'citypay_api_client'
 
 instance = CityPayApiClient::BatchTransaction.new(
   account_id: aaabbb-cccddd-eee,
-  amount: 3600,
+  amount: 19995,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   merchantid: 11223344
 )

data/docs/BatchTransactionReportRequest.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::BatchTransactionReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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::BatchTransactionReportRequest.new(
+  max_results: 50,
+  next_token: n34liuwn435tUAGFNg34yn...,
+  order_by: date
+)
+```
+

data/docs/BatchTransactionReportResponse.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::BatchTransactionReportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | The count of items returned in this page. | [optional] |
+| **data** | [**Array<AuthReference>**](AuthReference.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::BatchTransactionReportResponse.new(
+  count: 25,
+  data: null,
+  max_results: 50,
+  next_token: n34liuwn435tUAGFNg34yn...
+)
+```
+

data/docs/BatchTransactionResultModel.md

@@ -26,7 +26,7 @@ require 'citypay_api_client'
 
 instance = CityPayApiClient::BatchTransactionResultModel.new(
   account_id: aaabbb-cccddd-eee,
-  amount: 3600,
+  amount: 19995,
   authcode: 001245A,
   datetime: 2020-01-02T18:32:28Z,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,

data/docs/Bin.md

@@ -22,9 +22,9 @@ require 'citypay_api_client'
 instance = CityPayApiClient::Bin.new(
   bin_commercial: null,
   bin_corporate: null,
-  bin_country_issued: null,
+  bin_country_issued: GB,
   bin_credit: null,
-  bin_currency: null,
+  bin_currency: GBP,
   bin_debit: null,
   bin_description: Platinum Card,
   bin_eu: null,

data/docs/CaptureRequest.md

@@ -18,7 +18,7 @@ require 'citypay_api_client'
 
 instance = CityPayApiClient::CaptureRequest.new(
   airline_data: null,
-  amount: 3600,
+  amount: 19995,
   event_management: null,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   merchantid: 11223344,

data/docs/Card.md

@@ -33,9 +33,9 @@ require 'citypay_api_client'
 instance = CityPayApiClient::Card.new(
   bin_commercial: null,
   bin_corporate: null,
-  bin_country_issued: null,
+  bin_country_issued: GB,
   bin_credit: null,
-  bin_currency: null,
+  bin_currency: GBP,
   bin_debit: null,
   bin_description: Platinum Card,
   bin_eu: null,

data/docs/CardHolderAccountApi.md

@@ -18,7 +18,7 @@ All URIs are relative to *https://api.citypay.com*
 
 ## account_card_delete_request
 
-> <Acknowledgement> account_card_delete_request(accountid, card_id)
+> <Acknowledgement> account_card_delete_request(accountid, card_id, opts)
 
 Card Deletion
 
@@ -39,10 +39,13 @@ 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.
 card_id = 'card_id_example' # String | The id of the card that is presented by a call to retrieve a card holder account.
+opts = {
+  force: true # Boolean | Requests that the item is forced immediately.
+}
 
 begin
   # Card Deletion
-  result = api_instance.account_card_delete_request(accountid, card_id)
+  result = api_instance.account_card_delete_request(accountid, card_id, opts)
   p result
 rescue CityPayApiClient::ApiError => e
   puts "Error when calling CardHolderAccountApi->account_card_delete_request: #{e}"
@@ -53,12 +56,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Acknowledgement>, Integer, Hash)> account_card_delete_request_with_http_info(accountid, card_id)
+> <Array(<Acknowledgement>, Integer, Hash)> account_card_delete_request_with_http_info(accountid, card_id, opts)
 
 ```ruby
 begin
   # Card Deletion
-  data, status_code, headers = api_instance.account_card_delete_request_with_http_info(accountid, card_id)
+  data, status_code, headers = api_instance.account_card_delete_request_with_http_info(accountid, card_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Acknowledgement>
@@ -73,6 +76,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **accountid** | **String** | The account id that refers to the customer&#39;s account no. This value will have been provided when setting up the card holder account. |  |
 | **card_id** | **String** | The id of the card that is presented by a call to retrieve a card holder account. |  |
+| **force** | **Boolean** | Requests that the item is forced immediately. | [optional] |
 
 ### Return type
 
@@ -714,7 +718,7 @@ CityPayApiClient.configure do |config|
 end
 
 api_instance = CityPayApiClient::CardHolderAccountApi.new
-charge_request = CityPayApiClient::ChargeRequest.new({amount: 3600, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, token: 'ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr'}) # ChargeRequest | 
+charge_request = CityPayApiClient::ChargeRequest.new({amount: 19995, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344, token: 'ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr'}) # ChargeRequest | 
 
 begin
   # Charge