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.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +73 -0
  3. data/README.md +59 -32
  4. data/citypay_api_client.gemspec +1 -1
  5. data/docs/Acknowledgement.md +2 -2
  6. data/docs/AclCheckResponseModel.md +3 -3
  7. data/docs/AuthRequest.md +7 -7
  8. data/docs/AuthResponse.md +4 -4
  9. data/docs/AuthorisationAndPaymentApi.md +75 -231
  10. data/docs/Batch.md +1 -1
  11. data/docs/BatchProcessingApi.md +11 -11
  12. data/docs/BatchReportResponseModel.md +2 -2
  13. data/docs/BatchTransaction.md +1 -1
  14. data/docs/BatchTransactionReportRequest.md +22 -0
  15. data/docs/BatchTransactionReportResponse.md +24 -0
  16. data/docs/BatchTransactionResultModel.md +1 -1
  17. data/docs/Bin.md +2 -2
  18. data/docs/CaptureRequest.md +1 -1
  19. data/docs/Card.md +2 -2
  20. data/docs/CardHolderAccountApi.md +9 -5
  21. data/docs/ChargeRequest.md +7 -7
  22. data/docs/Decision.md +0 -2
  23. data/docs/DirectPostApi.md +2 -16
  24. data/docs/DirectPostRequest.md +7 -7
  25. data/docs/EventDataModel.md +2 -2
  26. data/docs/MerchantBatchReportRequest.md +28 -0
  27. data/docs/MerchantBatchReportResponse.md +24 -0
  28. data/docs/MerchantBatchResponse.md +30 -0
  29. data/docs/NetSummaryResponse.md +32 -0
  30. data/docs/PaylinkAdjustmentRequest.md +1 -1
  31. data/docs/PaylinkApi.md +141 -1
  32. data/docs/PaylinkBillPaymentTokenRequest.md +1 -1
  33. data/docs/PaylinkErrorCode.md +2 -2
  34. data/docs/PaylinkResendNotificationRequest.md +20 -0
  35. data/docs/PaylinkStateEvent.md +4 -4
  36. data/docs/PaylinkTokenCreated.md +11 -11
  37. data/docs/PaylinkTokenStatus.md +7 -7
  38. data/docs/PaylinkTokenStatusChangeRequest.md +7 -7
  39. data/docs/PaylinkTokenStatusChangeResponse.md +6 -2
  40. data/docs/PaymentIntent.md +42 -0
  41. data/docs/PaymentIntentReference.md +18 -0
  42. data/docs/RefundRequest.md +1 -1
  43. data/docs/RemittanceData.md +28 -0
  44. data/docs/RemittanceReportRequest.md +28 -0
  45. data/docs/RemittanceReportResponse.md +24 -0
  46. data/docs/RemittedClientData.md +44 -0
  47. data/docs/ReportingApi.md +378 -0
  48. data/docs/TokenisationResponseModel.md +1 -1
  49. data/lib/.DS_Store +0 -0
  50. data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +71 -3
  51. data/lib/citypay_api_client/api/batch_processing_api__.rb +7 -7
  52. data/lib/citypay_api_client/api/card_holder_account_api__.rb +4 -1
  53. data/lib/citypay_api_client/api/direct_post_api__.rb +5 -5
  54. data/lib/citypay_api_client/api/operational_functions_api__.rb +1 -1
  55. data/lib/citypay_api_client/api/paylink_api__.rb +138 -1
  56. data/lib/citypay_api_client/api/reporting_api__.rb +381 -0
  57. data/lib/citypay_api_client/api_client.rb +1 -1
  58. data/lib/citypay_api_client/api_error.rb +1 -1
  59. data/lib/citypay_api_client/configuration.rb +1 -1
  60. data/lib/citypay_api_client/models/account_create.rb +1 -1
  61. data/lib/citypay_api_client/models/account_status.rb +1 -1
  62. data/lib/citypay_api_client/models/acknowledgement.rb +1 -29
  63. data/lib/citypay_api_client/models/acl_check_request.rb +1 -1
  64. data/lib/citypay_api_client/models/acl_check_response_model.rb +2 -2
  65. data/lib/citypay_api_client/models/airline_advice.rb +1 -1
  66. data/lib/citypay_api_client/models/airline_segment.rb +1 -1
  67. data/lib/citypay_api_client/models/auth_reference.rb +1 -1
  68. data/lib/citypay_api_client/models/auth_references.rb +1 -1
  69. data/lib/citypay_api_client/models/auth_request.rb +10 -9
  70. data/lib/citypay_api_client/models/auth_response.rb +2 -2
  71. data/lib/citypay_api_client/models/batch.rb +2 -2
  72. data/lib/citypay_api_client/models/batch_report_request.rb +1 -1
  73. data/lib/citypay_api_client/models/batch_report_response_model.rb +2 -2
  74. data/lib/citypay_api_client/models/batch_transaction.rb +1 -1
  75. data/lib/citypay_api_client/models/batch_transaction_report_request.rb +234 -0
  76. data/lib/citypay_api_client/models/batch_transaction_report_response.rb +252 -0
  77. data/lib/citypay_api_client/models/batch_transaction_result_model.rb +1 -1
  78. data/lib/citypay_api_client/models/bin.rb +1 -1
  79. data/lib/citypay_api_client/models/bin_lookup.rb +1 -1
  80. data/lib/citypay_api_client/models/c_res_auth_request.rb +1 -1
  81. data/lib/citypay_api_client/models/capture_request.rb +1 -1
  82. data/lib/citypay_api_client/models/card.rb +1 -1
  83. data/lib/citypay_api_client/models/card_holder_account.rb +1 -1
  84. data/lib/citypay_api_client/models/card_status.rb +1 -1
  85. data/lib/citypay_api_client/models/charge_request.rb +10 -9
  86. data/lib/citypay_api_client/models/check_batch_status.rb +1 -1
  87. data/lib/citypay_api_client/models/check_batch_status_response.rb +1 -1
  88. data/lib/citypay_api_client/models/contact_details.rb +1 -1
  89. data/lib/citypay_api_client/models/decision.rb +2 -11
  90. data/lib/citypay_api_client/models/direct_post_request.rb +10 -9
  91. data/lib/citypay_api_client/models/direct_token_auth_request.rb +1 -1
  92. data/lib/citypay_api_client/models/domain_key_check_request.rb +1 -1
  93. data/lib/citypay_api_client/models/domain_key_request.rb +1 -1
  94. data/lib/citypay_api_client/models/domain_key_response.rb +1 -1
  95. data/lib/citypay_api_client/models/error.rb +1 -1
  96. data/lib/citypay_api_client/models/event_data_model.rb +1 -1
  97. data/lib/citypay_api_client/models/exists.rb +1 -1
  98. data/lib/citypay_api_client/models/external_mpi.rb +1 -1
  99. data/lib/citypay_api_client/models/list_merchants_response.rb +1 -1
  100. data/lib/citypay_api_client/models/mcc6012.rb +1 -1
  101. data/lib/citypay_api_client/models/merchant.rb +1 -1
  102. data/lib/citypay_api_client/models/merchant_batch_report_request.rb +265 -0
  103. data/lib/citypay_api_client/models/merchant_batch_report_response.rb +252 -0
  104. data/lib/citypay_api_client/models/merchant_batch_response.rb +301 -0
  105. data/lib/citypay_api_client/models/net_summary_response.rb +472 -0
  106. data/lib/citypay_api_client/models/pa_res_auth_request.rb +1 -1
  107. data/lib/citypay_api_client/models/paylink_address.rb +1 -1
  108. data/lib/citypay_api_client/models/paylink_adjustment_request.rb +1 -1
  109. data/lib/citypay_api_client/models/paylink_attachment_request.rb +1 -1
  110. data/lib/citypay_api_client/models/paylink_attachment_result.rb +1 -1
  111. data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +1 -1
  112. data/lib/citypay_api_client/models/paylink_card_holder.rb +1 -1
  113. data/lib/citypay_api_client/models/paylink_cart.rb +1 -1
  114. data/lib/citypay_api_client/models/paylink_cart_item_model.rb +1 -1
  115. data/lib/citypay_api_client/models/paylink_config.rb +1 -1
  116. data/lib/citypay_api_client/models/paylink_custom_param.rb +1 -1
  117. data/lib/citypay_api_client/models/paylink_email_notification_path.rb +1 -1
  118. data/lib/citypay_api_client/models/paylink_error_code.rb +1 -1
  119. data/lib/citypay_api_client/models/paylink_field_guard_model.rb +1 -1
  120. data/lib/citypay_api_client/models/paylink_part_payments.rb +1 -1
  121. data/lib/citypay_api_client/models/paylink_resend_notification_request.rb +224 -0
  122. data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +1 -1
  123. data/lib/citypay_api_client/models/paylink_state_event.rb +2 -2
  124. data/lib/citypay_api_client/models/paylink_token_created.rb +36 -8
  125. data/lib/citypay_api_client/models/paylink_token_request_model.rb +1 -1
  126. data/lib/citypay_api_client/models/paylink_token_status.rb +30 -2
  127. data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +6 -7
  128. data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +23 -3
  129. data/lib/citypay_api_client/models/paylink_ui.rb +1 -1
  130. data/lib/citypay_api_client/models/payment_intent.rb +479 -0
  131. data/lib/citypay_api_client/models/payment_intent_reference.rb +221 -0
  132. data/lib/citypay_api_client/models/ping.rb +1 -1
  133. data/lib/citypay_api_client/models/process_batch_request.rb +1 -1
  134. data/lib/citypay_api_client/models/process_batch_response.rb +1 -1
  135. data/lib/citypay_api_client/models/refund_request.rb +1 -1
  136. data/lib/citypay_api_client/models/register_card.rb +1 -1
  137. data/lib/citypay_api_client/models/remittance_data.rb +404 -0
  138. data/lib/citypay_api_client/models/remittance_report_request.rb +265 -0
  139. data/lib/citypay_api_client/models/remittance_report_response.rb +252 -0
  140. data/lib/citypay_api_client/models/remitted_client_data.rb +612 -0
  141. data/lib/citypay_api_client/models/request_challenged.rb +1 -1
  142. data/lib/citypay_api_client/models/retrieve_request.rb +1 -1
  143. data/lib/citypay_api_client/models/three_d_secure.rb +1 -1
  144. data/lib/citypay_api_client/models/tokenisation_response_model.rb +1 -1
  145. data/lib/citypay_api_client/models/void_request.rb +1 -1
  146. data/lib/citypay_api_client/version.rb +2 -2
  147. data/lib/citypay_api_client.rb +15 -2
  148. data/spec/.DS_Store +0 -0
  149. data/spec/api/reporting_api___spec.rb +99 -0
  150. data/spec/it_api_sandbox_spec.rb +0 -3
  151. data/spec/models/batch_transaction_report_request_spec.rb +47 -0
  152. data/spec/models/batch_transaction_report_response_spec.rb +53 -0
  153. data/spec/models/decision_spec.rb +0 -26
  154. data/spec/models/merchant_batch_report_request_spec.rb +65 -0
  155. data/spec/models/merchant_batch_report_response_spec.rb +53 -0
  156. data/spec/models/merchant_batch_response_spec.rb +71 -0
  157. data/spec/models/net_summary_response_spec.rb +77 -0
  158. data/spec/models/paylink_resend_notification_request_spec.rb +41 -0
  159. data/spec/models/payment_intent_reference_spec.rb +35 -0
  160. data/spec/models/payment_intent_spec.rb +107 -0
  161. data/spec/models/remittance_data_spec.rb +65 -0
  162. data/spec/models/remittance_report_request_spec.rb +65 -0
  163. data/spec/models/remittance_report_response_spec.rb +53 -0
  164. data/spec/models/remitted_client_data_spec.rb +113 -0
  165. data/spec/spec_helper.rb +1 -1
  166. metadata +124 -69
  167. data/spec/models/authen_required_spec.rb +0 -52
