citypay_api_client 1.1.2 → 1.1.3

data/docs/PaylinkTokenStatusChangeRequest.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **after** | **Time** | identifies the date and time to lookup changes after. |  |
-| **max_results** | **Integer** | the maximum number of results between 5 and 250 to return. Default is 50. | [optional] |
+| **max_results** | **Integer** | The maximum number of results to return in a single response. This value is used to limit the size of data returned by the API, enhancing performance and manageability. Values should be between 5 and 250. | [optional] |
 | **merchantid** | **Integer** | the merchant id to review tokens for. |  |
-| **next_token** | **String** | the next token value when more results are available. | [optional] |
-| **order_by** | **Array<String>** |  | [optional] |
+| **next_token** | **String** | A token that identifies the starting point of the page of results to be returned. An empty value indicates the start of the dataset. When supplied, it is validated and used to fetch the subsequent page of results. This token is typically obtained from the response of a previous pagination request. | [optional] |
+| **order_by** | **String** | Specifies the field by which results are ordered. Available fields are [p.id]. By default, fields are ordered by OrderByExpression(p.id,ASC). To order in descending order, prefix with '-' or suffix with ' DESC'. | [optional] |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkTokenStatusChangeRequest.new(
-  after: null,
-  max_results: null,
+  after: 2024-04-22T13:29:14Z,
+  max_results: 50,
   merchantid: 11223344,
-  next_token: null,
-  order_by: null
+  next_token: n34liuwn435tUAGFNg34yn...,
+  order_by: date
 )
 ```
 

data/docs/PaylinkTokenStatusChangeResponse.md

@@ -4,7 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **next_token** | **String** | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.  | [optional] |
+| **count** | **Integer** | The count of items returned in this page. | [optional] |
+| **max_results** | **Integer** | The max results requested in this page. | [optional] |
+| **next_token** | **String** | A token that identifies the starting point of the page of results to be returned. An empty value indicates the start of the dataset. When supplied, it is validated and used to fetch the subsequent page of results. This token is typically obtained from the response of a previous pagination request. | [optional] |
 | **tokens** | [**Array<PaylinkTokenStatus>**](PaylinkTokenStatus.md) |  |  |
 
 ## Example
@@ -13,7 +15,9 @@
 require 'citypay_api_client'
 
 instance = CityPayApiClient::PaylinkTokenStatusChangeResponse.new(
-  next_token: null,
+  count: 25,
+  max_results: 50,
+  next_token: n34liuwn435tUAGFNg34yn...,
   tokens: null
 )
 ```

data/docs/PaymentIntent.md

@@ -0,0 +1,42 @@
+# CityPayApiClient::PaymentIntent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195.  |  |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
+| **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
+| **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **Array<String>** |  | [optional] |
+| **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
+| **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntent.new(
+  amount: 19995,
+  avs_postcode_policy: null,
+  bill_to: null,
+  csc: 10,
+  csc_policy: null,
+  currency: GBP,
+  duplicate_policy: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  match_avsa: null,
+  ship_to: null,
+  tag: null,
+  trans_info: null,
+  trans_type: null
+)
+```
+

data/docs/PaymentIntentReference.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::PaymentIntentReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_intent_id** | **String** | The intent id used for future referencing of the intent. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaymentIntentReference.new(
+  payment_intent_id: p13t1111222233334444
+)
+```
+

data/docs/RefundRequest.md

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

data/docs/RemittanceData.md

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

data/docs/RemittanceReportRequest.md

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

data/docs/RemittanceReportResponse.md

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

data/docs/RemittedClientData.md

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

data/docs/ReportingApi.md

