citypay_api_client 1.1.2 → 1.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +73 -0
- data/README.md +59 -32
- data/citypay_api_client.gemspec +1 -1
- data/docs/Acknowledgement.md +2 -2
- data/docs/AclCheckResponseModel.md +3 -3
- data/docs/AuthRequest.md +7 -7
- data/docs/AuthResponse.md +4 -4
- data/docs/AuthorisationAndPaymentApi.md +75 -231
- data/docs/Batch.md +1 -1
- data/docs/BatchProcessingApi.md +11 -11
- data/docs/BatchReportResponseModel.md +2 -2
- data/docs/BatchTransaction.md +1 -1
- data/docs/BatchTransactionReportRequest.md +22 -0
- data/docs/BatchTransactionReportResponse.md +24 -0
- data/docs/BatchTransactionResultModel.md +1 -1
- data/docs/Bin.md +2 -2
- data/docs/CaptureRequest.md +1 -1
- data/docs/Card.md +2 -2
- data/docs/CardHolderAccountApi.md +9 -5
- data/docs/ChargeRequest.md +7 -7
- data/docs/Decision.md +0 -2
- data/docs/DirectPostApi.md +2 -16
- data/docs/DirectPostRequest.md +7 -7
- data/docs/EventDataModel.md +2 -2
- data/docs/MerchantBatchReportRequest.md +28 -0
- data/docs/MerchantBatchReportResponse.md +24 -0
- data/docs/MerchantBatchResponse.md +30 -0
- data/docs/NetSummaryResponse.md +32 -0
- data/docs/PaylinkAdjustmentRequest.md +1 -1
- data/docs/PaylinkApi.md +141 -1
- data/docs/PaylinkBillPaymentTokenRequest.md +1 -1
- data/docs/PaylinkErrorCode.md +2 -2
- data/docs/PaylinkResendNotificationRequest.md +20 -0
- data/docs/PaylinkStateEvent.md +4 -4
- data/docs/PaylinkTokenCreated.md +11 -11
- data/docs/PaylinkTokenStatus.md +7 -7
- data/docs/PaylinkTokenStatusChangeRequest.md +7 -7
- data/docs/PaylinkTokenStatusChangeResponse.md +6 -2
- data/docs/PaymentIntent.md +42 -0
- data/docs/PaymentIntentReference.md +18 -0
- data/docs/RefundRequest.md +1 -1
- data/docs/RemittanceData.md +28 -0
- data/docs/RemittanceReportRequest.md +28 -0
- data/docs/RemittanceReportResponse.md +24 -0
- data/docs/RemittedClientData.md +44 -0
- data/docs/ReportingApi.md +378 -0
- data/docs/TokenisationResponseModel.md +1 -1
- data/lib/.DS_Store +0 -0
- data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +71 -3
- data/lib/citypay_api_client/api/batch_processing_api__.rb +7 -7
- data/lib/citypay_api_client/api/card_holder_account_api__.rb +4 -1
- data/lib/citypay_api_client/api/direct_post_api__.rb +5 -5
- data/lib/citypay_api_client/api/operational_functions_api__.rb +1 -1
- data/lib/citypay_api_client/api/paylink_api__.rb +138 -1
- data/lib/citypay_api_client/api/reporting_api__.rb +381 -0
- data/lib/citypay_api_client/api_client.rb +1 -1
- data/lib/citypay_api_client/api_error.rb +1 -1
- data/lib/citypay_api_client/configuration.rb +1 -1
- data/lib/citypay_api_client/models/account_create.rb +1 -1
- data/lib/citypay_api_client/models/account_status.rb +1 -1
- data/lib/citypay_api_client/models/acknowledgement.rb +1 -29
- data/lib/citypay_api_client/models/acl_check_request.rb +1 -1
- data/lib/citypay_api_client/models/acl_check_response_model.rb +2 -2
- data/lib/citypay_api_client/models/airline_advice.rb +1 -1
- data/lib/citypay_api_client/models/airline_segment.rb +1 -1
- data/lib/citypay_api_client/models/auth_reference.rb +1 -1
- data/lib/citypay_api_client/models/auth_references.rb +1 -1
- data/lib/citypay_api_client/models/auth_request.rb +10 -9
- data/lib/citypay_api_client/models/auth_response.rb +2 -2
- data/lib/citypay_api_client/models/batch.rb +2 -2
- data/lib/citypay_api_client/models/batch_report_request.rb +1 -1
- data/lib/citypay_api_client/models/batch_report_response_model.rb +2 -2
- data/lib/citypay_api_client/models/batch_transaction.rb +1 -1
- data/lib/citypay_api_client/models/batch_transaction_report_request.rb +234 -0
- data/lib/citypay_api_client/models/batch_transaction_report_response.rb +252 -0
- data/lib/citypay_api_client/models/batch_transaction_result_model.rb +1 -1
- data/lib/citypay_api_client/models/bin.rb +1 -1
- data/lib/citypay_api_client/models/bin_lookup.rb +1 -1
- data/lib/citypay_api_client/models/c_res_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/capture_request.rb +1 -1
- data/lib/citypay_api_client/models/card.rb +1 -1
- data/lib/citypay_api_client/models/card_holder_account.rb +1 -1
- data/lib/citypay_api_client/models/card_status.rb +1 -1
- data/lib/citypay_api_client/models/charge_request.rb +10 -9
- data/lib/citypay_api_client/models/check_batch_status.rb +1 -1
- data/lib/citypay_api_client/models/check_batch_status_response.rb +1 -1
- data/lib/citypay_api_client/models/contact_details.rb +1 -1
- data/lib/citypay_api_client/models/decision.rb +2 -11
- data/lib/citypay_api_client/models/direct_post_request.rb +10 -9
- data/lib/citypay_api_client/models/direct_token_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_check_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_response.rb +1 -1
- data/lib/citypay_api_client/models/error.rb +1 -1
- data/lib/citypay_api_client/models/event_data_model.rb +1 -1
- data/lib/citypay_api_client/models/exists.rb +1 -1
- data/lib/citypay_api_client/models/external_mpi.rb +1 -1
- data/lib/citypay_api_client/models/list_merchants_response.rb +1 -1
- data/lib/citypay_api_client/models/mcc6012.rb +1 -1
- data/lib/citypay_api_client/models/merchant.rb +1 -1
- data/lib/citypay_api_client/models/merchant_batch_report_request.rb +265 -0
- data/lib/citypay_api_client/models/merchant_batch_report_response.rb +252 -0
- data/lib/citypay_api_client/models/merchant_batch_response.rb +301 -0
- data/lib/citypay_api_client/models/net_summary_response.rb +472 -0
- data/lib/citypay_api_client/models/pa_res_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_address.rb +1 -1
- data/lib/citypay_api_client/models/paylink_adjustment_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_attachment_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_attachment_result.rb +1 -1
- data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_card_holder.rb +1 -1
- data/lib/citypay_api_client/models/paylink_cart.rb +1 -1
- data/lib/citypay_api_client/models/paylink_cart_item_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_config.rb +1 -1
- data/lib/citypay_api_client/models/paylink_custom_param.rb +1 -1
- data/lib/citypay_api_client/models/paylink_email_notification_path.rb +1 -1
- data/lib/citypay_api_client/models/paylink_error_code.rb +1 -1
- data/lib/citypay_api_client/models/paylink_field_guard_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_part_payments.rb +1 -1
- data/lib/citypay_api_client/models/paylink_resend_notification_request.rb +224 -0
- data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +1 -1
- data/lib/citypay_api_client/models/paylink_state_event.rb +2 -2
- data/lib/citypay_api_client/models/paylink_token_created.rb +36 -8
- data/lib/citypay_api_client/models/paylink_token_request_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_token_status.rb +30 -2
- data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +6 -7
- data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +23 -3
- data/lib/citypay_api_client/models/paylink_ui.rb +1 -1
- data/lib/citypay_api_client/models/payment_intent.rb +479 -0
- data/lib/citypay_api_client/models/payment_intent_reference.rb +221 -0
- data/lib/citypay_api_client/models/ping.rb +1 -1
- data/lib/citypay_api_client/models/process_batch_request.rb +1 -1
- data/lib/citypay_api_client/models/process_batch_response.rb +1 -1
- data/lib/citypay_api_client/models/refund_request.rb +1 -1
- data/lib/citypay_api_client/models/register_card.rb +1 -1
- data/lib/citypay_api_client/models/remittance_data.rb +404 -0
- data/lib/citypay_api_client/models/remittance_report_request.rb +265 -0
- data/lib/citypay_api_client/models/remittance_report_response.rb +252 -0
- data/lib/citypay_api_client/models/remitted_client_data.rb +612 -0
- data/lib/citypay_api_client/models/request_challenged.rb +1 -1
- data/lib/citypay_api_client/models/retrieve_request.rb +1 -1
- data/lib/citypay_api_client/models/three_d_secure.rb +1 -1
- data/lib/citypay_api_client/models/tokenisation_response_model.rb +1 -1
- data/lib/citypay_api_client/models/void_request.rb +1 -1
- data/lib/citypay_api_client/version.rb +2 -2
- data/lib/citypay_api_client.rb +15 -2
- data/spec/.DS_Store +0 -0
- data/spec/api/reporting_api___spec.rb +99 -0
- data/spec/it_api_sandbox_spec.rb +0 -3
- data/spec/models/batch_transaction_report_request_spec.rb +47 -0
- data/spec/models/batch_transaction_report_response_spec.rb +53 -0
- data/spec/models/decision_spec.rb +0 -26
- data/spec/models/merchant_batch_report_request_spec.rb +65 -0
- data/spec/models/merchant_batch_report_response_spec.rb +53 -0
- data/spec/models/merchant_batch_response_spec.rb +71 -0
- data/spec/models/net_summary_response_spec.rb +77 -0
- data/spec/models/paylink_resend_notification_request_spec.rb +41 -0
- data/spec/models/payment_intent_reference_spec.rb +35 -0
- data/spec/models/payment_intent_spec.rb +107 -0
- data/spec/models/remittance_data_spec.rb +65 -0
- data/spec/models/remittance_report_request_spec.rb +65 -0
- data/spec/models/remittance_report_response_spec.rb +53 -0
- data/spec/models/remitted_client_data_spec.rb +113 -0
- data/spec/spec_helper.rb +1 -1
- metadata +124 -69
- data/spec/models/authen_required_spec.rb +0 -52
@@ -0,0 +1,381 @@
|
|
1
|
+
=begin
|
2
|
+
#CityPay Payment API
|
3
|
+
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
|
+
|
6
|
+
Contact: support@citypay.com
|
7
|
+
Generated by: https://openapi-generator.tech
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'cgi'
|
13
|
+
|
14
|
+
module CityPayApiClient
|
15
|
+
class ReportingApi
|
16
|
+
attr_accessor :api_client
|
17
|
+
|
18
|
+
def initialize(api_client = ApiClient.default)
|
19
|
+
@api_client = api_client
|
20
|
+
end
|
21
|
+
# Batch Transaction Report Request
|
22
|
+
# Retrieves transactions available on a given batch.
|
23
|
+
# @param merchantid [Integer] A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
24
|
+
# @param batch_no [String] The batch number that is being requested.
|
25
|
+
# @param batch_transaction_report_request [BatchTransactionReportRequest]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [BatchTransactionReportResponse]
|
28
|
+
def batched_transaction_report_request(merchantid, batch_no, batch_transaction_report_request, opts = {})
|
29
|
+
data, _status_code, _headers = batched_transaction_report_request_with_http_info(merchantid, batch_no, batch_transaction_report_request, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Batch Transaction Report Request
|
34
|
+
# Retrieves transactions available on a given batch.
|
35
|
+
# @param merchantid [Integer] A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
36
|
+
# @param batch_no [String] The batch number that is being requested.
|
37
|
+
# @param batch_transaction_report_request [BatchTransactionReportRequest]
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(BatchTransactionReportResponse, Integer, Hash)>] BatchTransactionReportResponse data, response status code and response headers
|
40
|
+
def batched_transaction_report_request_with_http_info(merchantid, batch_no, batch_transaction_report_request, opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug 'Calling API: ReportingApi.batched_transaction_report_request ...'
|
43
|
+
end
|
44
|
+
# verify the required parameter 'merchantid' is set
|
45
|
+
if @api_client.config.client_side_validation && merchantid.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'merchantid' when calling ReportingApi.batched_transaction_report_request"
|
47
|
+
end
|
48
|
+
# verify the required parameter 'batch_no' is set
|
49
|
+
if @api_client.config.client_side_validation && batch_no.nil?
|
50
|
+
fail ArgumentError, "Missing the required parameter 'batch_no' when calling ReportingApi.batched_transaction_report_request"
|
51
|
+
end
|
52
|
+
# verify the required parameter 'batch_transaction_report_request' is set
|
53
|
+
if @api_client.config.client_side_validation && batch_transaction_report_request.nil?
|
54
|
+
fail ArgumentError, "Missing the required parameter 'batch_transaction_report_request' when calling ReportingApi.batched_transaction_report_request"
|
55
|
+
end
|
56
|
+
# resource path
|
57
|
+
local_var_path = '/v6/merchant-batch/{merchantid}/{batch_no}/transactions'.sub('{' + 'merchantid' + '}', CGI.escape(merchantid.to_s)).sub('{' + 'batch_no' + '}', CGI.escape(batch_no.to_s))
|
58
|
+
|
59
|
+
# query parameters
|
60
|
+
query_params = opts[:query_params] || {}
|
61
|
+
|
62
|
+
# header parameters
|
63
|
+
header_params = opts[:header_params] || {}
|
64
|
+
# HTTP header 'Accept' (if needed)
|
65
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/xml'])
|
66
|
+
# HTTP header 'Content-Type'
|
67
|
+
content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
|
68
|
+
if !content_type.nil?
|
69
|
+
header_params['Content-Type'] = content_type
|
70
|
+
end
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = opts[:form_params] || {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_transaction_report_request)
|
77
|
+
|
78
|
+
# return_type
|
79
|
+
return_type = opts[:debug_return_type] || 'BatchTransactionReportResponse'
|
80
|
+
|
81
|
+
# auth_names
|
82
|
+
auth_names = opts[:debug_auth_names] || ['cp-api-key']
|
83
|
+
|
84
|
+
new_options = opts.merge(
|
85
|
+
:operation => :"ReportingApi.batched_transaction_report_request",
|
86
|
+
:header_params => header_params,
|
87
|
+
:query_params => query_params,
|
88
|
+
:form_params => form_params,
|
89
|
+
:body => post_body,
|
90
|
+
:auth_names => auth_names,
|
91
|
+
:return_type => return_type
|
92
|
+
)
|
93
|
+
|
94
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "API called: ReportingApi#batched_transaction_report_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
97
|
+
end
|
98
|
+
return data, status_code, headers
|
99
|
+
end
|
100
|
+
|
101
|
+
# Merchant Batch Report Request
|
102
|
+
# 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.
|
103
|
+
# @param merchant_batch_report_request [MerchantBatchReportRequest]
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [MerchantBatchReportResponse]
|
106
|
+
def merchant_batch_report_request(merchant_batch_report_request, opts = {})
|
107
|
+
data, _status_code, _headers = merchant_batch_report_request_with_http_info(merchant_batch_report_request, opts)
|
108
|
+
data
|
109
|
+
end
|
110
|
+
|
111
|
+
# Merchant Batch Report Request
|
112
|
+
# 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.
|
113
|
+
# @param merchant_batch_report_request [MerchantBatchReportRequest]
|
114
|
+
# @param [Hash] opts the optional parameters
|
115
|
+
# @return [Array<(MerchantBatchReportResponse, Integer, Hash)>] MerchantBatchReportResponse data, response status code and response headers
|
116
|
+
def merchant_batch_report_request_with_http_info(merchant_batch_report_request, opts = {})
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug 'Calling API: ReportingApi.merchant_batch_report_request ...'
|
119
|
+
end
|
120
|
+
# verify the required parameter 'merchant_batch_report_request' is set
|
121
|
+
if @api_client.config.client_side_validation && merchant_batch_report_request.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'merchant_batch_report_request' when calling ReportingApi.merchant_batch_report_request"
|
123
|
+
end
|
124
|
+
# resource path
|
125
|
+
local_var_path = '/v6/merchant-batch/report'
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = opts[:query_params] || {}
|
129
|
+
|
130
|
+
# header parameters
|
131
|
+
header_params = opts[:header_params] || {}
|
132
|
+
# HTTP header 'Accept' (if needed)
|
133
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/xml'])
|
134
|
+
# HTTP header 'Content-Type'
|
135
|
+
content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
|
136
|
+
if !content_type.nil?
|
137
|
+
header_params['Content-Type'] = content_type
|
138
|
+
end
|
139
|
+
|
140
|
+
# form parameters
|
141
|
+
form_params = opts[:form_params] || {}
|
142
|
+
|
143
|
+
# http body (model)
|
144
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(merchant_batch_report_request)
|
145
|
+
|
146
|
+
# return_type
|
147
|
+
return_type = opts[:debug_return_type] || 'MerchantBatchReportResponse'
|
148
|
+
|
149
|
+
# auth_names
|
150
|
+
auth_names = opts[:debug_auth_names] || ['cp-api-key']
|
151
|
+
|
152
|
+
new_options = opts.merge(
|
153
|
+
:operation => :"ReportingApi.merchant_batch_report_request",
|
154
|
+
:header_params => header_params,
|
155
|
+
:query_params => query_params,
|
156
|
+
:form_params => form_params,
|
157
|
+
:body => post_body,
|
158
|
+
:auth_names => auth_names,
|
159
|
+
:return_type => return_type
|
160
|
+
)
|
161
|
+
|
162
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
163
|
+
if @api_client.config.debugging
|
164
|
+
@api_client.config.logger.debug "API called: ReportingApi#merchant_batch_report_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
165
|
+
end
|
166
|
+
return data, status_code, headers
|
167
|
+
end
|
168
|
+
|
169
|
+
# Merchant Batch Request
|
170
|
+
# Retrieves a report of merchant a merchant batch for a specified batch number.
|
171
|
+
# @param merchantid [Integer] A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
172
|
+
# @param batch_no [String] The batch number that is being requested.
|
173
|
+
# @param [Hash] opts the optional parameters
|
174
|
+
# @return [MerchantBatchResponse]
|
175
|
+
def merchant_batch_request(merchantid, batch_no, opts = {})
|
176
|
+
data, _status_code, _headers = merchant_batch_request_with_http_info(merchantid, batch_no, opts)
|
177
|
+
data
|
178
|
+
end
|
179
|
+
|
180
|
+
# Merchant Batch Request
|
181
|
+
# Retrieves a report of merchant a merchant batch for a specified batch number.
|
182
|
+
# @param merchantid [Integer] A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
183
|
+
# @param batch_no [String] The batch number that is being requested.
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @return [Array<(MerchantBatchResponse, Integer, Hash)>] MerchantBatchResponse data, response status code and response headers
|
186
|
+
def merchant_batch_request_with_http_info(merchantid, batch_no, opts = {})
|
187
|
+
if @api_client.config.debugging
|
188
|
+
@api_client.config.logger.debug 'Calling API: ReportingApi.merchant_batch_request ...'
|
189
|
+
end
|
190
|
+
# verify the required parameter 'merchantid' is set
|
191
|
+
if @api_client.config.client_side_validation && merchantid.nil?
|
192
|
+
fail ArgumentError, "Missing the required parameter 'merchantid' when calling ReportingApi.merchant_batch_request"
|
193
|
+
end
|
194
|
+
# verify the required parameter 'batch_no' is set
|
195
|
+
if @api_client.config.client_side_validation && batch_no.nil?
|
196
|
+
fail ArgumentError, "Missing the required parameter 'batch_no' when calling ReportingApi.merchant_batch_request"
|
197
|
+
end
|
198
|
+
# resource path
|
199
|
+
local_var_path = '/v6/merchant-batch/{merchantid}/{batch_no}'.sub('{' + 'merchantid' + '}', CGI.escape(merchantid.to_s)).sub('{' + 'batch_no' + '}', CGI.escape(batch_no.to_s))
|
200
|
+
|
201
|
+
# query parameters
|
202
|
+
query_params = opts[:query_params] || {}
|
203
|
+
|
204
|
+
# header parameters
|
205
|
+
header_params = opts[:header_params] || {}
|
206
|
+
# HTTP header 'Accept' (if needed)
|
207
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/xml'])
|
208
|
+
|
209
|
+
# form parameters
|
210
|
+
form_params = opts[:form_params] || {}
|
211
|
+
|
212
|
+
# http body (model)
|
213
|
+
post_body = opts[:debug_body]
|
214
|
+
|
215
|
+
# return_type
|
216
|
+
return_type = opts[:debug_return_type] || 'MerchantBatchResponse'
|
217
|
+
|
218
|
+
# auth_names
|
219
|
+
auth_names = opts[:debug_auth_names] || ['cp-api-key']
|
220
|
+
|
221
|
+
new_options = opts.merge(
|
222
|
+
:operation => :"ReportingApi.merchant_batch_request",
|
223
|
+
:header_params => header_params,
|
224
|
+
:query_params => query_params,
|
225
|
+
:form_params => form_params,
|
226
|
+
:body => post_body,
|
227
|
+
:auth_names => auth_names,
|
228
|
+
:return_type => return_type
|
229
|
+
)
|
230
|
+
|
231
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
232
|
+
if @api_client.config.debugging
|
233
|
+
@api_client.config.logger.debug "API called: ReportingApi#merchant_batch_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
234
|
+
end
|
235
|
+
return data, status_code, headers
|
236
|
+
end
|
237
|
+
|
238
|
+
# Remittance Report Request
|
239
|
+
# 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.
|
240
|
+
# @param clientid [String] A client Id for which data is requested.
|
241
|
+
# @param remittance_report_request [RemittanceReportRequest]
|
242
|
+
# @param [Hash] opts the optional parameters
|
243
|
+
# @return [RemittanceReportResponse]
|
244
|
+
def remittance_range_report(clientid, remittance_report_request, opts = {})
|
245
|
+
data, _status_code, _headers = remittance_range_report_with_http_info(clientid, remittance_report_request, opts)
|
246
|
+
data
|
247
|
+
end
|
248
|
+
|
249
|
+
# Remittance Report Request
|
250
|
+
# 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.
|
251
|
+
# @param clientid [String] A client Id for which data is requested.
|
252
|
+
# @param remittance_report_request [RemittanceReportRequest]
|
253
|
+
# @param [Hash] opts the optional parameters
|
254
|
+
# @return [Array<(RemittanceReportResponse, Integer, Hash)>] RemittanceReportResponse data, response status code and response headers
|
255
|
+
def remittance_range_report_with_http_info(clientid, remittance_report_request, opts = {})
|
256
|
+
if @api_client.config.debugging
|
257
|
+
@api_client.config.logger.debug 'Calling API: ReportingApi.remittance_range_report ...'
|
258
|
+
end
|
259
|
+
# verify the required parameter 'clientid' is set
|
260
|
+
if @api_client.config.client_side_validation && clientid.nil?
|
261
|
+
fail ArgumentError, "Missing the required parameter 'clientid' when calling ReportingApi.remittance_range_report"
|
262
|
+
end
|
263
|
+
# verify the required parameter 'remittance_report_request' is set
|
264
|
+
if @api_client.config.client_side_validation && remittance_report_request.nil?
|
265
|
+
fail ArgumentError, "Missing the required parameter 'remittance_report_request' when calling ReportingApi.remittance_range_report"
|
266
|
+
end
|
267
|
+
# resource path
|
268
|
+
local_var_path = '/v6/remittance/report/{clientid}'.sub('{' + 'clientid' + '}', CGI.escape(clientid.to_s))
|
269
|
+
|
270
|
+
# query parameters
|
271
|
+
query_params = opts[:query_params] || {}
|
272
|
+
|
273
|
+
# header parameters
|
274
|
+
header_params = opts[:header_params] || {}
|
275
|
+
# HTTP header 'Accept' (if needed)
|
276
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/xml'])
|
277
|
+
# HTTP header 'Content-Type'
|
278
|
+
content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
|
279
|
+
if !content_type.nil?
|
280
|
+
header_params['Content-Type'] = content_type
|
281
|
+
end
|
282
|
+
|
283
|
+
# form parameters
|
284
|
+
form_params = opts[:form_params] || {}
|
285
|
+
|
286
|
+
# http body (model)
|
287
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(remittance_report_request)
|
288
|
+
|
289
|
+
# return_type
|
290
|
+
return_type = opts[:debug_return_type] || 'RemittanceReportResponse'
|
291
|
+
|
292
|
+
# auth_names
|
293
|
+
auth_names = opts[:debug_auth_names] || ['cp-api-key']
|
294
|
+
|
295
|
+
new_options = opts.merge(
|
296
|
+
:operation => :"ReportingApi.remittance_range_report",
|
297
|
+
:header_params => header_params,
|
298
|
+
:query_params => query_params,
|
299
|
+
:form_params => form_params,
|
300
|
+
:body => post_body,
|
301
|
+
:auth_names => auth_names,
|
302
|
+
:return_type => return_type
|
303
|
+
)
|
304
|
+
|
305
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
306
|
+
if @api_client.config.debugging
|
307
|
+
@api_client.config.logger.debug "API called: ReportingApi#remittance_range_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
308
|
+
end
|
309
|
+
return data, status_code, headers
|
310
|
+
end
|
311
|
+
|
312
|
+
# Remittance Date Report Request
|
313
|
+
# 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.
|
314
|
+
# @param clientid [String] A client Id for which data is requested.
|
315
|
+
# @param date [String] Date (YYYY-MM-DD) to filter the request for.
|
316
|
+
# @param [Hash] opts the optional parameters
|
317
|
+
# @return [RemittedClientData]
|
318
|
+
def remittance_report_request(clientid, date, opts = {})
|
319
|
+
data, _status_code, _headers = remittance_report_request_with_http_info(clientid, date, opts)
|
320
|
+
data
|
321
|
+
end
|
322
|
+
|
323
|
+
# Remittance Date Report Request
|
324
|
+
# 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.
|
325
|
+
# @param clientid [String] A client Id for which data is requested.
|
326
|
+
# @param date [String] Date (YYYY-MM-DD) to filter the request for.
|
327
|
+
# @param [Hash] opts the optional parameters
|
328
|
+
# @return [Array<(RemittedClientData, Integer, Hash)>] RemittedClientData data, response status code and response headers
|
329
|
+
def remittance_report_request_with_http_info(clientid, date, opts = {})
|
330
|
+
if @api_client.config.debugging
|
331
|
+
@api_client.config.logger.debug 'Calling API: ReportingApi.remittance_report_request ...'
|
332
|
+
end
|
333
|
+
# verify the required parameter 'clientid' is set
|
334
|
+
if @api_client.config.client_side_validation && clientid.nil?
|
335
|
+
fail ArgumentError, "Missing the required parameter 'clientid' when calling ReportingApi.remittance_report_request"
|
336
|
+
end
|
337
|
+
# verify the required parameter 'date' is set
|
338
|
+
if @api_client.config.client_side_validation && date.nil?
|
339
|
+
fail ArgumentError, "Missing the required parameter 'date' when calling ReportingApi.remittance_report_request"
|
340
|
+
end
|
341
|
+
# resource path
|
342
|
+
local_var_path = '/v6/remittance/report/{clientid}/{date}'.sub('{' + 'clientid' + '}', CGI.escape(clientid.to_s)).sub('{' + 'date' + '}', CGI.escape(date.to_s))
|
343
|
+
|
344
|
+
# query parameters
|
345
|
+
query_params = opts[:query_params] || {}
|
346
|
+
|
347
|
+
# header parameters
|
348
|
+
header_params = opts[:header_params] || {}
|
349
|
+
# HTTP header 'Accept' (if needed)
|
350
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/xml'])
|
351
|
+
|
352
|
+
# form parameters
|
353
|
+
form_params = opts[:form_params] || {}
|
354
|
+
|
355
|
+
# http body (model)
|
356
|
+
post_body = opts[:debug_body]
|
357
|
+
|
358
|
+
# return_type
|
359
|
+
return_type = opts[:debug_return_type] || 'RemittedClientData'
|
360
|
+
|
361
|
+
# auth_names
|
362
|
+
auth_names = opts[:debug_auth_names] || ['cp-api-key']
|
363
|
+
|
364
|
+
new_options = opts.merge(
|
365
|
+
:operation => :"ReportingApi.remittance_report_request",
|
366
|
+
:header_params => header_params,
|
367
|
+
:query_params => query_params,
|
368
|
+
:form_params => form_params,
|
369
|
+
:body => post_body,
|
370
|
+
:auth_names => auth_names,
|
371
|
+
:return_type => return_type
|
372
|
+
)
|
373
|
+
|
374
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
375
|
+
if @api_client.config.debugging
|
376
|
+
@api_client.config.logger.debug "API called: ReportingApi#remittance_report_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
377
|
+
end
|
378
|
+
return data, status_code, headers
|
379
|
+
end
|
380
|
+
end
|
381
|
+
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
#
|
4
|
+
# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs. Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability for tokenised payments. ## Compliance and Security Overview <aside class=\"notice\"> Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is designed with stringent security measures and compliance protocols to safeguard sensitive information and meet the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside> ### Key Compliance and Security Measures * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats. ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations. For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application. Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
@@ -94,14 +94,6 @@ module CityPayApiClient
|
|
94
94
|
def list_invalid_properties
|
95
95
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
96
96
|
invalid_properties = Array.new
|
97
|
-
if !@code.nil? && @code.to_s.length > 4
|
98
|
-
invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 4.')
|
99
|
-
end
|
100
|
-
|
101
|
-
if !@code.nil? && @code.to_s.length < 3
|
102
|
-
invalid_properties.push('invalid value for "code", the character length must be great than or equal to 3.')
|
103
|
-
end
|
104
|
-
|
105
97
|
if !@identifier.nil? && @identifier.to_s.length > 50
|
106
98
|
invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 50.')
|
107
99
|
end
|
@@ -117,31 +109,11 @@ module CityPayApiClient
|
|
117
109
|
# @return true if the model is valid
|
118
110
|
def valid?
|
119
111
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
120
|
-
return false if !@code.nil? && @code.to_s.length > 4
|
121
|
-
return false if !@code.nil? && @code.to_s.length < 3
|
122
112
|
return false if !@identifier.nil? && @identifier.to_s.length > 50
|
123
113
|
return false if !@identifier.nil? && @identifier.to_s.length < 4
|
124
114
|
true
|
125
115
|
end
|
126
116
|
|
127
|
-
# Custom attribute writer method with validation
|
128
|
-
# @param [Object] code Value to be assigned
|
129
|
-
def code=(code)
|
130
|
-
if code.nil?
|
131
|
-
fail ArgumentError, 'code cannot be nil'
|
132
|
-
end
|
133
|
-
|
134
|
-
if code.to_s.length > 4
|
135
|
-
fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 4.'
|
136
|
-
end
|
137
|
-
|
138
|
-
if code.to_s.length < 3
|
139
|
-
fail ArgumentError, 'invalid value for "code", the character length must be great than or equal to 3.'
|
140
|
-
end
|
141
|
-
|
142
|
-
@code = code
|
143
|
-
end
|
144
|
-
|
145
117
|
# Custom attribute writer method with validation
|
146
118
|
# @param [Object] identifier Value to be assigned
|
147
119
|
def identifier=(identifier)
|