@@ -0,0 +1,113 @@
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::RemittedClientData
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe CityPayApiClient::RemittedClientData do
20
+ let(:instance) { CityPayApiClient::RemittedClientData.new }
21
+
22
+ describe 'test an instance of RemittedClientData' do
23
+ it 'should create an instance of RemittedClientData' do
24
+ # uncomment below to test the instance creation
25
+ #expect(instance).to be_instance_of(CityPayApiClient::RemittedClientData)
26
+ end
27
+ end
28
+
29
+ describe 'test attribute "batches"' 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 "clientid"' 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 "date"' 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 "date_created"' 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
+ describe 'test attribute "net_amount"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "processed_amount"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "processed_count"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
68
+ end
69
+ end
70
+
71
+ describe 'test attribute "refund_amount"' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
74
+ end
75
+ end
76
+
77
+ describe 'test attribute "refund_count"' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
80
+ end
81
+ end
82
+
83
+ describe 'test attribute "remittances"' do
84
+ it 'should work' do
85
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
86
+ end
87
+ end
88
+
89
+ describe 'test attribute "sales_amount"' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
92
+ end
93
+ end
94
+
95
+ describe 'test attribute "sales_count"' do
96
+ it 'should work' do
97
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
98
+ end
99
+ end
100
+
101
+ describe 'test attribute "settlement_implementation"' do
102
+ it 'should work' do
103
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
104
+ end
105
+ end
106
+
107
+ describe 'test attribute "uuid"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
110
+ end
111
+ end
112
+
113
+ end
data/spec/spec_helper.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #CityPay Payment API
3
3
 
