citypay_api_client 1.1.2 → 1.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +73 -0
- data/README.md +59 -32
- data/citypay_api_client.gemspec +1 -1
- data/docs/Acknowledgement.md +2 -2
- data/docs/AclCheckResponseModel.md +3 -3
- data/docs/AuthRequest.md +7 -7
- data/docs/AuthResponse.md +4 -4
- data/docs/AuthorisationAndPaymentApi.md +75 -231
- data/docs/Batch.md +1 -1
- data/docs/BatchProcessingApi.md +11 -11
- data/docs/BatchReportResponseModel.md +2 -2
- data/docs/BatchTransaction.md +1 -1
- data/docs/BatchTransactionReportRequest.md +22 -0
- data/docs/BatchTransactionReportResponse.md +24 -0
- data/docs/BatchTransactionResultModel.md +1 -1
- data/docs/Bin.md +2 -2
- data/docs/CaptureRequest.md +1 -1
- data/docs/Card.md +2 -2
- data/docs/CardHolderAccountApi.md +9 -5
- data/docs/ChargeRequest.md +7 -7
- data/docs/Decision.md +0 -2
- data/docs/DirectPostApi.md +2 -16
- data/docs/DirectPostRequest.md +7 -7
- data/docs/EventDataModel.md +2 -2
- data/docs/MerchantBatchReportRequest.md +28 -0
- data/docs/MerchantBatchReportResponse.md +24 -0
- data/docs/MerchantBatchResponse.md +30 -0
- data/docs/NetSummaryResponse.md +32 -0
- data/docs/PaylinkAdjustmentRequest.md +1 -1
- data/docs/PaylinkApi.md +141 -1
- data/docs/PaylinkBillPaymentTokenRequest.md +1 -1
- data/docs/PaylinkErrorCode.md +2 -2
- data/docs/PaylinkResendNotificationRequest.md +20 -0
- data/docs/PaylinkStateEvent.md +4 -4
- data/docs/PaylinkTokenCreated.md +11 -11
- data/docs/PaylinkTokenStatus.md +7 -7
- data/docs/PaylinkTokenStatusChangeRequest.md +7 -7
- data/docs/PaylinkTokenStatusChangeResponse.md +6 -2
- data/docs/PaymentIntent.md +42 -0
- data/docs/PaymentIntentReference.md +18 -0
- data/docs/RefundRequest.md +1 -1
- data/docs/RemittanceData.md +28 -0
- data/docs/RemittanceReportRequest.md +28 -0
- data/docs/RemittanceReportResponse.md +24 -0
- data/docs/RemittedClientData.md +44 -0
- data/docs/ReportingApi.md +378 -0
- data/docs/TokenisationResponseModel.md +1 -1
- data/lib/.DS_Store +0 -0
- data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +71 -3
- data/lib/citypay_api_client/api/batch_processing_api__.rb +7 -7
- data/lib/citypay_api_client/api/card_holder_account_api__.rb +4 -1
- data/lib/citypay_api_client/api/direct_post_api__.rb +5 -5
- data/lib/citypay_api_client/api/operational_functions_api__.rb +1 -1
- data/lib/citypay_api_client/api/paylink_api__.rb +138 -1
- data/lib/citypay_api_client/api/reporting_api__.rb +381 -0
- data/lib/citypay_api_client/api_client.rb +1 -1
- data/lib/citypay_api_client/api_error.rb +1 -1
- data/lib/citypay_api_client/configuration.rb +1 -1
- data/lib/citypay_api_client/models/account_create.rb +1 -1
- data/lib/citypay_api_client/models/account_status.rb +1 -1
- data/lib/citypay_api_client/models/acknowledgement.rb +1 -29
- data/lib/citypay_api_client/models/acl_check_request.rb +1 -1
- data/lib/citypay_api_client/models/acl_check_response_model.rb +2 -2
- data/lib/citypay_api_client/models/airline_advice.rb +1 -1
- data/lib/citypay_api_client/models/airline_segment.rb +1 -1
- data/lib/citypay_api_client/models/auth_reference.rb +1 -1
- data/lib/citypay_api_client/models/auth_references.rb +1 -1
- data/lib/citypay_api_client/models/auth_request.rb +10 -9
- data/lib/citypay_api_client/models/auth_response.rb +2 -2
- data/lib/citypay_api_client/models/batch.rb +2 -2
- data/lib/citypay_api_client/models/batch_report_request.rb +1 -1
- data/lib/citypay_api_client/models/batch_report_response_model.rb +2 -2
- data/lib/citypay_api_client/models/batch_transaction.rb +1 -1
- data/lib/citypay_api_client/models/batch_transaction_report_request.rb +234 -0
- data/lib/citypay_api_client/models/batch_transaction_report_response.rb +252 -0
- data/lib/citypay_api_client/models/batch_transaction_result_model.rb +1 -1
- data/lib/citypay_api_client/models/bin.rb +1 -1
- data/lib/citypay_api_client/models/bin_lookup.rb +1 -1
- data/lib/citypay_api_client/models/c_res_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/capture_request.rb +1 -1
- data/lib/citypay_api_client/models/card.rb +1 -1
- data/lib/citypay_api_client/models/card_holder_account.rb +1 -1
- data/lib/citypay_api_client/models/card_status.rb +1 -1
- data/lib/citypay_api_client/models/charge_request.rb +10 -9
- data/lib/citypay_api_client/models/check_batch_status.rb +1 -1
- data/lib/citypay_api_client/models/check_batch_status_response.rb +1 -1
- data/lib/citypay_api_client/models/contact_details.rb +1 -1
- data/lib/citypay_api_client/models/decision.rb +2 -11
- data/lib/citypay_api_client/models/direct_post_request.rb +10 -9
- data/lib/citypay_api_client/models/direct_token_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_check_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_request.rb +1 -1
- data/lib/citypay_api_client/models/domain_key_response.rb +1 -1
- data/lib/citypay_api_client/models/error.rb +1 -1
- data/lib/citypay_api_client/models/event_data_model.rb +1 -1
- data/lib/citypay_api_client/models/exists.rb +1 -1
- data/lib/citypay_api_client/models/external_mpi.rb +1 -1
- data/lib/citypay_api_client/models/list_merchants_response.rb +1 -1
- data/lib/citypay_api_client/models/mcc6012.rb +1 -1
- data/lib/citypay_api_client/models/merchant.rb +1 -1
- data/lib/citypay_api_client/models/merchant_batch_report_request.rb +265 -0
- data/lib/citypay_api_client/models/merchant_batch_report_response.rb +252 -0
- data/lib/citypay_api_client/models/merchant_batch_response.rb +301 -0
- data/lib/citypay_api_client/models/net_summary_response.rb +472 -0
- data/lib/citypay_api_client/models/pa_res_auth_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_address.rb +1 -1
- data/lib/citypay_api_client/models/paylink_adjustment_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_attachment_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_attachment_result.rb +1 -1
- data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +1 -1
- data/lib/citypay_api_client/models/paylink_card_holder.rb +1 -1
- data/lib/citypay_api_client/models/paylink_cart.rb +1 -1
- data/lib/citypay_api_client/models/paylink_cart_item_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_config.rb +1 -1
- data/lib/citypay_api_client/models/paylink_custom_param.rb +1 -1
- data/lib/citypay_api_client/models/paylink_email_notification_path.rb +1 -1
- data/lib/citypay_api_client/models/paylink_error_code.rb +1 -1
- data/lib/citypay_api_client/models/paylink_field_guard_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_part_payments.rb +1 -1
- data/lib/citypay_api_client/models/paylink_resend_notification_request.rb +224 -0
- data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +1 -1
- data/lib/citypay_api_client/models/paylink_state_event.rb +2 -2
- data/lib/citypay_api_client/models/paylink_token_created.rb +36 -8
- data/lib/citypay_api_client/models/paylink_token_request_model.rb +1 -1
- data/lib/citypay_api_client/models/paylink_token_status.rb +30 -2
- data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +6 -7
- data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +23 -3
- data/lib/citypay_api_client/models/paylink_ui.rb +1 -1
- data/lib/citypay_api_client/models/payment_intent.rb +479 -0
- data/lib/citypay_api_client/models/payment_intent_reference.rb +221 -0
- data/lib/citypay_api_client/models/ping.rb +1 -1
- data/lib/citypay_api_client/models/process_batch_request.rb +1 -1
- data/lib/citypay_api_client/models/process_batch_response.rb +1 -1
- data/lib/citypay_api_client/models/refund_request.rb +1 -1
- data/lib/citypay_api_client/models/register_card.rb +1 -1
- data/lib/citypay_api_client/models/remittance_data.rb +404 -0
- data/lib/citypay_api_client/models/remittance_report_request.rb +265 -0
- data/lib/citypay_api_client/models/remittance_report_response.rb +252 -0
- data/lib/citypay_api_client/models/remitted_client_data.rb +612 -0
- data/lib/citypay_api_client/models/request_challenged.rb +1 -1
- data/lib/citypay_api_client/models/retrieve_request.rb +1 -1
- data/lib/citypay_api_client/models/three_d_secure.rb +1 -1
- data/lib/citypay_api_client/models/tokenisation_response_model.rb +1 -1
- data/lib/citypay_api_client/models/void_request.rb +1 -1
- data/lib/citypay_api_client/version.rb +2 -2
- data/lib/citypay_api_client.rb +15 -2
- data/spec/.DS_Store +0 -0
- data/spec/api/reporting_api___spec.rb +99 -0
- data/spec/it_api_sandbox_spec.rb +0 -3
- data/spec/models/batch_transaction_report_request_spec.rb +47 -0
- data/spec/models/batch_transaction_report_response_spec.rb +53 -0
- data/spec/models/decision_spec.rb +0 -26
- data/spec/models/merchant_batch_report_request_spec.rb +65 -0
- data/spec/models/merchant_batch_report_response_spec.rb +53 -0
- data/spec/models/merchant_batch_response_spec.rb +71 -0
- data/spec/models/net_summary_response_spec.rb +77 -0
- data/spec/models/paylink_resend_notification_request_spec.rb +41 -0
- data/spec/models/payment_intent_reference_spec.rb +35 -0
- data/spec/models/payment_intent_spec.rb +107 -0
- data/spec/models/remittance_data_spec.rb +65 -0
- data/spec/models/remittance_report_request_spec.rb +65 -0
- data/spec/models/remittance_report_response_spec.rb +53 -0
- data/spec/models/remitted_client_data_spec.rb +113 -0
- data/spec/spec_helper.rb +1 -1
- metadata +124 -69
- data/spec/models/authen_required_spec.rb +0 -52
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d36a0f3efd58bb02a74314352277a877855ab8540b9e2399ad12ac125ffe7ec1
|
|
4
|
+
data.tar.gz: 517784392d04121ee29768f3a9c540aafa20743664bf903d4a33a5d3fa9a5d45
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 102eb7ba9af62abba36e41d497df25eb18d152729d5153d61c3535cb2e043b66b80555b904858060f5fb9504db2a118c7d291f20ae4c8a3e2795931d0c3b1854
|
|
7
|
+
data.tar.gz: b8da4880b88398be310be4ba3de35550bb9cd1d87d01dea2a519a2d38bbc524d87d2617b45062f80e5d11982d43d7ff93e3aaf6e529585d56181217e924db838
|
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
citypay_api_client (1.1.3)
|
|
5
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
|
+
|
|
7
|
+
GEM
|
|
8
|
+
remote: https://rubygems.org/
|
|
9
|
+
specs:
|
|
10
|
+
ast (2.4.2)
|
|
11
|
+
byebug (11.1.3)
|
|
12
|
+
coderay (1.1.3)
|
|
13
|
+
diff-lcs (1.5.1)
|
|
14
|
+
ethon (0.16.0)
|
|
15
|
+
ffi (>= 1.15.0)
|
|
16
|
+
ffi (1.16.3)
|
|
17
|
+
jaro_winkler (1.5.6)
|
|
18
|
+
method_source (1.1.0)
|
|
19
|
+
parallel (1.24.0)
|
|
20
|
+
parser (3.3.1.0)
|
|
21
|
+
ast (~> 2.4.1)
|
|
22
|
+
racc
|
|
23
|
+
pry (0.14.2)
|
|
24
|
+
coderay (~> 1.1)
|
|
25
|
+
method_source (~> 1.0)
|
|
26
|
+
pry-byebug (3.10.1)
|
|
27
|
+
byebug (~> 11.0)
|
|
28
|
+
pry (>= 0.13, < 0.15)
|
|
29
|
+
psych (5.1.2)
|
|
30
|
+
stringio
|
|
31
|
+
racc (1.7.3)
|
|
32
|
+
rainbow (3.1.1)
|
|
33
|
+
rake (13.0.6)
|
|
34
|
+
rspec (3.13.0)
|
|
35
|
+
rspec-core (~> 3.13.0)
|
|
36
|
+
rspec-expectations (~> 3.13.0)
|
|
37
|
+
rspec-mocks (~> 3.13.0)
|
|
38
|
+
rspec-core (3.13.0)
|
|
39
|
+
rspec-support (~> 3.13.0)
|
|
40
|
+
rspec-expectations (3.13.0)
|
|
41
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
42
|
+
rspec-support (~> 3.13.0)
|
|
43
|
+
rspec-mocks (3.13.0)
|
|
44
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
45
|
+
rspec-support (~> 3.13.0)
|
|
46
|
+
rspec-support (3.13.1)
|
|
47
|
+
rubocop (0.66.0)
|
|
48
|
+
jaro_winkler (~> 1.5.1)
|
|
49
|
+
parallel (~> 1.10)
|
|
50
|
+
parser (>= 2.5, != 2.5.1.1)
|
|
51
|
+
psych (>= 3.1.0)
|
|
52
|
+
rainbow (>= 2.2.2, < 4.0)
|
|
53
|
+
ruby-progressbar (~> 1.7)
|
|
54
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
|
55
|
+
ruby-progressbar (1.13.0)
|
|
56
|
+
stringio (3.1.0)
|
|
57
|
+
typhoeus (1.4.1)
|
|
58
|
+
ethon (>= 0.9.0)
|
|
59
|
+
unicode-display_width (1.5.0)
|
|
60
|
+
|
|
61
|
+
PLATFORMS
|
|
62
|
+
ruby
|
|
63
|
+
x86_64-linux
|
|
64
|
+
|
|
65
|
+
DEPENDENCIES
|
|
66
|
+
citypay_api_client!
|
|
67
|
+
pry-byebug
|
|
68
|
+
rake (~> 13.0.1)
|
|
69
|
+
rspec (~> 3.6, >= 3.6.0)
|
|
70
|
+
rubocop (~> 0.66.0)
|
|
71
|
+
|
|
72
|
+
BUNDLED WITH
|
|
73
|
+
2.5.9
|
data/README.md
CHANGED
|
@@ -4,35 +4,42 @@ CityPayApiClient - the Ruby gem for the CityPay Payment API
|
|
|
4
4
|
[](https://github.com/citypay/citypay-api-client-ruby/actions/workflows/build.yml)
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
*
|
|
26
|
-
|
|
27
|
-
*
|
|
28
|
-
|
|
29
|
-
|
|
7
|
+
Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server
|
|
8
|
+
transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.
|
|
9
|
+
Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing
|
|
10
|
+
Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure
|
|
11
|
+
authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for
|
|
12
|
+
Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability
|
|
13
|
+
for tokenised payments.
|
|
14
|
+
|
|
15
|
+
## Compliance and Security Overview
|
|
16
|
+
<aside class=\"notice\">
|
|
17
|
+
Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is
|
|
18
|
+
designed with stringent security measures and compliance protocols to safeguard sensitive information and meet
|
|
19
|
+
the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council.
|
|
20
|
+
</aside>
|
|
21
|
+
|
|
22
|
+
### Key Compliance and Security Measures
|
|
23
|
+
|
|
24
|
+
* **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.
|
|
25
|
+
* **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.
|
|
26
|
+
* **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.
|
|
27
|
+
* **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.
|
|
28
|
+
* **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/).
|
|
29
|
+
* **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.
|
|
30
|
+
|
|
31
|
+
## Getting Started
|
|
32
|
+
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.
|
|
33
|
+
|
|
34
|
+
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.
|
|
35
|
+
|
|
36
|
+
Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution.
|
|
30
37
|
|
|
31
38
|
|
|
32
39
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
33
40
|
|
|
34
|
-
- API version: 6.6.
|
|
35
|
-
- Package version: 1.1.
|
|
41
|
+
- API version: 6.6.40
|
|
42
|
+
- Package version: 1.1.3
|
|
36
43
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
37
44
|
For more information, please visit [https://www.citypay.com/contacts/](https://www.citypay.com/contacts/)
|
|
38
45
|
|
|
@@ -49,16 +56,16 @@ gem build citypay_api_client.gemspec
|
|
|
49
56
|
Then either install the gem locally:
|
|
50
57
|
|
|
51
58
|
```shell
|
|
52
|
-
gem install ./citypay_api_client-1.1.
|
|
59
|
+
gem install ./citypay_api_client-1.1.3.gem
|
|
53
60
|
```
|
|
54
61
|
|
|
55
|
-
(for development, run `gem install --dev ./citypay_api_client-1.1.
|
|
62
|
+
(for development, run `gem install --dev ./citypay_api_client-1.1.3.gem` to install the development dependencies)
|
|
56
63
|
|
|
57
64
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
58
65
|
|
|
59
66
|
Finally add this to the Gemfile:
|
|
60
67
|
|
|
61
|
-
gem 'citypay_api_client', '~> 1.1.
|
|
68
|
+
gem 'citypay_api_client', '~> 1.1.3'
|
|
62
69
|
|
|
63
70
|
### Install from Git
|
|
64
71
|
|
|
@@ -88,7 +95,7 @@ CityPayApiClient.configure do |config|
|
|
|
88
95
|
end
|
|
89
96
|
|
|
90
97
|
api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
|
|
91
|
-
auth_request = CityPayApiClient::AuthRequest.new({amount:
|
|
98
|
+
auth_request = CityPayApiClient::AuthRequest.new({amount: 19995, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest |
|
|
92
99
|
|
|
93
100
|
begin
|
|
94
101
|
#Authorisation
|
|
@@ -110,13 +117,14 @@ Class | Method | HTTP request | Description
|
|
|
110
117
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**bin_range_lookup_request**](docs/AuthorisationAndPaymentApi.md#bin_range_lookup_request) | **POST** /v6/bin | Bin Lookup
|
|
111
118
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**c_res_request**](docs/AuthorisationAndPaymentApi.md#c_res_request) | **POST** /v6/cres | CRes
|
|
112
119
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**capture_request**](docs/AuthorisationAndPaymentApi.md#capture_request) | **POST** /v6/capture | Capture
|
|
120
|
+
*CityPayApiClient::AuthorisationAndPaymentApi* | [**create_payment_intent**](docs/AuthorisationAndPaymentApi.md#create_payment_intent) | **POST** /v6/intent/create | Create a Payment Intent
|
|
113
121
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**pa_res_request**](docs/AuthorisationAndPaymentApi.md#pa_res_request) | **POST** /v6/pares | PaRes
|
|
114
122
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**refund_request**](docs/AuthorisationAndPaymentApi.md#refund_request) | **POST** /v6/refund | Refund
|
|
115
123
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**retrieval_request**](docs/AuthorisationAndPaymentApi.md#retrieval_request) | **POST** /v6/retrieve | Retrieval
|
|
116
124
|
*CityPayApiClient::AuthorisationAndPaymentApi* | [**void_request**](docs/AuthorisationAndPaymentApi.md#void_request) | **POST** /v6/void | Void
|
|
117
125
|
*CityPayApiClient::BatchProcessingApi* | [**batch_process_request**](docs/BatchProcessingApi.md#batch_process_request) | **POST** /v6/batch/process | Batch Process Request
|
|
118
|
-
*CityPayApiClient::BatchProcessingApi* | [**batch_retrieve_request**](docs/BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve |
|
|
119
|
-
*CityPayApiClient::BatchProcessingApi* | [**check_batch_status_request**](docs/BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status |
|
|
126
|
+
*CityPayApiClient::BatchProcessingApi* | [**batch_retrieve_request**](docs/BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | Batch Retrieve Request
|
|
127
|
+
*CityPayApiClient::BatchProcessingApi* | [**check_batch_status_request**](docs/BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | Check Batch Status
|
|
120
128
|
*CityPayApiClient::CardHolderAccountApi* | [**account_card_delete_request**](docs/CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /v6/account/{accountid}/card/{cardId} | Card Deletion
|
|
121
129
|
*CityPayApiClient::CardHolderAccountApi* | [**account_card_register_request**](docs/CardHolderAccountApi.md#account_card_register_request) | **POST** /v6/account/{accountid}/register | Card Registration
|
|
122
130
|
*CityPayApiClient::CardHolderAccountApi* | [**account_card_status_request**](docs/CardHolderAccountApi.md#account_card_status_request) | **POST** /v6/account/{accountid}/card/{cardId}/status | Card Status
|
|
@@ -138,6 +146,7 @@ Class | Method | HTTP request | Description
|
|
|
138
146
|
*CityPayApiClient::OperationalFunctionsApi* | [**list_merchants_request**](docs/OperationalFunctionsApi.md#list_merchants_request) | **GET** /v6/merchants/{clientid} | List Merchants Request
|
|
139
147
|
*CityPayApiClient::OperationalFunctionsApi* | [**ping_request**](docs/OperationalFunctionsApi.md#ping_request) | **POST** /v6/ping | Ping Request
|
|
140
148
|
*CityPayApiClient::PaylinkApi* | [**token_adjustment_request**](docs/PaylinkApi.md#token_adjustment_request) | **POST** /paylink/{token}/adjustment | Paylink Token Adjustment
|
|
149
|
+
*CityPayApiClient::PaylinkApi* | [**token_cancel_request**](docs/PaylinkApi.md#token_cancel_request) | **PUT** /paylink/{token}/cancel | Cancel a Paylink Token
|
|
141
150
|
*CityPayApiClient::PaylinkApi* | [**token_changes_request**](docs/PaylinkApi.md#token_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit
|
|
142
151
|
*CityPayApiClient::PaylinkApi* | [**token_close_request**](docs/PaylinkApi.md#token_close_request) | **PUT** /paylink/{token}/close | Close Paylink Token
|
|
143
152
|
*CityPayApiClient::PaylinkApi* | [**token_create_bill_payment_request**](docs/PaylinkApi.md#token_create_bill_payment_request) | **POST** /paylink/bill-payment | Create Bill Payment Paylink Token
|
|
@@ -145,7 +154,13 @@ Class | Method | HTTP request | Description
|
|
|
145
154
|
*CityPayApiClient::PaylinkApi* | [**token_purge_attachments_request**](docs/PaylinkApi.md#token_purge_attachments_request) | **PUT** /paylink/{token}/purge-attachments | Purges any attachments for a Paylink Token
|
|
146
155
|
*CityPayApiClient::PaylinkApi* | [**token_reconciled_request**](docs/PaylinkApi.md#token_reconciled_request) | **PUT** /paylink/{token}/reconciled | Reconcile Paylink Token
|
|
147
156
|
*CityPayApiClient::PaylinkApi* | [**token_reopen_request**](docs/PaylinkApi.md#token_reopen_request) | **PUT** /paylink/{token}/reopen | Reopen Paylink Token
|
|
157
|
+
*CityPayApiClient::PaylinkApi* | [**token_resend_notification_request**](docs/PaylinkApi.md#token_resend_notification_request) | **POST** /paylink/{token}/resend-notification | Resend a notification for Paylink Token
|
|
148
158
|
*CityPayApiClient::PaylinkApi* | [**token_status_request**](docs/PaylinkApi.md#token_status_request) | **GET** /paylink/{token}/status | Paylink Token Status
|
|
159
|
+
*CityPayApiClient::ReportingApi* | [**batched_transaction_report_request**](docs/ReportingApi.md#batched_transaction_report_request) | **POST** /v6/merchant-batch/{merchantid}/{batch_no}/transactions | Batch Transaction Report Request
|
|
160
|
+
*CityPayApiClient::ReportingApi* | [**merchant_batch_report_request**](docs/ReportingApi.md#merchant_batch_report_request) | **POST** /v6/merchant-batch/report | Merchant Batch Report Request
|
|
161
|
+
*CityPayApiClient::ReportingApi* | [**merchant_batch_request**](docs/ReportingApi.md#merchant_batch_request) | **GET** /v6/merchant-batch/{merchantid}/{batch_no} | Merchant Batch Request
|
|
162
|
+
*CityPayApiClient::ReportingApi* | [**remittance_range_report**](docs/ReportingApi.md#remittance_range_report) | **POST** /v6/remittance/report/{clientid} | Remittance Report Request
|
|
163
|
+
*CityPayApiClient::ReportingApi* | [**remittance_report_request**](docs/ReportingApi.md#remittance_report_request) | **GET** /v6/remittance/report/{clientid}/{date} | Remittance Date Report Request
|
|
149
164
|
|
|
150
165
|
|
|
151
166
|
## Documentation for Models
|
|
@@ -161,11 +176,12 @@ Class | Method | HTTP request | Description
|
|
|
161
176
|
- [CityPayApiClient::AuthReferences](docs/AuthReferences.md)
|
|
162
177
|
- [CityPayApiClient::AuthRequest](docs/AuthRequest.md)
|
|
163
178
|
- [CityPayApiClient::AuthResponse](docs/AuthResponse.md)
|
|
164
|
-
- [CityPayApiClient::AuthenRequired](docs/AuthenRequired.md)
|
|
165
179
|
- [CityPayApiClient::Batch](docs/Batch.md)
|
|
166
180
|
- [CityPayApiClient::BatchReportRequest](docs/BatchReportRequest.md)
|
|
167
181
|
- [CityPayApiClient::BatchReportResponseModel](docs/BatchReportResponseModel.md)
|
|
168
182
|
- [CityPayApiClient::BatchTransaction](docs/BatchTransaction.md)
|
|
183
|
+
- [CityPayApiClient::BatchTransactionReportRequest](docs/BatchTransactionReportRequest.md)
|
|
184
|
+
- [CityPayApiClient::BatchTransactionReportResponse](docs/BatchTransactionReportResponse.md)
|
|
169
185
|
- [CityPayApiClient::BatchTransactionResultModel](docs/BatchTransactionResultModel.md)
|
|
170
186
|
- [CityPayApiClient::Bin](docs/Bin.md)
|
|
171
187
|
- [CityPayApiClient::BinLookup](docs/BinLookup.md)
|
|
@@ -191,6 +207,10 @@ Class | Method | HTTP request | Description
|
|
|
191
207
|
- [CityPayApiClient::ListMerchantsResponse](docs/ListMerchantsResponse.md)
|
|
192
208
|
- [CityPayApiClient::MCC6012](docs/MCC6012.md)
|
|
193
209
|
- [CityPayApiClient::Merchant](docs/Merchant.md)
|
|
210
|
+
- [CityPayApiClient::MerchantBatchReportRequest](docs/MerchantBatchReportRequest.md)
|
|
211
|
+
- [CityPayApiClient::MerchantBatchReportResponse](docs/MerchantBatchReportResponse.md)
|
|
212
|
+
- [CityPayApiClient::MerchantBatchResponse](docs/MerchantBatchResponse.md)
|
|
213
|
+
- [CityPayApiClient::NetSummaryResponse](docs/NetSummaryResponse.md)
|
|
194
214
|
- [CityPayApiClient::PaResAuthRequest](docs/PaResAuthRequest.md)
|
|
195
215
|
- [CityPayApiClient::PaylinkAddress](docs/PaylinkAddress.md)
|
|
196
216
|
- [CityPayApiClient::PaylinkAdjustmentRequest](docs/PaylinkAdjustmentRequest.md)
|
|
@@ -206,6 +226,7 @@ Class | Method | HTTP request | Description
|
|
|
206
226
|
- [CityPayApiClient::PaylinkErrorCode](docs/PaylinkErrorCode.md)
|
|
207
227
|
- [CityPayApiClient::PaylinkFieldGuardModel](docs/PaylinkFieldGuardModel.md)
|
|
208
228
|
- [CityPayApiClient::PaylinkPartPayments](docs/PaylinkPartPayments.md)
|
|
229
|
+
- [CityPayApiClient::PaylinkResendNotificationRequest](docs/PaylinkResendNotificationRequest.md)
|
|
209
230
|
- [CityPayApiClient::PaylinkSMSNotificationPath](docs/PaylinkSMSNotificationPath.md)
|
|
210
231
|
- [CityPayApiClient::PaylinkStateEvent](docs/PaylinkStateEvent.md)
|
|
211
232
|
- [CityPayApiClient::PaylinkTokenCreated](docs/PaylinkTokenCreated.md)
|
|
@@ -214,11 +235,17 @@ Class | Method | HTTP request | Description
|
|
|
214
235
|
- [CityPayApiClient::PaylinkTokenStatusChangeRequest](docs/PaylinkTokenStatusChangeRequest.md)
|
|
215
236
|
- [CityPayApiClient::PaylinkTokenStatusChangeResponse](docs/PaylinkTokenStatusChangeResponse.md)
|
|
216
237
|
- [CityPayApiClient::PaylinkUI](docs/PaylinkUI.md)
|
|
238
|
+
- [CityPayApiClient::PaymentIntent](docs/PaymentIntent.md)
|
|
239
|
+
- [CityPayApiClient::PaymentIntentReference](docs/PaymentIntentReference.md)
|
|
217
240
|
- [CityPayApiClient::Ping](docs/Ping.md)
|
|
218
241
|
- [CityPayApiClient::ProcessBatchRequest](docs/ProcessBatchRequest.md)
|
|
219
242
|
- [CityPayApiClient::ProcessBatchResponse](docs/ProcessBatchResponse.md)
|
|
220
243
|
- [CityPayApiClient::RefundRequest](docs/RefundRequest.md)
|
|
221
244
|
- [CityPayApiClient::RegisterCard](docs/RegisterCard.md)
|
|
245
|
+
- [CityPayApiClient::RemittanceData](docs/RemittanceData.md)
|
|
246
|
+
- [CityPayApiClient::RemittanceReportRequest](docs/RemittanceReportRequest.md)
|
|
247
|
+
- [CityPayApiClient::RemittanceReportResponse](docs/RemittanceReportResponse.md)
|
|
248
|
+
- [CityPayApiClient::RemittedClientData](docs/RemittedClientData.md)
|
|
222
249
|
- [CityPayApiClient::RequestChallenged](docs/RequestChallenged.md)
|
|
223
250
|
- [CityPayApiClient::RetrieveRequest](docs/RetrieveRequest.md)
|
|
224
251
|
- [CityPayApiClient::ThreeDSecure](docs/ThreeDSecure.md)
|
data/citypay_api_client.gemspec
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#CityPay Payment API
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# 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.
|
|
7
7
|
|
|
8
8
|
Contact: support@citypay.com
|
|
9
9
|
Generated by: https://openapi-generator.tech
|
data/docs/Acknowledgement.md
CHANGED
|
@@ -15,10 +15,10 @@
|
|
|
15
15
|
require 'citypay_api_client'
|
|
16
16
|
|
|
17
17
|
instance = CityPayApiClient::Acknowledgement.new(
|
|
18
|
-
code:
|
|
18
|
+
code: 3,
|
|
19
19
|
context: aspiu352908ns47n343598bads,
|
|
20
20
|
identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
|
|
21
|
-
message:
|
|
21
|
+
message: Transaction Cancelled
|
|
22
22
|
)
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **acl** | **String** | The name or value of the acl which was found to match the ip address. | [optional] |
|
|
8
8
|
| **cache** | **Boolean** | Whether the ACL was returned via a cached instance. | [optional] |
|
|
9
9
|
| **ip** | **String** | The IP address used in the lookup. | [optional] |
|
|
10
|
-
| **provider** | **String** | The source provider of the ACL. | [optional] |
|
|
10
|
+
| **provider** | **String** | The source provider of the ACL such as cloud, subnet, country or IP based. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -15,10 +15,10 @@
|
|
|
15
15
|
require 'citypay_api_client'
|
|
16
16
|
|
|
17
17
|
instance = CityPayApiClient::AclCheckResponseModel.new(
|
|
18
|
-
acl:
|
|
18
|
+
acl: Default ACL,
|
|
19
19
|
cache: null,
|
|
20
20
|
ip: 8.8.8.8,
|
|
21
|
-
provider:
|
|
21
|
+
provider: AWS
|
|
22
22
|
)
|
|
23
23
|
```
|
|
24
24
|
|
data/docs/AuthRequest.md
CHANGED
|
@@ -6,24 +6,24 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **airline_data** | [**AirlineAdvice**](AirlineAdvice.md) | | [optional] |
|
|
8
8
|
| **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits. No decimal points are to be included and no divisional characters such as 1,024. The amount should be the total amount required for the transaction. For example with GBP £1,021.95 the amount value is 102195. | |
|
|
9
|
-
| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed. Values are
|
|
9
|
+
| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed. Values are: `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation. | [optional] |
|
|
10
10
|
| **bill_to** | [**ContactDetails**](ContactDetails.md) | | [optional] |
|
|
11
11
|
| **cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value. The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting. The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes. When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored. | |
|
|
12
|
-
| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify
|
|
13
|
-
| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed. Values are
|
|
12
|
+
| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe. When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing. The CSC number aids fraud prevention in Mail Order and Internet payments. Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC. The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored. This applies to all entities handling card data. It should also not be used in any hashing process. CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm. | [optional] |
|
|
13
|
+
| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed. Values are: `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation. | [optional] |
|
|
14
14
|
| **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
|
|
15
|
-
| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result. Values are
|
|
15
|
+
| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result. Values are `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window. `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window. `3` to ignore. Transactions that are ignored will have the same affect as bypass. | [optional] |
|
|
16
16
|
| **event_management** | [**EventDataModel**](EventDataModel.md) | | [optional] |
|
|
17
17
|
| **expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12. | |
|
|
18
18
|
| **expyear** | **Integer** | The year of expiry of the card. | |
|
|
19
19
|
| **external_mpi** | [**ExternalMPI**](ExternalMPI.md) | | [optional] |
|
|
20
20
|
| **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform post processing actions and to aid in reconciliation of transactions. The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127. The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable. When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different. | |
|
|
21
|
-
| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored. Values are
|
|
21
|
+
| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored. Values are: `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account. `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match. `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match. `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation. | [optional] |
|
|
22
22
|
| **mcc6012** | [**MCC6012**](MCC6012.md) | | [optional] |
|
|
23
23
|
| **merchantid** | **Integer** | Identifies the merchant account to perform processing for. | |
|
|
24
24
|
| **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers. | [optional] |
|
|
25
25
|
| **ship_to** | [**ContactDetails**](ContactDetails.md) | | [optional] |
|
|
26
|
-
| **tag** | **String
|
|
26
|
+
| **tag** | **Array<String>** | | [optional] |
|
|
27
27
|
| **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) | | [optional] |
|
|
28
28
|
| **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
|
|
29
29
|
| **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
|
|
@@ -35,7 +35,7 @@ require 'citypay_api_client'
|
|
|
35
35
|
|
|
36
36
|
instance = CityPayApiClient::AuthRequest.new(
|
|
37
37
|
airline_data: null,
|
|
38
|
-
amount:
|
|
38
|
+
amount: 19995,
|
|
39
39
|
avs_postcode_policy: null,
|
|
40
40
|
bill_to: null,
|
|
41
41
|
cardnumber: 4000 0000 0000 0002,
|
data/docs/AuthResponse.md
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
| **bin_description** | **String** | A description of the bin range found for the card. | [optional] |
|
|
17
17
|
| **cavv** | **String** | The cardholder authentication verification value which can be returned for verification purposes of the authenticated transaction for dispute realisation. | [optional] |
|
|
18
18
|
| **context** | **String** | The context which processed the transaction, can be used for support purposes to trace transactions. | [optional] |
|
|
19
|
-
| **csc_result** | **String** | The CSC
|
|
19
|
+
| **csc_result** | **String** | The CSC result codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline. <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td> </td><td>No information</td></tr> <tr><td>M</td><td>Card verification data matches</td></tr> <tr><td>N</td><td>Card verification data was checked but did not match</td></tr> <tr><td>P</td><td>Card verification was not processed</td></tr> <tr><td>S</td><td>The card verification data should be on the card but the merchant indicates that it is not</td></tr> <tr><td>U</td><td>The card issuer is not certified</td></tr> </table> | [optional] |
|
|
20
20
|
| **currency** | **String** | The currency the transaction was processed in. This is an `ISO4217` alpha currency value. | [optional] |
|
|
21
21
|
| **datetime** | **Time** | The UTC date time of the transaction in ISO data time format. | [optional] |
|
|
22
22
|
| **eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure. | [optional] |
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
require 'citypay_api_client'
|
|
41
41
|
|
|
42
42
|
instance = CityPayApiClient::AuthResponse.new(
|
|
43
|
-
amount:
|
|
43
|
+
amount: 19995,
|
|
44
44
|
atrn: null,
|
|
45
45
|
atsd: null,
|
|
46
46
|
authcode: 001245A,
|
|
@@ -50,12 +50,12 @@ instance = CityPayApiClient::AuthResponse.new(
|
|
|
50
50
|
bin_commercial: null,
|
|
51
51
|
bin_debit: null,
|
|
52
52
|
bin_description: Platinum Card,
|
|
53
|
-
cavv:
|
|
53
|
+
cavv: 00000109260000719349,
|
|
54
54
|
context: aspiu352908ns47n343598bads,
|
|
55
55
|
csc_result: null,
|
|
56
56
|
currency: GBP,
|
|
57
57
|
datetime: 2020-01-02T18:32:28Z,
|
|
58
|
-
eci:
|
|
58
|
+
eci: 5,
|
|
59
59
|
identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
|
|
60
60
|
live: true,
|
|
61
61
|
maskedpan: 4***********0002,
|