@@ -0,0 +1,378 @@
+# CityPayApiClient::ReportingApi
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**batched_transaction_report_request**](ReportingApi.md#batched_transaction_report_request) | **POST** /v6/merchant-batch/{merchantid}/{batch_no}/transactions | Batch Transaction Report Request |
+| [**merchant_batch_report_request**](ReportingApi.md#merchant_batch_report_request) | **POST** /v6/merchant-batch/report | Merchant Batch Report Request |
+| [**merchant_batch_request**](ReportingApi.md#merchant_batch_request) | **GET** /v6/merchant-batch/{merchantid}/{batch_no} | Merchant Batch Request |
+| [**remittance_range_report**](ReportingApi.md#remittance_range_report) | **POST** /v6/remittance/report/{clientid} | Remittance Report Request |
+| [**remittance_report_request**](ReportingApi.md#remittance_report_request) | **GET** /v6/remittance/report/{clientid}/{date} | Remittance Date Report Request |
+
+
+## batched_transaction_report_request
+
+> <BatchTransactionReportResponse> batched_transaction_report_request(merchantid, batch_no, batch_transaction_report_request)
+
+Batch Transaction Report Request
+
+Retrieves transactions available on a given batch.
+
+### 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::ReportingApi.new
+merchantid = 56 # Integer | A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
+batch_no = 'batch_no_example' # String | The batch number that is being requested.
+batch_transaction_report_request = CityPayApiClient::BatchTransactionReportRequest.new # BatchTransactionReportRequest | 
+
+begin
+  # Batch Transaction Report Request
+  result = api_instance.batched_transaction_report_request(merchantid, batch_no, batch_transaction_report_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->batched_transaction_report_request: #{e}"
+end
+```
+
+#### Using the batched_transaction_report_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BatchTransactionReportResponse>, Integer, Hash)> batched_transaction_report_request_with_http_info(merchantid, batch_no, batch_transaction_report_request)
+
+```ruby
+begin
+  # Batch Transaction Report Request
+  data, status_code, headers = api_instance.batched_transaction_report_request_with_http_info(merchantid, batch_no, batch_transaction_report_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BatchTransactionReportResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->batched_transaction_report_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchantid** | **Integer** | A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account. |  |
+| **batch_no** | **String** | The batch number that is being requested. |  |
+| **batch_transaction_report_request** | [**BatchTransactionReportRequest**](BatchTransactionReportRequest.md) |  |  |
+
+### Return type
+
+[**BatchTransactionReportResponse**](BatchTransactionReportResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## merchant_batch_report_request
+
+> <MerchantBatchReportResponse> merchant_batch_report_request(merchant_batch_report_request)
+
+Merchant Batch Report Request
+
+Retrieves a report of merchant batches within a specified date range. 
+Batches, which aggregate daily processing activities, are typically generated at `00:00` each day. 
+These batches play a crucial role in the settlement of funds by summarising daily transactions.
+
+
+### 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::ReportingApi.new
+merchant_batch_report_request = CityPayApiClient::MerchantBatchReportRequest.new # MerchantBatchReportRequest | 
+
+begin
+  # Merchant Batch Report Request
+  result = api_instance.merchant_batch_report_request(merchant_batch_report_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->merchant_batch_report_request: #{e}"
+end
+```
+
+#### Using the merchant_batch_report_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MerchantBatchReportResponse>, Integer, Hash)> merchant_batch_report_request_with_http_info(merchant_batch_report_request)
+
+```ruby
+begin
+  # Merchant Batch Report Request
+  data, status_code, headers = api_instance.merchant_batch_report_request_with_http_info(merchant_batch_report_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MerchantBatchReportResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->merchant_batch_report_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_batch_report_request** | [**MerchantBatchReportRequest**](MerchantBatchReportRequest.md) |  |  |
+
+### Return type
+
+[**MerchantBatchReportResponse**](MerchantBatchReportResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## merchant_batch_request
+
+> <MerchantBatchResponse> merchant_batch_request(merchantid, batch_no)
+
+Merchant Batch Request
+
+Retrieves a report of merchant a merchant batch for a specified batch number.
+
+### 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::ReportingApi.new
+merchantid = 56 # Integer | A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
+batch_no = 'batch_no_example' # String | The batch number that is being requested.
+
+begin
+  # Merchant Batch Request
+  result = api_instance.merchant_batch_request(merchantid, batch_no)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->merchant_batch_request: #{e}"
+end
+```
+
+#### Using the merchant_batch_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MerchantBatchResponse>, Integer, Hash)> merchant_batch_request_with_http_info(merchantid, batch_no)
+
+```ruby
+begin
+  # Merchant Batch Request
+  data, status_code, headers = api_instance.merchant_batch_request_with_http_info(merchantid, batch_no)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MerchantBatchResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->merchant_batch_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchantid** | **Integer** | A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account. |  |
+| **batch_no** | **String** | The batch number that is being requested. |  |
+
+### Return type
+
+[**MerchantBatchResponse**](MerchantBatchResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## remittance_range_report
+
+> <RemittanceReportResponse> remittance_range_report(clientid, remittance_report_request)
+
+Remittance Report Request
+
+Fetches remittance reports for financial transactions within a specified date range,
+covering all client-related activities. This report consolidates all batches disbursed to a
+client, with each remittance summarising the aggregation of batches leading up to settlement.
+Additionally, the net remittance amount presented in the final settlement will reflect any
+deductions made by the acquirer.
+
+
+### 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::ReportingApi.new
+clientid = 'clientid_example' # String | A client Id for which data is requested.
+remittance_report_request = CityPayApiClient::RemittanceReportRequest.new # RemittanceReportRequest | 
+
+begin
+  # Remittance Report Request
+  result = api_instance.remittance_range_report(clientid, remittance_report_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->remittance_range_report: #{e}"
+end
+```
+
+#### Using the remittance_range_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemittanceReportResponse>, Integer, Hash)> remittance_range_report_with_http_info(clientid, remittance_report_request)
+
+```ruby
+begin
+  # Remittance Report Request
+  data, status_code, headers = api_instance.remittance_range_report_with_http_info(clientid, remittance_report_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemittanceReportResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->remittance_range_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clientid** | **String** | A client Id for which data is requested. |  |
+| **remittance_report_request** | [**RemittanceReportRequest**](RemittanceReportRequest.md) |  |  |
+
+### Return type
+
+[**RemittanceReportResponse**](RemittanceReportResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## remittance_report_request
+
+> <RemittedClientData> remittance_report_request(clientid, date)
+
+Remittance Date Report Request
+
+Fetches remittance reports for financial transactions for a given date, 
+covering all client-related activities. This report consolidates all batches disbursed to a 
+client, with each remittance summarising the aggregation of batches leading up to settlement. 
+Additionally, the net remittance amount presented in the final settlement will reflect any 
+deductions made by the acquirer.
+
+The process also supports the notion of *today* deferring the date to today's date or *latest* reflecting the
+latest remittance date available.
+
+
+### 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::ReportingApi.new
+clientid = 'clientid_example' # String | A client Id for which data is requested.
+date = 'date_example' # String | Date (YYYY-MM-DD) to filter the request for.
+
+begin
+  # Remittance Date Report Request
+  result = api_instance.remittance_report_request(clientid, date)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->remittance_report_request: #{e}"
+end
+```
+
+#### Using the remittance_report_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemittedClientData>, Integer, Hash)> remittance_report_request_with_http_info(clientid, date)
+
+```ruby
+begin
+  # Remittance Date Report Request
+  data, status_code, headers = api_instance.remittance_report_request_with_http_info(clientid, date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemittedClientData>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling ReportingApi->remittance_report_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clientid** | **String** | A client Id for which data is requested. |  |
+| **date** | **String** | Date (YYYY-MM-DD) to filter the request for. |  |
+
+### Return type
+
+[**RemittedClientData**](RemittedClientData.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+

data/docs/TokenisationResponseModel.md

@@ -25,7 +25,7 @@ instance = CityPayApiClient::TokenisationResponseModel.new(
   bin_commercial: null,
   bin_debit: null,
   bin_description: Platinum Card,
-  eci: null,
+  eci: 5,
   identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
   maskedpan: 4***********0002,
   scheme: Visa,