4
- # This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts. ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council. These include * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP address. Our application firewalls analyse data that may be an attempt to break a large number of security common security vulnerabilities.
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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: citypay_api_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.2
4
+ version: 1.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - citypay
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-08 00:00:00.000000000 Z
11
+ date: 2024-04-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -58,6 +58,7 @@ extensions: []
58
58
  extra_rdoc_files: []
59
59
  files:
60
60
  - Gemfile
61
+ - Gemfile.lock
61
62
  - README.md
62
63
  - Rakefile
63
64
  - citypay_api_client.gemspec
@@ -79,6 +80,8 @@ files:
79
80
  - docs/BatchReportRequest.md
80
81
  - docs/BatchReportResponseModel.md
81
82
  - docs/BatchTransaction.md
83
+ - docs/BatchTransactionReportRequest.md
84
+ - docs/BatchTransactionReportResponse.md
82
85
  - docs/BatchTransactionResultModel.md
83
86
  - docs/Bin.md
84
87
  - docs/BinLookup.md
@@ -106,6 +109,10 @@ files:
106
109
  - docs/ListMerchantsResponse.md
107
110
  - docs/MCC6012.md
108
111
  - docs/Merchant.md
112
+ - docs/MerchantBatchReportRequest.md
113
+ - docs/MerchantBatchReportResponse.md
114
+ - docs/MerchantBatchResponse.md
115
+ - docs/NetSummaryResponse.md
109
116
  - docs/OperationalFunctionsApi.md
