citypay_api_client 1.1.1 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +73 -0
- data/README.md +65 -37
- data/citypay_api_client.gemspec +4 -3
- data/docs/Acknowledgement.md +2 -2
- data/docs/AclCheckResponseModel.md +3 -3
- data/docs/AirlineAdvice.md +1 -1
- data/docs/AuthRequest.md +9 -7
- data/docs/AuthResponse.md +9 -5
- data/docs/AuthorisationAndPaymentApi.md +145 -10
- data/docs/Batch.md +1 -1
- data/docs/BatchProcessingApi.md +24 -20
- 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 +6 -2
- data/docs/Bin.md +2 -2
- data/docs/CaptureRequest.md +1 -1
- data/docs/Card.md +3 -3
- data/docs/CardHolderAccountApi.md +73 -14
- data/docs/ChargeRequest.md +8 -6
- data/docs/ContactDetails.md +11 -11
- data/docs/Decision.md +0 -2
- data/docs/DirectPostApi.md +26 -16
- data/docs/DirectPostRequest.md +9 -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/OperationalFunctionsApi.md +28 -8
- data/docs/PaylinkAdjustmentRequest.md +1 -1
- data/docs/PaylinkApi.md +337 -21
- data/docs/PaylinkBillPaymentTokenRequest.md +1 -1
- data/docs/PaylinkCustomParam.md +3 -1
- data/docs/PaylinkErrorCode.md +2 -2
- data/docs/PaylinkFieldGuardModel.md +1 -1
- data/docs/PaylinkResendNotificationRequest.md +20 -0
- data/docs/PaylinkStateEvent.md +4 -4
- data/docs/PaylinkTokenCreated.md +11 -11
- data/docs/PaylinkTokenRequestModel.md +4 -0
- 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/RegisterCard.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/ThreeDSecure.md +1 -1
- data/docs/TokenisationResponseModel.md +3 -3
- data/docs/images/3dsv1-challenge.png +0 -0
- data/docs/images/3dsv2-challenge.png +0 -0
- data/docs/images/3dsv2-frictionless.png +0 -0
- data/docs/images/3dsv2-method-challenge.png +0 -0
- data/docs/images/3dsv2-method-frictionless.png +0 -0
- data/docs/images/3dsv2-no3d.png +0 -0
- data/docs/images/citypay-logo.svg +1 -0
- data/docs/images/direct-post-flow.png +0 -0
- data/docs/images/favicon.ico +0 -0
- data/docs/images/header.png +0 -0
- data/docs/images/logo.ai +1913 -4
- data/docs/images/logo.png +0 -0
- data/docs/images/logo.svg +1 -0
- data/docs/images/merchant-BPS-workflow.png +0 -0
- data/docs/images/paylink-field-guards.png +0 -0
- data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +72 -4
- data/lib/citypay_api_client/api/batch_processing_api__.rb +15 -15
- data/lib/citypay_api_client/api/card_holder_account_api__.rb +5 -2
- data/lib/citypay_api_client/api/direct_post_api__.rb +9 -9
- data/lib/citypay_api_client/api/operational_functions_api__.rb +3 -3
- data/lib/citypay_api_client/api/paylink_api__.rb +163 -26
- data/lib/citypay_api_client/api/reporting_api__.rb +381 -0
- data/lib/citypay_api_client/api_client.rb +24 -22
- data/lib/citypay_api_client/api_error.rb +3 -2
- data/lib/citypay_api_client/configuration.rb +28 -9
- data/lib/citypay_api_client/models/account_create.rb +17 -20
- data/lib/citypay_api_client/models/account_status.rb +15 -20
- data/lib/citypay_api_client/models/acknowledgement.rb +21 -46
- data/lib/citypay_api_client/models/acl_check_request.rb +17 -20
- data/lib/citypay_api_client/models/acl_check_response_model.rb +16 -21
- data/lib/citypay_api_client/models/airline_advice.rb +45 -29
- data/lib/citypay_api_client/models/airline_segment.rb +35 -22
- data/lib/citypay_api_client/models/auth_reference.rb +41 -26
- data/lib/citypay_api_client/models/auth_references.rb +15 -20
- data/lib/citypay_api_client/models/auth_request.rb +72 -34
- data/lib/citypay_api_client/models/auth_response.rb +46 -23
- data/lib/citypay_api_client/models/authen_required.rb +15 -20
- data/lib/citypay_api_client/models/batch.rb +25 -22
- data/lib/citypay_api_client/models/batch_report_request.rb +23 -22
- data/lib/citypay_api_client/models/batch_report_response_model.rb +28 -21
- data/lib/citypay_api_client/models/batch_transaction.rb +25 -22
- 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 +53 -22
- data/lib/citypay_api_client/models/bin.rb +15 -20
- data/lib/citypay_api_client/models/bin_lookup.rb +17 -20
- data/lib/citypay_api_client/models/c_res_auth_request.rb +15 -20
- data/lib/citypay_api_client/models/capture_request.rb +27 -22
- data/lib/citypay_api_client/models/card.rb +33 -26
- data/lib/citypay_api_client/models/card_holder_account.rb +19 -20
- data/lib/citypay_api_client/models/card_status.rb +15 -20
- data/lib/citypay_api_client/models/charge_request.rb +72 -34
- data/lib/citypay_api_client/models/check_batch_status.rb +23 -22
- data/lib/citypay_api_client/models/check_batch_status_response.rb +15 -20
- data/lib/citypay_api_client/models/contact_details.rb +77 -42
- data/lib/citypay_api_client/models/decision.rb +16 -30
- data/lib/citypay_api_client/models/direct_post_request.rb +72 -34
- data/lib/citypay_api_client/models/direct_token_auth_request.rb +15 -20
- data/lib/citypay_api_client/models/domain_key_check_request.rb +17 -20
- data/lib/citypay_api_client/models/domain_key_request.rb +19 -20
- data/lib/citypay_api_client/models/domain_key_response.rb +25 -22
- data/lib/citypay_api_client/models/error.rb +27 -24
- data/lib/citypay_api_client/models/event_data_model.rb +15 -20
- data/lib/citypay_api_client/models/exists.rb +17 -20
- data/lib/citypay_api_client/models/external_mpi.rb +39 -24
- data/lib/citypay_api_client/models/list_merchants_response.rb +21 -22
- data/lib/citypay_api_client/models/mcc6012.rb +15 -20
- data/lib/citypay_api_client/models/merchant.rb +15 -20
- 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 +19 -20
- data/lib/citypay_api_client/models/paylink_address.rb +52 -29
- data/lib/citypay_api_client/models/paylink_adjustment_request.rb +25 -22
- data/lib/citypay_api_client/models/paylink_attachment_request.rb +19 -20
- data/lib/citypay_api_client/models/paylink_attachment_result.rb +19 -20
- data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +17 -20
- data/lib/citypay_api_client/models/paylink_card_holder.rb +30 -23
- data/lib/citypay_api_client/models/paylink_cart.rb +15 -20
- data/lib/citypay_api_client/models/paylink_cart_item_model.rb +15 -20
- data/lib/citypay_api_client/models/paylink_config.rb +15 -20
- data/lib/citypay_api_client/models/paylink_custom_param.rb +29 -22
- data/lib/citypay_api_client/models/paylink_email_notification_path.rb +17 -20
- data/lib/citypay_api_client/models/paylink_error_code.rb +19 -20
- data/lib/citypay_api_client/models/paylink_field_guard_model.rb +16 -21
- data/lib/citypay_api_client/models/paylink_part_payments.rb +15 -20
- data/lib/citypay_api_client/models/paylink_resend_notification_request.rb +224 -0
- data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +17 -20
- data/lib/citypay_api_client/models/paylink_state_event.rb +16 -21
- data/lib/citypay_api_client/models/paylink_token_created.rb +56 -27
- data/lib/citypay_api_client/models/paylink_token_request_model.rb +75 -22
- data/lib/citypay_api_client/models/paylink_token_status.rb +44 -21
- data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +24 -26
- data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +39 -22
- data/lib/citypay_api_client/models/paylink_ui.rb +15 -20
- 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 +21 -22
- data/lib/citypay_api_client/models/process_batch_request.rb +27 -22
- data/lib/citypay_api_client/models/process_batch_response.rb +17 -20
- data/lib/citypay_api_client/models/refund_request.rb +28 -21
- data/lib/citypay_api_client/models/register_card.rb +27 -22
- 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 +15 -20
- data/lib/citypay_api_client/models/retrieve_request.rb +23 -22
- data/lib/citypay_api_client/models/three_d_secure.rb +16 -21
- data/lib/citypay_api_client/models/tokenisation_response_model.rb +23 -24
- data/lib/citypay_api_client/models/void_request.rb +23 -22
- data/lib/citypay_api_client/version.rb +3 -3
- data/lib/citypay_api_client.rb +16 -3
- data/spec/api/reporting_api___spec.rb +99 -0
- data/spec/it_api_sandbox_spec.rb +5 -14
- data/spec/models/account_create_spec.rb +1 -2
- data/spec/models/account_status_spec.rb +2 -2
- data/spec/models/airline_advice_spec.rb +0 -2
- data/spec/models/airline_segment_spec.rb +0 -2
- data/spec/models/auth_request_spec.rb +0 -2
- data/spec/models/auth_response_spec.rb +75 -30
- data/spec/models/batch_report_request_spec.rb +0 -2
- data/spec/models/batch_report_response_model_spec.rb +0 -2
- data/spec/models/batch_spec.rb +0 -2
- 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/batch_transaction_result_model_spec.rb +0 -2
- data/spec/models/batch_transaction_spec.rb +0 -2
- data/spec/models/bin_lookup_spec.rb +0 -2
- data/spec/models/capture_request_spec.rb +0 -2
- data/spec/models/card_holder_account_spec.rb +0 -2
- data/spec/models/charge_request_spec.rb +0 -2
- data/spec/models/decision_spec.rb +0 -26
- data/spec/models/direct_post_request_spec.rb +0 -2
- data/spec/models/domain_key_check_request_spec.rb +0 -2
- 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/paylink_token_request_model_spec.rb +0 -2
- data/spec/models/payment_intent_reference_spec.rb +35 -0
- data/spec/models/payment_intent_spec.rb +107 -0
- data/spec/models/process_batch_request_spec.rb +0 -2
- data/spec/models/refund_request_spec.rb +0 -2
- data/spec/models/register_card_spec.rb +0 -2
- 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 +2 -2
- metadata +146 -78
- data/docs/OperationalApi.md +0 -214
- data/docs/PaymentProcessingApi.md +0 -559
- data/spec/models/authen_required_spec.rb +0 -52
@@ -1,14 +1,14 @@
|
|
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
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
12
12
|
module CityPayApiClient
|
13
|
-
VERSION = '1.1.
|
13
|
+
VERSION = '1.1.3'
|
14
14
|
end
|
data/lib/citypay_api_client.rb
CHANGED
@@ -1,11 +1,11 @@
|
|
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
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -28,11 +28,12 @@ require 'citypay_api_client/models/auth_reference'
|
|
28
28
|
require 'citypay_api_client/models/auth_references'
|
29
29
|
require 'citypay_api_client/models/auth_request'
|
30
30
|
require 'citypay_api_client/models/auth_response'
|
31
|
-
require 'citypay_api_client/models/authen_required'
|
32
31
|
require 'citypay_api_client/models/batch'
|
33
32
|
require 'citypay_api_client/models/batch_report_request'
|
34
33
|
require 'citypay_api_client/models/batch_report_response_model'
|
35
34
|
require 'citypay_api_client/models/batch_transaction'
|
35
|
+
require 'citypay_api_client/models/batch_transaction_report_request'
|
36
|
+
require 'citypay_api_client/models/batch_transaction_report_response'
|
36
37
|
require 'citypay_api_client/models/batch_transaction_result_model'
|
37
38
|
require 'citypay_api_client/models/bin'
|
38
39
|
require 'citypay_api_client/models/bin_lookup'
|
@@ -58,6 +59,10 @@ require 'citypay_api_client/models/external_mpi'
|
|
58
59
|
require 'citypay_api_client/models/list_merchants_response'
|
59
60
|
require 'citypay_api_client/models/mcc6012'
|
60
61
|
require 'citypay_api_client/models/merchant'
|
62
|
+
require 'citypay_api_client/models/merchant_batch_report_request'
|
63
|
+
require 'citypay_api_client/models/merchant_batch_report_response'
|
64
|
+
require 'citypay_api_client/models/merchant_batch_response'
|
65
|
+
require 'citypay_api_client/models/net_summary_response'
|
61
66
|
require 'citypay_api_client/models/pa_res_auth_request'
|
62
67
|
require 'citypay_api_client/models/paylink_address'
|
63
68
|
require 'citypay_api_client/models/paylink_adjustment_request'
|
@@ -73,6 +78,7 @@ require 'citypay_api_client/models/paylink_email_notification_path'
|
|
73
78
|
require 'citypay_api_client/models/paylink_error_code'
|
74
79
|
require 'citypay_api_client/models/paylink_field_guard_model'
|
75
80
|
require 'citypay_api_client/models/paylink_part_payments'
|
81
|
+
require 'citypay_api_client/models/paylink_resend_notification_request'
|
76
82
|
require 'citypay_api_client/models/paylink_sms_notification_path'
|
77
83
|
require 'citypay_api_client/models/paylink_state_event'
|
78
84
|
require 'citypay_api_client/models/paylink_token_created'
|
@@ -81,11 +87,17 @@ require 'citypay_api_client/models/paylink_token_status'
|
|
81
87
|
require 'citypay_api_client/models/paylink_token_status_change_request'
|
82
88
|
require 'citypay_api_client/models/paylink_token_status_change_response'
|
83
89
|
require 'citypay_api_client/models/paylink_ui'
|
90
|
+
require 'citypay_api_client/models/payment_intent'
|
91
|
+
require 'citypay_api_client/models/payment_intent_reference'
|
84
92
|
require 'citypay_api_client/models/ping'
|
85
93
|
require 'citypay_api_client/models/process_batch_request'
|
86
94
|
require 'citypay_api_client/models/process_batch_response'
|
87
95
|
require 'citypay_api_client/models/refund_request'
|
88
96
|
require 'citypay_api_client/models/register_card'
|
97
|
+
require 'citypay_api_client/models/remittance_data'
|
98
|
+
require 'citypay_api_client/models/remittance_report_request'
|
99
|
+
require 'citypay_api_client/models/remittance_report_response'
|
100
|
+
require 'citypay_api_client/models/remitted_client_data'
|
89
101
|
require 'citypay_api_client/models/request_challenged'
|
90
102
|
require 'citypay_api_client/models/retrieve_request'
|
91
103
|
require 'citypay_api_client/models/three_d_secure'
|
@@ -99,6 +111,7 @@ require 'citypay_api_client/api/card_holder_account_api__'
|
|
99
111
|
require 'citypay_api_client/api/direct_post_api__'
|
100
112
|
require 'citypay_api_client/api/operational_functions_api__'
|
101
113
|
require 'citypay_api_client/api/paylink_api__'
|
114
|
+
require 'citypay_api_client/api/reporting_api__'
|
102
115
|
|
103
116
|
module CityPayApiClient
|
104
117
|
class << self
|
@@ -0,0 +1,99 @@
|
|
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 'spec_helper'
|
13
|
+
require 'json'
|
14
|
+
|
15
|
+
# Unit tests for CityPayApiClient::ReportingApi
|
16
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
17
|
+
# Please update as you see appropriate
|
18
|
+
describe 'ReportingApi' do
|
19
|
+
before do
|
20
|
+
# run before each test
|
21
|
+
@api_instance = CityPayApiClient::ReportingApi.new
|
22
|
+
end
|
23
|
+
|
24
|
+
after do
|
25
|
+
# run after each test
|
26
|
+
end
|
27
|
+
|
28
|
+
describe 'test an instance of ReportingApi' do
|
29
|
+
it 'should create an instance of ReportingApi' do
|
30
|
+
expect(@api_instance).to be_instance_of(CityPayApiClient::ReportingApi)
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
# unit tests for batched_transaction_report_request
|
35
|
+
# Batch Transaction Report Request
|
36
|
+
# Retrieves transactions available on a given batch.
|
37
|
+
# @param merchantid A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
38
|
+
# @param batch_no The batch number that is being requested.
|
39
|
+
# @param batch_transaction_report_request
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [BatchTransactionReportResponse]
|
42
|
+
describe 'batched_transaction_report_request test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for merchant_batch_report_request
|
49
|
+
# Merchant Batch Report Request
|
50
|
+
# 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.
|
51
|
+
# @param merchant_batch_report_request
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @return [MerchantBatchReportResponse]
|
54
|
+
describe 'merchant_batch_report_request test' do
|
55
|
+
it 'should work' do
|
56
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# unit tests for merchant_batch_request
|
61
|
+
# Merchant Batch Request
|
62
|
+
# Retrieves a report of merchant a merchant batch for a specified batch number.
|
63
|
+
# @param merchantid A merchant ID (MID) for which data is requested. This field allows for filtering of the request by a specific merchant account.
|
64
|
+
# @param batch_no The batch number that is being requested.
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @return [MerchantBatchResponse]
|
67
|
+
describe 'merchant_batch_request test' do
|
68
|
+
it 'should work' do
|
69
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# unit tests for remittance_range_report
|
74
|
+
# Remittance Report Request
|
75
|
+
# 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.
|
76
|
+
# @param clientid A client Id for which data is requested.
|
77
|
+
# @param remittance_report_request
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [RemittanceReportResponse]
|
80
|
+
describe 'remittance_range_report test' do
|
81
|
+
it 'should work' do
|
82
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# unit tests for remittance_report_request
|
87
|
+
# Remittance Date Report Request
|
88
|
+
# 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.
|
89
|
+
# @param clientid A client Id for which data is requested.
|
90
|
+
# @param date Date (YYYY-MM-DD) to filter the request for.
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @return [RemittedClientData]
|
93
|
+
describe 'remittance_report_request test' do
|
94
|
+
it 'should work' do
|
95
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
end
|
data/spec/it_api_sandbox_spec.rb
CHANGED
@@ -8,9 +8,9 @@ require_relative '../lib/citypay_api_client/utils/digest_utils'
|
|
8
8
|
|
9
9
|
describe 'IntegrationTests' do
|
10
10
|
|
11
|
-
client_id =
|
12
|
-
licence_key =
|
13
|
-
merchant_id =
|
11
|
+
client_id = ENV['CP_CLIENT_ID']
|
12
|
+
licence_key = ENV['CP_LICENCE_KEY']
|
13
|
+
merchant_id = ENV['CP_MERCHANT_ID']
|
14
14
|
|
15
15
|
before do
|
16
16
|
|
@@ -62,7 +62,6 @@ describe 'IntegrationTests' do
|
|
62
62
|
))
|
63
63
|
|
64
64
|
expect(result.auth_response).to_not be_nil
|
65
|
-
expect(result.authen_required).to be_nil
|
66
65
|
expect(result.request_challenged).to be_nil
|
67
66
|
|
68
67
|
response = result.auth_response
|
@@ -98,7 +97,6 @@ describe 'IntegrationTests' do
|
|
98
97
|
))
|
99
98
|
|
100
99
|
expect(result.auth_response).to be_nil
|
101
|
-
expect(result.authen_required).to be_nil
|
102
100
|
expect(result.request_challenged).to_not be_nil
|
103
101
|
|
104
102
|
response = result.request_challenged
|
@@ -120,14 +118,8 @@ describe 'IntegrationTests' do
|
|
120
118
|
body: content.to_json)
|
121
119
|
res = request.run
|
122
120
|
c_res = res.response_body
|
123
|
-
|
124
|
-
|
125
|
-
expect(c_res['messageType']).to_not be_nil
|
126
|
-
expect(c_res['messageVersion']).to_not be_nil
|
127
|
-
expect(c_res['threeDSServerTransID']).to_not be_nil
|
128
|
-
expect(c_res['transStatus']).to_not be_nil
|
129
|
-
|
130
|
-
c_res_auth_request = CityPayApiClient::CResAuthRequest.new({:cres => Base64.encode64(c_res)})
|
121
|
+
object = JSON.parse(c_res)
|
122
|
+
c_res_auth_request = CityPayApiClient::CResAuthRequest.new({:cres => object['cres']})
|
131
123
|
|
132
124
|
c_res_request_response = api_instance.c_res_request(c_res_auth_request)
|
133
125
|
|
@@ -198,7 +190,6 @@ describe 'IntegrationTests' do
|
|
198
190
|
|
199
191
|
# decision object returned
|
200
192
|
expect(result2.auth_response).to_not be_nil
|
201
|
-
expect(result2.authen_required).to be_nil
|
202
193
|
expect(result2.request_challenged).to be_nil
|
203
194
|
|
204
195
|
response = result2.auth_response
|
@@ -19,7 +19,6 @@ require 'date'
|
|
19
19
|
describe 'AccountCreate' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@instance = CityPayApiClient::AccountCreate.new
|
23
22
|
end
|
24
23
|
|
25
24
|
after do
|
@@ -28,7 +27,7 @@ describe 'AccountCreate' do
|
|
28
27
|
|
29
28
|
describe 'test an instance of AccountCreate' do
|
30
29
|
it 'should create an instance of AccountCreate' do
|
31
|
-
|
30
|
+
|
32
31
|
end
|
33
32
|
end
|
34
33
|
describe 'test attribute "account_id"' do
|
@@ -19,7 +19,7 @@ require 'date'
|
|
19
19
|
describe 'AccountStatus' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
|
22
|
+
|
23
23
|
end
|
24
24
|
|
25
25
|
after do
|
@@ -28,7 +28,7 @@ describe 'AccountStatus' do
|
|
28
28
|
|
29
29
|
describe 'test an instance of AccountStatus' do
|
30
30
|
it 'should create an instance of AccountStatus' do
|
31
|
-
|
31
|
+
|
32
32
|
end
|
33
33
|
end
|
34
34
|
describe 'test attribute "status"' do
|
@@ -19,7 +19,6 @@ require 'date'
|
|
19
19
|
describe 'AirlineAdvice' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@instance = CityPayApiClient::AirlineAdvice.new
|
23
22
|
end
|
24
23
|
|
25
24
|
after do
|
@@ -28,7 +27,6 @@ describe 'AirlineAdvice' do
|
|
28
27
|
|
29
28
|
describe 'test an instance of AirlineAdvice' do
|
30
29
|
it 'should create an instance of AirlineAdvice' do
|
31
|
-
expect(@instance).to be_instance_of(CityPayApiClient::AirlineAdvice)
|
32
30
|
end
|
33
31
|
end
|
34
32
|
describe 'test attribute "carrier_name"' do
|
@@ -19,7 +19,6 @@ require 'date'
|
|
19
19
|
describe 'AirlineSegment' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@instance = CityPayApiClient::AirlineSegment.new
|
23
22
|
end
|
24
23
|
|
25
24
|
after do
|
@@ -28,7 +27,6 @@ describe 'AirlineSegment' do
|
|
28
27
|
|
29
28
|
describe 'test an instance of AirlineSegment' do
|
30
29
|
it 'should create an instance of AirlineSegment' do
|
31
|
-
expect(@instance).to be_instance_of(CityPayApiClient::AirlineSegment)
|
32
30
|
end
|
33
31
|
end
|
34
32
|
describe 'test attribute "arrival_location_code"' do
|
@@ -19,7 +19,6 @@ require 'date'
|
|
19
19
|
describe 'AuthRequest' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@instance = CityPayApiClient::AuthRequest.new
|
23
22
|
end
|
24
23
|
|
25
24
|
after do
|
@@ -28,7 +27,6 @@ describe 'AuthRequest' do
|
|
28
27
|
|
29
28
|
describe 'test an instance of AuthRequest' do
|
30
29
|
it 'should create an instance of AuthRequest' do
|
31
|
-
expect(@instance).to be_instance_of(CityPayApiClient::AuthRequest)
|
32
30
|
end
|
33
31
|
end
|
34
32
|
describe 'test attribute "airline_data"' do
|
@@ -21,38 +21,71 @@ describe 'AuthResponse' do
|
|
21
21
|
# run before each test
|
22
22
|
|
23
23
|
json = '
|
24
|
-
{
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
}
|
53
|
-
|
24
|
+
{
|
25
|
+
"amount": 5500,
|
26
|
+
"atrn": "atrn1",
|
27
|
+
"atsd": "a",
|
28
|
+
"authcode": "12345",
|
29
|
+
"authen_result": "R",
|
30
|
+
"authorised": true,
|
31
|
+
"avs_result": "G",
|
32
|
+
"bin_commercial": false,
|
33
|
+
"bin_debit": false,
|
34
|
+
"bin_description": "bin_desc",
|
35
|
+
"cavv": "cavvvvvvvvvvvvv",
|
36
|
+
"context": "20200812075906AAAGV4",
|
37
|
+
"csc_result": "C",
|
38
|
+
"currency": "GBP",
|
39
|
+
"datetime": "2020-08-12T07:59:11Z",
|
40
|
+
"eci": "0",
|
41
|
+
"identifier": "ident1",
|
42
|
+
"live": true,
|
43
|
+
"maskedpan": "400000******0002",
|
44
|
+
"merchantid": 12345,
|
45
|
+
"result": 1,
|
46
|
+
"result_code": "000",
|
47
|
+
"result_message": "System: Accepted Transaction",
|
48
|
+
"scheme": "VISA_BUSINESS",
|
49
|
+
"sha256": "abcdefg",
|
50
|
+
"trans_status": "P",
|
51
|
+
"transno": 74875
|
52
|
+
}'
|
53
|
+
|
54
|
+
json_no_ident = '
|
55
|
+
{
|
56
|
+
"amount": 0,
|
57
|
+
"atrn": "",
|
58
|
+
"atsd": "",
|
59
|
+
"authcode": "",
|
60
|
+
"authen_result": "",
|
61
|
+
"authorised": false,
|
62
|
+
"avs_result": " ",
|
63
|
+
"bin_commercial": false,
|
64
|
+
"bin_debit": false,
|
65
|
+
"bin_description": "",
|
66
|
+
"cavv": "",
|
67
|
+
"context": "PC.0.A5298ef695b",
|
68
|
+
"csc_result": " ",
|
69
|
+
"currency": "---",
|
70
|
+
"datetime": "1969-12-31T23:59:59Z",
|
71
|
+
"eci": "0",
|
72
|
+
"identifier": "",
|
73
|
+
"live": true,
|
74
|
+
"maskedpan": "N/A",
|
75
|
+
"merchantid": 0,
|
76
|
+
"result": 3,
|
77
|
+
"result_code": "P030",
|
78
|
+
"result_message": "Request Error: Authorisation invalid (203: Data element not in the required format or value is invalid as defined in Table A.1. threeDSSessionData)",
|
79
|
+
"scheme": "",
|
80
|
+
"sha256": "",
|
81
|
+
"trans_status": "_",
|
82
|
+
"transno": -1
|
83
|
+
}'
|
84
|
+
|
54
85
|
data = JSON.parse(json, :symbolize_names => true)
|
86
|
+
data_not_ident = JSON.parse(json_no_ident, :symbolize_names => true)
|
55
87
|
@instance = CityPayApiClient::ApiClient.new.convert_to_type(data, "AuthResponse")
|
88
|
+
@instance_not_ident = CityPayApiClient::ApiClient.new.convert_to_type(data_not_ident, "AuthResponse")
|
56
89
|
end
|
57
90
|
|
58
91
|
after do
|
@@ -226,4 +259,16 @@ describe 'AuthResponse' do
|
|
226
259
|
end
|
227
260
|
end
|
228
261
|
|
262
|
+
describe 'test attribute "result_code"' do
|
263
|
+
it 'should work' do
|
264
|
+
expect(@instance_not_ident.result_code).to eq("P030")
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
describe 'test attribute "result"' do
|
269
|
+
it 'should work' do
|
270
|
+
expect(@instance_not_ident.result).to eq(3)
|
271
|
+
end
|
272
|
+
end
|
273
|
+
|
229
274
|
end
|
@@ -17,11 +17,9 @@ require 'date'
|
|
17
17
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe CityPayApiClient::BatchReportRequest do
|
20
|
-
let(:instance) { CityPayApiClient::BatchReportRequest.new }
|
21
20
|
|
22
21
|
describe 'test an instance of BatchReportRequest' do
|
23
22
|
it 'should create an instance of BatchReportRequest' do
|
24
|
-
expect(instance).to be_instance_of(CityPayApiClient::BatchReportRequest)
|
25
23
|
end
|
26
24
|
end
|
27
25
|
describe 'test attribute "account_id"' do
|
@@ -17,11 +17,9 @@ require 'date'
|
|
17
17
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe CityPayApiClient::BatchReportResponseModel do
|
20
|
-
let(:instance) { CityPayApiClient::BatchReportResponseModel.new }
|
21
20
|
|
22
21
|
describe 'test an instance of BatchReportResponseModel' do
|
23
22
|
it 'should create an instance of BatchReportResponseModel' do
|
24
|
-
expect(instance).to be_instance_of(CityPayApiClient::BatchReportResponseModel)
|
25
23
|
end
|
26
24
|
end
|
27
25
|
describe 'test attribute "account_id"' do
|
data/spec/models/batch_spec.rb
CHANGED
@@ -17,11 +17,9 @@ require 'date'
|
|
17
17
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe CityPayApiClient::Batch do
|
20
|
-
let(:instance) { CityPayApiClient::Batch.new }
|
21
20
|
|
22
21
|
describe 'test an instance of Batch' do
|
23
22
|
it 'should create an instance of Batch' do
|
24
|
-
expect(instance).to be_instance_of(CityPayApiClient::Batch)
|
25
23
|
end
|
26
24
|
end
|
27
25
|
describe 'test attribute "batch_date"' do
|
@@ -0,0 +1,47 @@
|
|
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 'spec_helper'
|
13
|
+
require 'json'
|
14
|
+
require 'date'
|
15
|
+
|
16
|
+
# Unit tests for CityPayApiClient::BatchTransactionReportRequest
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe CityPayApiClient::BatchTransactionReportRequest do
|
20
|
+
let(:instance) { CityPayApiClient::BatchTransactionReportRequest.new }
|
21
|
+
|
22
|
+
describe 'test an instance of BatchTransactionReportRequest' do
|
23
|
+
it 'should create an instance of BatchTransactionReportRequest' do
|
24
|
+
# uncomment below to test the instance creation
|
25
|
+
#expect(instance).to be_instance_of(CityPayApiClient::BatchTransactionReportRequest)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test attribute "max_results"' do
|
30
|
+
it 'should work' do
|
31
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
describe 'test attribute "next_token"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "order_by"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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 'spec_helper'
|
13
|
+
require 'json'
|
14
|
+
require 'date'
|
15
|
+
|
16
|
+
# Unit tests for CityPayApiClient::BatchTransactionReportResponse
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe CityPayApiClient::BatchTransactionReportResponse do
|
20
|
+
let(:instance) { CityPayApiClient::BatchTransactionReportResponse.new }
|
21
|
+
|
22
|
+
describe 'test an instance of BatchTransactionReportResponse' do
|
23
|
+
it 'should create an instance of BatchTransactionReportResponse' do
|
24
|
+
# uncomment below to test the instance creation
|
25
|
+
#expect(instance).to be_instance_of(CityPayApiClient::BatchTransactionReportResponse)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test attribute "count"' do
|
30
|
+
it 'should work' do
|
31
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
describe 'test attribute "data"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "max_results"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
describe 'test attribute "next_token"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|