citypay_api_client 1.1.1 → 1.1.3

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/ThreeDSecure.md

@@ -11,7 +11,7 @@
 | **browser_language** | **String** | BrowserLanguage field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **browser_screen_height** | **String** | BrowserScreenHeight field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **browser_screen_width** | **String** | BrowserScreenWidth field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
-| **browser_tz** | **String** | BrowserTZ field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
+| **browser_tz** | **String** | BrowserTZ offset field used for 3DSv2 browser enablement. Recommendation is to use citypay.js and the `bx` function to gather this value. | [optional] |
 | **cp_bx** | **String** | Required for 3DSv2.  Browser extension value produced by the citypay.js `bx` function. See [https://sandbox.citypay.com/3dsv2/bx](https://sandbox.citypay.com/3dsv2/bx) for  details.  | [optional] |
 | **downgrade1** | **Boolean** | Where a merchant is configured for 3DSv2, setting this option will attempt to downgrade the transaction to  3DSv1.  | [optional] |
 | **merchant_termurl** | **String** | A controller URL for 3D-Secure processing that any response from an authentication request or challenge request should be sent to.  The controller should forward on the response from the URL back via this API for subsequent processing.  | [optional] |

data/docs/TokenisationResponseModel.md

@@ -11,9 +11,9 @@
 | **eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.  | [optional] |
 | **identifier** | **String** | The identifier provided within the request. | [optional] |
 | **maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] |
-| **scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
 | **sig_id** | **String** | A Base58 encoded SHA-256 digest generated from the token value Base58 decoded and appended with the nonce value UTF-8 decoded. | [optional] |
-| **token** | **String** | The token used for presentment to authorisation later in the procsesing flow. | [optional] |
+| **token** | **String** | The token used for presentment to authorisation later in the processing flow. | [optional] |
 
 ## Example
 
@@ -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,

data/docs/images/citypay-logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 520.89 113.5"><defs><style>.cls-1{fill:#003b71;}.cls-2{fill:#d7c724;}</style></defs><title>citypay-logo</title><g id="Layer_2" data-name="Layer 2"><g id="Standard"><path class="cls-1" d="M139,27a45.23,45.23,0,0,1,18.67,4L156.33,44.7a39.52,39.52,0,0,0-15.57-3.22c-10.82,0-19.11,5.56-19.11,16.26,0,10.14,7.85,16.44,18.61,16.44a37.32,37.32,0,0,0,16.32-3.89l1.86,14.09a44.68,44.68,0,0,1-19.23,4.39c-19.54,0-33.44-12.61-33.44-31C105.77,38.51,119.86,27,139,27Z"/><path class="cls-2" d="M168.15,9.15a9.12,9.12,0,1,1,18.24,0,9.12,9.12,0,0,1-18.24,0Z"/><rect class="cls-1" x="169.33" y="28.19" width="15.89" height="59.35"/><path class="cls-1" d="M220.58,41.36V65.78c0,6.18,3.46,8.9,8.78,8.9a40.29,40.29,0,0,0,10.07-1.42l1.49,13.16a44.2,44.2,0,0,1-14.35,2.35c-13,0-21.82-6.74-21.82-20.71V41.36h-10V28.19h10.07v-19h15.4v19h17.18V41.36Z"/><path class="cls-1" d="M292.17,28.19h17.62l-28,67.45C277,107,269.73,113.5,257,113.5a25.67,25.67,0,0,1-11.32-2.6l2-12.73a20,20,0,0,0,7.48,1.55c6.62,0,11.32-4.64,13.17-12.12L243.77,28.19h17.55L276.84,71.4Z"/><path class="cls-1" d="M378,58.11c0,17.93-11.93,30.66-28.74,30.66-8.72,0-15.33-3-19.29-7.48v31H314.13V28.19H329.4l.31,7.17c3.9-4.94,10-8.41,19.54-8.41C366.06,27,378,40.06,378,58.11ZM346,74.55c9.4,0,16.08-7.1,16.08-16.5,0-9.58-6.62-16.88-16.08-16.88S329.9,48.59,329.9,58.05,336.7,74.55,346,74.55Z"/><path class="cls-1" d="M384.35,57.74c0-18,12.3-30.79,28.62-30.79,9.21,0,15.45,3.53,19.35,8.41l.31-7.17h15.51V87.54H432.63l-.31-7.17c-3.9,4.94-10.14,8.4-19.35,8.4C396.65,88.77,384.35,75.73,384.35,57.74Zm31.71-16.63c-9.52,0-15.95,7.17-15.95,16.63s6.43,16.94,15.95,16.94,16.2-7.42,16.2-16.94S425.52,41.11,416.06,41.11Z"/><path class="cls-1" d="M503.27,28.19h17.62l-28,67.45c-4.76,11.37-12.05,17.86-24.79,17.86a25.62,25.62,0,0,1-11.31-2.6l2-12.73a20,20,0,0,0,7.48,1.55c6.61,0,11.31-4.64,13.17-12.12L454.86,28.19h17.56L487.94,71.4Z"/><path class="cls-2" d="M51.29,80l1.32-.26a30.92,30.92,0,0,0,0-60.65l-1.32-.27v-16l1.87.27A46.84,46.84,0,0,1,93.53,49.4a46.37,46.37,0,0,1-8.21,26.41A47.05,47.05,0,0,1,64.79,92.52L54.33,108.71l-3,4.79Z"/><path class="cls-1" d="M40.28,95.68C17.31,92.3,0,72.41,0,49.4A47.13,47.13,0,0,1,40.16,3.13l2.28-.25v16l-1.63.25a30.87,30.87,0,0,0-.07,60.57l1.7.24v16Z"/><path class="cls-1" d="M46.55,69.05C35.24,69.05,26,60.27,26,49.47S35.24,29.9,46.55,29.9s20.52,8.78,20.52,19.57S57.87,69.05,46.55,69.05Z"/></g></g></svg>