110
117
  - docs/PaResAuthRequest.md
111
118
  - docs/PaylinkAddress.md
@@ -123,6 +130,7 @@ files:
123
130
  - docs/PaylinkErrorCode.md
124
131
  - docs/PaylinkFieldGuardModel.md
125
132
  - docs/PaylinkPartPayments.md
133
+ - docs/PaylinkResendNotificationRequest.md
126
134
  - docs/PaylinkSMSNotificationPath.md
127
135
  - docs/PaylinkStateEvent.md
128
136
  - docs/PaylinkTokenCreated.md
@@ -131,11 +139,18 @@ files:
131
139
  - docs/PaylinkTokenStatusChangeRequest.md
132
140
  - docs/PaylinkTokenStatusChangeResponse.md
133
141
  - docs/PaylinkUI.md
142
+ - docs/PaymentIntent.md
143
+ - docs/PaymentIntentReference.md
134
144
  - docs/Ping.md
135
145
  - docs/ProcessBatchRequest.md
136
146
  - docs/ProcessBatchResponse.md
137
147
  - docs/RefundRequest.md
138
148
  - docs/RegisterCard.md
149
+ - docs/RemittanceData.md
150
+ - docs/RemittanceReportRequest.md
151
+ - docs/RemittanceReportResponse.md
152
+ - docs/RemittedClientData.md
153
+ - docs/ReportingApi.md
139
154
  - docs/RequestChallenged.md
140
155
  - docs/RetrieveRequest.md
141
156
  - docs/ThreeDSecure.md
@@ -164,6 +179,7 @@ files:
164
179
  - lib/citypay_api_client/api/direct_post_api__.rb
165
180
  - lib/citypay_api_client/api/operational_functions_api__.rb
166
181
  - lib/citypay_api_client/api/paylink_api__.rb
182
+ - lib/citypay_api_client/api/reporting_api__.rb
167
183
  - lib/citypay_api_client/api_client.rb
168
184
  - lib/citypay_api_client/api_error.rb
169
185
  - lib/citypay_api_client/configuration.rb
@@ -184,6 +200,8 @@ files:
184
200
  - lib/citypay_api_client/models/batch_report_request.rb
185
201
  - lib/citypay_api_client/models/batch_report_response_model.rb
186
202
  - lib/citypay_api_client/models/batch_transaction.rb
203
+ - lib/citypay_api_client/models/batch_transaction_report_request.rb
204
+ - lib/citypay_api_client/models/batch_transaction_report_response.rb
187
205
  - lib/citypay_api_client/models/batch_transaction_result_model.rb
188
206
  - lib/citypay_api_client/models/bin.rb
189
207
  - lib/citypay_api_client/models/bin_lookup.rb
@@ -209,6 +227,10 @@ files:
209
227
  - lib/citypay_api_client/models/list_merchants_response.rb
210
228
  - lib/citypay_api_client/models/mcc6012.rb
211
229
  - lib/citypay_api_client/models/merchant.rb
230
+ - lib/citypay_api_client/models/merchant_batch_report_request.rb
231
+ - lib/citypay_api_client/models/merchant_batch_report_response.rb
232
+ - lib/citypay_api_client/models/merchant_batch_response.rb
233
+ - lib/citypay_api_client/models/net_summary_response.rb
212
234
  - lib/citypay_api_client/models/pa_res_auth_request.rb
213
235
  - lib/citypay_api_client/models/paylink_address.rb
214
236
  - lib/citypay_api_client/models/paylink_adjustment_request.rb
@@ -224,6 +246,7 @@ files:
224
246
  - lib/citypay_api_client/models/paylink_error_code.rb
225
247
  - lib/citypay_api_client/models/paylink_field_guard_model.rb
226
248
  - lib/citypay_api_client/models/paylink_part_payments.rb
249
+ - lib/citypay_api_client/models/paylink_resend_notification_request.rb
227
250
  - lib/citypay_api_client/models/paylink_sms_notification_path.rb
228
251
  - lib/citypay_api_client/models/paylink_state_event.rb
229
252
  - lib/citypay_api_client/models/paylink_token_created.rb
@@ -232,11 +255,17 @@ files:
232
255
  - lib/citypay_api_client/models/paylink_token_status_change_request.rb
233
256
  - lib/citypay_api_client/models/paylink_token_status_change_response.rb
234
257
  - lib/citypay_api_client/models/paylink_ui.rb
258
+ - lib/citypay_api_client/models/payment_intent.rb
259
+ - lib/citypay_api_client/models/payment_intent_reference.rb
235
260
  - lib/citypay_api_client/models/ping.rb
236
261
  - lib/citypay_api_client/models/process_batch_request.rb
237
262
  - lib/citypay_api_client/models/process_batch_response.rb
238
263
  - lib/citypay_api_client/models/refund_request.rb
239
264
  - lib/citypay_api_client/models/register_card.rb
265
+ - lib/citypay_api_client/models/remittance_data.rb
266
+ - lib/citypay_api_client/models/remittance_report_request.rb
267
+ - lib/citypay_api_client/models/remittance_report_response.rb
268
+ - lib/citypay_api_client/models/remitted_client_data.rb
240
269
  - lib/citypay_api_client/models/request_challenged.rb
241
270
  - lib/citypay_api_client/models/retrieve_request.rb
242
271
  - lib/citypay_api_client/models/three_d_secure.rb
@@ -252,6 +281,7 @@ files:
252
281
  - spec/api/direct_post_api___spec.rb
253
282
  - spec/api/operational_functions_api___spec.rb
254
283
  - spec/api/paylink_api___spec.rb
284
+ - spec/api/reporting_api___spec.rb
255
285
  - spec/api_client_spec.rb
256
286
  - spec/configuration_spec.rb
257
287
  - spec/it_api_sandbox_spec.rb
@@ -267,10 +297,11 @@ files:
267
297
  - spec/models/auth_references_spec.rb
268
298
  - spec/models/auth_request_spec.rb
269
299
  - spec/models/auth_response_spec.rb
270
- - spec/models/authen_required_spec.rb
271
300
  - spec/models/batch_report_request_spec.rb
272
301
  - spec/models/batch_report_response_model_spec.rb
273
302
  - spec/models/batch_spec.rb
303
+ - spec/models/batch_transaction_report_request_spec.rb
304
+ - spec/models/batch_transaction_report_response_spec.rb
274
305
  - spec/models/batch_transaction_result_model_spec.rb
275
306
  - spec/models/batch_transaction_spec.rb
276
307
  - spec/models/bin_lookup_spec.rb
@@ -296,7 +327,11 @@ files:
296
327
  - spec/models/external_mpi_spec.rb
297
328
  - spec/models/list_merchants_response_spec.rb
298
329
  - spec/models/mcc6012_spec.rb
330
+ - spec/models/merchant_batch_report_request_spec.rb
331
+ - spec/models/merchant_batch_report_response_spec.rb
332
+ - spec/models/merchant_batch_response_spec.rb
299
333
  - spec/models/merchant_spec.rb
334
+ - spec/models/net_summary_response_spec.rb
300
335
  - spec/models/pa_res_auth_request_spec.rb
301
336
  - spec/models/paylink_address_spec.rb
302
337
  - spec/models/paylink_adjustment_request_spec.rb
@@ -312,6 +347,7 @@ files:
312
347
  - spec/models/paylink_error_code_spec.rb
313
348
  - spec/models/paylink_field_guard_model_spec.rb
314
349
  - spec/models/paylink_part_payments_spec.rb
350
+ - spec/models/paylink_resend_notification_request_spec.rb
315
351
  - spec/models/paylink_sms_notification_path_spec.rb
316
352
  - spec/models/paylink_state_event_spec.rb
317
353
  - spec/models/paylink_token_created_spec.rb
@@ -320,11 +356,17 @@ files:
320
356
  - spec/models/paylink_token_status_change_response_spec.rb
321
357
  - spec/models/paylink_token_status_spec.rb
322
358
  - spec/models/paylink_ui_spec.rb
359
+ - spec/models/payment_intent_reference_spec.rb
360
+ - spec/models/payment_intent_spec.rb
323
361
  - spec/models/ping_spec.rb
324
362
  - spec/models/process_batch_request_spec.rb
325
363
  - spec/models/process_batch_response_spec.rb
326
364
  - spec/models/refund_request_spec.rb
327
365
  - spec/models/register_card_spec.rb
366
+ - spec/models/remittance_data_spec.rb
367
+ - spec/models/remittance_report_request_spec.rb
368
+ - spec/models/remittance_report_response_spec.rb
369
+ - spec/models/remitted_client_data_spec.rb
328
370
  - spec/models/request_challenged_spec.rb
329
371
  - spec/models/retrieve_request_spec.rb
330
372
  - spec/models/three_d_secure_spec.rb
@@ -336,7 +378,7 @@ homepage: https://github.com/citypay/citypay-api-client-ruby
336
378
  licenses:
337
379
  - Unlicense
338
380
  metadata: {}
339
- post_install_message:
381
+ post_install_message:
340
382
  rdoc_options: []
341
383
  require_paths:
342
384
  - lib
@@ -351,94 +393,107 @@ required_rubygems_version: !ruby/object:Gem::Requirement
351
393
  - !ruby/object:Gem::Version
352
394
  version: '0'
353
395
  requirements: []
354
- rubygems_version: 3.4.10
355
- signing_key:
396
+ rubygems_version: 3.2.33
397
+ signing_key:
356
398
  specification_version: 4
357
399
  summary: A ruby wrapper for the CityPay API
358
400
  test_files:
359
- - spec/api/direct_post_api___spec.rb
360
- - spec/api/operational_functions_api___spec.rb
361
- - spec/api/authorisation_and_payment_api___spec.rb
362
401
  - spec/api/batch_processing_api___spec.rb
402
+ - spec/api/authorisation_and_payment_api___spec.rb
363
403
  - spec/api/card_holder_account_api___spec.rb
364
404
  - spec/api/paylink_api___spec.rb
405
+ - spec/api/direct_post_api___spec.rb
406
+ - spec/api/operational_functions_api___spec.rb
407
+ - spec/api/reporting_api___spec.rb
365
408
  - spec/api_client_spec.rb
366
409
  - spec/configuration_spec.rb
367
410
  - spec/it_api_sandbox_spec.rb
368
- - spec/models/error_spec.rb
369
- - spec/models/direct_token_auth_request_spec.rb
370
- - spec/models/batch_spec.rb
371
- - spec/models/paylink_token_status_change_request_spec.rb
372
- - spec/models/batch_transaction_result_model_spec.rb
373
- - spec/models/capture_request_spec.rb
374
- - spec/models/paylink_bill_payment_token_request_spec.rb
375
- - spec/models/paylink_email_notification_path_spec.rb
376
- - spec/models/acknowledgement_spec.rb
377
- - spec/models/paylink_field_guard_model_spec.rb
378
- - spec/models/external_mpi_spec.rb
379
- - spec/models/paylink_config_spec.rb
380
- - spec/models/paylink_token_status_spec.rb
381
- - spec/models/paylink_address_spec.rb
382
- - spec/models/domain_key_check_request_spec.rb
383
- - spec/models/bin_spec.rb
384
- - spec/models/domain_key_request_spec.rb
385
- - spec/models/paylink_attachment_result_spec.rb
386
- - spec/models/paylink_card_holder_spec.rb
387
- - spec/models/domain_key_response_spec.rb
388
- - spec/models/tokenisation_response_model_spec.rb
411
+ - spec/models/batch_report_request_spec.rb
412
+ - spec/models/auth_reference_spec.rb
413
+ - spec/models/account_status_spec.rb
389
414
  - spec/models/decision_spec.rb
390
- - spec/models/acl_check_response_model_spec.rb
391
- - spec/models/acl_check_request_spec.rb
392
415
  - spec/models/airline_advice_spec.rb
393
- - spec/models/retrieve_request_spec.rb
394
- - spec/models/paylink_adjustment_request_spec.rb
395
- - spec/models/direct_post_request_spec.rb
396
416
  - spec/models/paylink_token_request_model_spec.rb
397
- - spec/models/paylink_sms_notification_path_spec.rb
398
- - spec/models/ping_spec.rb
399
- - spec/models/process_batch_response_spec.rb
400
- - spec/models/card_holder_account_spec.rb
401
- - spec/models/exists_spec.rb
417
+ - spec/models/domain_key_response_spec.rb
402
418
  - spec/models/c_res_auth_request_spec.rb
403
- - spec/models/paylink_ui_spec.rb
404
- - spec/models/airline_segment_spec.rb
405
- - spec/models/card_spec.rb
406
- - spec/models/paylink_state_event_spec.rb
407
- - spec/models/api_key_spec.rb
419
+ - spec/models/payment_intent_spec.rb
408
420
  - spec/models/auth_references_spec.rb
409
- - spec/models/batch_report_response_model_spec.rb
410
- - spec/models/paylink_cart_item_model_spec.rb
411
- - spec/models/list_merchants_response_spec.rb
412
- - spec/models/batch_transaction_spec.rb
413
- - spec/models/void_request_spec.rb
414
- - spec/models/auth_request_spec.rb
421
+ - spec/models/paylink_adjustment_request_spec.rb
422
+ - spec/models/paylink_custom_param_spec.rb
423
+ - spec/models/direct_post_request_spec.rb
424
+ - spec/models/remittance_data_spec.rb
425
+ - spec/models/tokenisation_response_model_spec.rb
415
426
  - spec/models/paylink_attachment_request_spec.rb
416
- - spec/models/register_card_spec.rb
417
- - spec/models/paylink_cart_spec.rb
418
427
  - spec/models/event_data_model_spec.rb
428
+ - spec/models/paylink_card_holder_spec.rb
419
429
  - spec/models/paylink_token_status_change_response_spec.rb
430
+ - spec/models/api_key_spec.rb
431
+ - spec/models/paylink_config_spec.rb
432
+ - spec/models/remittance_report_response_spec.rb
433
+ - spec/models/charge_request_spec.rb
434
+ - spec/models/three_d_secure_spec.rb
435
+ - spec/models/paylink_token_status_spec.rb
420
436
  - spec/models/check_batch_status_spec.rb
421
- - spec/models/paylink_custom_param_spec.rb
422
- - spec/models/account_status_spec.rb
423
- - spec/models/auth_response_spec.rb
424
- - spec/models/refund_request_spec.rb
425
437
  - spec/models/request_challenged_spec.rb
438
+ - spec/models/remitted_client_data_spec.rb
439
+ - spec/models/merchant_batch_response_spec.rb
440
+ - spec/models/paylink_error_code_spec.rb
441
+ - spec/models/paylink_cart_item_model_spec.rb
442
+ - spec/models/process_batch_response_spec.rb
443
+ - spec/models/card_holder_account_spec.rb
444
+ - spec/models/paylink_state_event_spec.rb
445
+ - spec/models/batch_transaction_report_request_spec.rb
446
+ - spec/models/paylink_field_guard_model_spec.rb
447
+ - spec/models/auth_response_spec.rb
448
+ - spec/models/paylink_resend_notification_request_spec.rb
449
+ - spec/models/external_mpi_spec.rb
450
+ - spec/models/pa_res_auth_request_spec.rb
451
+ - spec/models/domain_key_request_spec.rb
452
+ - spec/models/paylink_attachment_result_spec.rb
453
+ - spec/models/list_merchants_response_spec.rb
454
+ - spec/models/batch_transaction_report_response_spec.rb
455
+ - spec/models/domain_key_check_request_spec.rb
426
456
  - spec/models/account_create_spec.rb
427
- - spec/models/merchant_spec.rb
457
+ - spec/models/register_card_spec.rb
428
458
  - spec/models/contact_details_spec.rb
459
+ - spec/models/payment_intent_reference_spec.rb
460
+ - spec/models/acknowledgement_spec.rb
461
+ - spec/models/capture_request_spec.rb
462
+ - spec/models/auth_request_spec.rb
463
+ - spec/models/bin_spec.rb
464
+ - spec/models/merchant_spec.rb
465
+ - spec/models/paylink_sms_notification_path_spec.rb
466
+ - spec/models/acl_check_request_spec.rb
467
+ - spec/models/airline_segment_spec.rb
468
+ - spec/models/ping_spec.rb
469
+ - spec/models/paylink_ui_spec.rb
470
+ - spec/models/card_spec.rb
471
+ - spec/models/exists_spec.rb
472
+ - spec/models/void_request_spec.rb
473
+ - spec/models/card_status_spec.rb
474
+ - spec/models/batch_transaction_spec.rb
475
+ - spec/models/remittance_report_request_spec.rb
476
+ - spec/models/merchant_batch_report_response_spec.rb
477
+ - spec/models/paylink_email_notification_path_spec.rb
429
478
  - spec/models/process_batch_request_spec.rb
430
- - spec/models/charge_request_spec.rb
479
+ - spec/models/paylink_address_spec.rb
480
+ - spec/models/merchant_batch_report_request_spec.rb
481
+ - spec/models/paylink_part_payments_spec.rb
482
+ - spec/models/batch_transaction_result_model_spec.rb
483
+ - spec/models/batch_report_response_model_spec.rb
484
+ - spec/models/direct_token_auth_request_spec.rb
485
+ - spec/models/retrieve_request_spec.rb
486
+ - spec/models/net_summary_response_spec.rb
431
487
  - spec/models/paylink_token_created_spec.rb
488
+ - spec/models/acl_check_response_model_spec.rb
489
+ - spec/models/refund_request_spec.rb
490
+ - spec/models/batch_spec.rb
432
491
  - spec/models/mcc6012_spec.rb
433
- - spec/models/paylink_part_payments_spec.rb
434
- - spec/models/paylink_error_code_spec.rb
435
- - spec/models/check_batch_status_response_spec.rb
436
- - spec/models/card_status_spec.rb
492
+ - spec/models/error_spec.rb
493
+ - spec/models/paylink_cart_spec.rb
494
+ - spec/models/paylink_bill_payment_token_request_spec.rb
437
495
  - spec/models/bin_lookup_spec.rb
438
- - spec/models/pa_res_auth_request_spec.rb
439
- - spec/models/authen_required_spec.rb
440
- - spec/models/batch_report_request_spec.rb
441
- - spec/models/three_d_secure_spec.rb
442
- - spec/models/auth_reference_spec.rb
496
+ - spec/models/check_batch_status_response_spec.rb
497
+ - spec/models/paylink_token_status_change_request_spec.rb
443
498
  - spec/spec_helper.rb
444
499
  - spec/utils/direct_post_mac_spec.rb
@@ -1,52 +0,0 @@
1
- =begin
2
- #CityPay Payment API
3
-
4
- # This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts. ## Compliance and Security <aside class=\"notice\"> Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside> * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP address. Our application firewalls analyse data that may be an attempt to break a large number of security common security vulnerabilities.
5
-
6
- Contact: support@citypay.com
7
- Generated by: https://openapi-generator.tech
8
- OpenAPI Generator version: 5.0.0-SNAPSHOT
9
-
10
- =end
11
-
12
- require 'spec_helper'
13
- require 'json'
14
- require 'date'
15
-
16
- # Unit tests for CityPayApiClient::AuthenRequired
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'AuthenRequired' do
20
- before do
21
- # run before each test
22
- @instance = CityPayApiClient::AuthenRequired.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of AuthenRequired' do
30
- it 'should create an instance of AuthenRequired' do
31
- expect(@instance).to be_instance_of(CityPayApiClient::AuthenRequired)
32
- end
33
- end
34
- describe 'test attribute "acs_url"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "md"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "pareq"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- end