citypay_api_client 1.0.3 → 1.1.1
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/README.md +105 -34
- data/citypay_api_client.gemspec +4 -5
- data/docs/AccountCreate.md +10 -9
- data/docs/AccountStatus.md +8 -7
- data/docs/Acknowledgement.md +14 -13
- data/docs/AclCheckRequest.md +18 -0
- data/docs/AclCheckResponseModel.md +24 -0
- data/docs/AirlineAdvice.md +38 -37
- data/docs/AirlineSegment.md +22 -21
- data/docs/AuthReference.md +34 -33
- data/docs/AuthReferences.md +8 -7
- data/docs/AuthRequest.md +50 -49
- data/docs/AuthResponse.md +60 -59
- data/docs/AuthenRequired.md +12 -11
- data/docs/AuthorisationAndPaymentApi.md +559 -0
- data/docs/Batch.md +22 -0
- data/docs/BatchProcessingApi.md +214 -0
- data/docs/BatchReportRequest.md +20 -0
- data/docs/BatchReportResponseModel.md +28 -0
- data/docs/BatchTransaction.md +24 -0
- data/docs/BatchTransactionResultModel.md +40 -0
- data/docs/Bin.md +34 -0
- data/docs/BinLookup.md +18 -0
- data/docs/CResAuthRequest.md +8 -7
- data/docs/CaptureRequest.md +18 -17
- data/docs/Card.md +46 -41
- data/docs/CardHolderAccount.md +24 -21
- data/docs/CardHolderAccountApi.md +326 -105
- data/docs/CardStatus.md +10 -9
- data/docs/ChargeRequest.md +36 -31
- data/docs/CheckBatchStatus.md +20 -0
- data/docs/CheckBatchStatusResponse.md +18 -0
- data/docs/ContactDetails.md +32 -31
- data/docs/Decision.md +12 -11
- data/docs/DirectPostApi.md +365 -0
- data/docs/DirectPostRequest.md +58 -0
- data/docs/DirectTokenAuthRequest.md +24 -0
- data/docs/DomainKeyCheckRequest.md +18 -0
- data/docs/DomainKeyRequest.md +22 -0
- data/docs/DomainKeyResponse.md +26 -0
- data/docs/Error.md +16 -13
- data/docs/EventDataModel.md +26 -0
- data/docs/Exists.md +22 -0
- data/docs/ExternalMPI.md +16 -15
- data/docs/ListMerchantsResponse.md +12 -11
- data/docs/MCC6012.md +14 -13
- data/docs/Merchant.md +16 -15
- data/docs/OperationalApi.md +124 -22
- data/docs/OperationalFunctionsApi.md +355 -0
- data/docs/PaResAuthRequest.md +10 -9
- data/docs/PaylinkAddress.md +30 -0
- data/docs/PaylinkAdjustmentRequest.md +22 -0
- data/docs/PaylinkApi.md +630 -0
- data/docs/PaylinkAttachmentRequest.md +26 -0
- data/docs/PaylinkAttachmentResult.md +22 -0
- data/docs/PaylinkBillPaymentTokenRequest.md +32 -0
- data/docs/PaylinkCardHolder.md +36 -0
- data/docs/PaylinkCart.md +30 -0
- data/docs/PaylinkCartItemModel.md +32 -0
- data/docs/PaylinkConfig.md +60 -0
- data/docs/PaylinkCustomParam.md +36 -0
- data/docs/PaylinkEmailNotificationPath.md +26 -0
- data/docs/PaylinkErrorCode.md +20 -0
- data/docs/PaylinkFieldGuardModel.md +30 -0
- data/docs/PaylinkPartPayments.md +28 -0
- data/docs/PaylinkSMSNotificationPath.md +20 -0
- data/docs/PaylinkStateEvent.md +22 -0
- data/docs/PaylinkTokenCreated.md +44 -0
- data/docs/PaylinkTokenRequestModel.md +38 -0
- data/docs/PaylinkTokenStatus.md +72 -0
- data/docs/PaylinkTokenStatusChangeRequest.md +26 -0
- data/docs/PaylinkTokenStatusChangeResponse.md +20 -0
- data/docs/PaylinkUI.md +24 -0
- data/docs/PaymentProcessingApi.md +307 -68
- data/docs/Ping.md +8 -7
- data/docs/ProcessBatchRequest.md +24 -0
- data/docs/ProcessBatchResponse.md +20 -0
- data/docs/RefundRequest.md +26 -0
- data/docs/RegisterCard.md +16 -13
- data/docs/RequestChallenged.md +16 -15
- data/docs/RetrieveRequest.md +12 -11
- data/docs/ThreeDSecure.md +32 -15
- data/docs/TokenisationResponseModel.md +36 -0
- data/docs/VoidRequest.md +12 -13
- data/lib/.DS_Store +0 -0
- data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +565 -0
- data/lib/citypay_api_client/api/batch_processing_api__.rb +225 -0
- data/lib/citypay_api_client/api/{card_holder_account_api.rb → card_holder_account_api__.rb} +136 -46
- data/lib/citypay_api_client/api/direct_post_api__.rb +373 -0
- data/lib/citypay_api_client/api/operational_functions_api__.rb +356 -0
- data/lib/citypay_api_client/api/paylink_api__.rb +614 -0
- data/lib/citypay_api_client/api_client.rb +59 -59
- data/lib/citypay_api_client/api_error.rb +2 -2
- data/lib/citypay_api_client/configuration.rb +53 -15
- data/lib/citypay_api_client/models/account_create.rb +21 -8
- data/lib/citypay_api_client/models/account_status.rb +21 -8
- data/lib/citypay_api_client/models/acknowledgement.rb +21 -8
- data/lib/citypay_api_client/models/acl_check_request.rb +224 -0
- data/lib/citypay_api_client/models/acl_check_response_model.rb +249 -0
- data/lib/citypay_api_client/models/airline_advice.rb +23 -10
- data/lib/citypay_api_client/models/airline_segment.rb +21 -8
- data/lib/citypay_api_client/models/auth_reference.rb +45 -11
- data/lib/citypay_api_client/models/auth_references.rb +21 -8
- data/lib/citypay_api_client/models/auth_request.rb +79 -35
- data/lib/citypay_api_client/models/auth_response.rb +43 -106
- data/lib/citypay_api_client/models/authen_required.rb +21 -8
- data/lib/citypay_api_client/models/batch.rb +264 -0
- data/lib/citypay_api_client/models/batch_report_request.rb +277 -0
- data/lib/citypay_api_client/models/batch_report_response_model.rb +357 -0
- data/lib/citypay_api_client/models/batch_transaction.rb +321 -0
- data/lib/citypay_api_client/models/batch_transaction_result_model.rb +421 -0
- data/lib/citypay_api_client/models/bin.rb +299 -0
- data/lib/citypay_api_client/models/bin_lookup.rb +234 -0
- data/lib/citypay_api_client/models/c_res_auth_request.rb +21 -8
- data/lib/citypay_api_client/models/capture_request.rb +38 -22
- data/lib/citypay_api_client/models/card.rb +67 -10
- data/lib/citypay_api_client/models/card_holder_account.rb +35 -12
- data/lib/citypay_api_client/models/card_status.rb +21 -8
- data/lib/citypay_api_client/models/charge_request.rb +96 -26
- data/lib/citypay_api_client/models/check_batch_status.rb +259 -0
- data/lib/citypay_api_client/models/check_batch_status_response.rb +220 -0
- data/lib/citypay_api_client/models/contact_details.rb +87 -44
- data/lib/citypay_api_client/models/decision.rb +21 -8
- data/lib/citypay_api_client/models/direct_post_request.rb +670 -0
- data/lib/citypay_api_client/models/direct_token_auth_request.rb +249 -0
- data/lib/citypay_api_client/models/domain_key_check_request.rb +252 -0
- data/lib/citypay_api_client/models/domain_key_request.rb +250 -0
- data/lib/citypay_api_client/models/domain_key_response.rb +294 -0
- data/lib/citypay_api_client/models/error.rb +35 -12
- data/lib/citypay_api_client/models/event_data_model.rb +259 -0
- data/lib/citypay_api_client/models/exists.rb +244 -0
- data/lib/citypay_api_client/models/external_mpi.rb +27 -8
- data/lib/citypay_api_client/models/list_merchants_response.rb +21 -8
- data/lib/citypay_api_client/models/mcc6012.rb +21 -8
- data/lib/citypay_api_client/models/merchant.rb +21 -8
- data/lib/citypay_api_client/models/pa_res_auth_request.rb +22 -9
- data/lib/citypay_api_client/models/paylink_address.rb +402 -0
- data/lib/citypay_api_client/models/paylink_adjustment_request.rb +269 -0
- data/lib/citypay_api_client/models/paylink_attachment_request.rb +269 -0
- data/lib/citypay_api_client/models/paylink_attachment_result.rb +249 -0
- data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +292 -0
- data/lib/citypay_api_client/models/paylink_card_holder.rb +353 -0
- data/lib/citypay_api_client/models/paylink_cart.rb +280 -0
- data/lib/citypay_api_client/models/paylink_cart_item_model.rb +289 -0
- data/lib/citypay_api_client/models/paylink_config.rb +433 -0
- data/lib/citypay_api_client/models/paylink_custom_param.rb +314 -0
- data/lib/citypay_api_client/models/paylink_email_notification_path.rb +268 -0
- data/lib/citypay_api_client/models/paylink_error_code.rb +239 -0
- data/lib/citypay_api_client/models/paylink_field_guard_model.rb +279 -0
- data/lib/citypay_api_client/models/paylink_part_payments.rb +269 -0
- data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +234 -0
- data/lib/citypay_api_client/models/paylink_state_event.rb +239 -0
- data/lib/citypay_api_client/models/paylink_token_created.rb +364 -0
- data/lib/citypay_api_client/models/paylink_token_request_model.rb +374 -0
- data/lib/citypay_api_client/models/paylink_token_status.rb +490 -0
- data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +270 -0
- data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +235 -0
- data/lib/citypay_api_client/models/paylink_ui.rb +249 -0
- data/lib/citypay_api_client/models/ping.rb +21 -8
- data/lib/citypay_api_client/models/process_batch_request.rb +308 -0
- data/lib/citypay_api_client/models/process_batch_response.rb +234 -0
- data/lib/citypay_api_client/models/refund_request.rb +332 -0
- data/lib/citypay_api_client/models/register_card.rb +59 -12
- data/lib/citypay_api_client/models/request_challenged.rb +29 -16
- data/lib/citypay_api_client/models/retrieve_request.rb +21 -8
- data/lib/citypay_api_client/models/three_d_secure.rb +106 -13
- data/lib/citypay_api_client/models/tokenisation_response_model.rb +333 -0
- data/lib/citypay_api_client/models/void_request.rb +22 -21
- data/lib/citypay_api_client/utils/digest_utils.rb +18 -0
- data/lib/citypay_api_client/utils/direct_post_mac.rb +22 -0
- data/lib/citypay_api_client/version.rb +3 -4
- data/lib/citypay_api_client.rb +53 -6
- data/spec/.DS_Store +0 -0
- data/spec/api/authorisation_and_payment_api___spec.rb +130 -0
- data/spec/api/batch_processing_api___spec.rb +70 -0
- data/spec/api/{card_holder_account_api_spec.rb → card_holder_account_api___spec.rb} +15 -3
- data/spec/api/direct_post_api___spec.rb +98 -0
- data/spec/api/operational_functions_api___spec.rb +94 -0
- data/spec/api/paylink_api___spec.rb +131 -0
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +5 -5
- data/spec/it_api_sandbox_spec.rb +126 -58
- data/spec/models/acknowledgement_spec.rb +7 -22
- data/spec/models/acl_check_request_spec.rb +33 -0
- data/spec/models/acl_check_response_model_spec.rb +51 -0
- data/spec/models/auth_references_spec.rb +7 -8
- data/spec/models/auth_response_spec.rb +29 -30
- data/spec/models/batch_report_request_spec.rb +39 -0
- data/spec/models/batch_report_response_model_spec.rb +63 -0
- data/spec/models/batch_spec.rb +45 -0
- data/spec/models/batch_transaction_result_model_spec.rb +87 -0
- data/spec/models/batch_transaction_spec.rb +51 -0
- data/spec/models/bin_lookup_spec.rb +33 -0
- data/spec/models/bin_spec.rb +81 -0
- data/spec/models/card_holder_account_spec.rb +8 -5
- data/spec/models/check_batch_status_response_spec.rb +45 -0
- data/spec/models/check_batch_status_spec.rb +39 -0
- data/spec/models/decision_spec.rb +1 -1
- data/spec/models/direct_post_request_spec.rb +153 -0
- data/spec/models/direct_token_auth_request_spec.rb +51 -0
- data/spec/models/domain_key_check_request_spec.rb +33 -0
- data/spec/models/domain_key_request_spec.rb +45 -0
- data/spec/models/domain_key_response_spec.rb +57 -0
- data/spec/models/event_data_model_spec.rb +57 -0
- data/spec/{api/operational_api_spec.rb → models/exists_spec.rb} +14 -20
- data/spec/models/list_merchants_response_spec.rb +2 -2
- data/spec/models/paylink_address_spec.rb +69 -0
- data/spec/models/paylink_adjustment_request_spec.rb +45 -0
- data/spec/models/paylink_attachment_request_spec.rb +45 -0
- data/spec/models/paylink_attachment_result_spec.rb +45 -0
- data/spec/models/paylink_bill_payment_token_request_spec.rb +63 -0
- data/spec/models/paylink_card_holder_spec.rb +87 -0
- data/spec/models/paylink_cart_item_model_spec.rb +75 -0
- data/spec/models/paylink_cart_spec.rb +69 -0
- data/spec/models/paylink_config_spec.rb +159 -0
- data/spec/models/paylink_custom_param_spec.rb +87 -0
- data/spec/models/paylink_email_notification_path_spec.rb +57 -0
- data/spec/models/paylink_error_code_spec.rb +39 -0
- data/spec/models/paylink_field_guard_model_spec.rb +45 -0
- data/spec/models/paylink_part_payments_spec.rb +63 -0
- data/spec/models/paylink_sms_notification_path_spec.rb +39 -0
- data/spec/models/paylink_state_event_spec.rb +45 -0
- data/spec/models/paylink_token_created_spec.rb +111 -0
- data/spec/models/paylink_token_request_model_spec.rb +93 -0
- data/spec/models/paylink_token_status_change_request_spec.rb +57 -0
- data/spec/models/paylink_token_status_change_response_spec.rb +39 -0
- data/spec/models/paylink_token_status_spec.rb +195 -0
- data/spec/models/paylink_ui_spec.rb +51 -0
- data/spec/models/process_batch_request_spec.rb +51 -0
- data/spec/models/process_batch_response_spec.rb +39 -0
- data/spec/models/refund_request_spec.rb +64 -0
- data/spec/models/tokenisation_response_model_spec.rb +87 -0
- data/spec/spec_helper.rb +2 -2
- data/spec/utils/direct_post_mac_spec.rb +13 -0
- metadata +210 -37
- data/Gemfile.lock +0 -70
- data/git_push.sh +0 -58
- data/lib/citypay_api_client/api/operational_api.rb +0 -147
- data/lib/citypay_api_client/api/payment_processing_api.rb +0 -405
- data/lib/citypay_api_client/test.rb +0 -20
- data/spec/api/payment_processing_api_spec.rb +0 -106
@@ -1,15 +1,16 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
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
|
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 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](#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
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 6.2.1
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
12
12
|
require 'date'
|
13
|
+
require 'time'
|
13
14
|
|
14
15
|
module CityPayApiClient
|
15
16
|
class AuthResponse
|
@@ -25,13 +26,13 @@ module CityPayApiClient
|
|
25
26
|
# The authorisation code as returned by the card issuer or acquiring bank when a transaction has successfully been authorised. Authorisation codes contain alphanumeric values. Whilst the code confirms authorisation it should not be used to determine whether a transaction was successfully processed. For instance an auth code may be returned when a transaction has been subsequently declined due to a CSC mismatch.
|
26
27
|
attr_accessor :authcode
|
27
28
|
|
28
|
-
# The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are
|
29
|
+
# The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are: <table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>Y</td> <td>Authentication Successful. The Cardholder's password was successfully validated.</td> </tr> <tr> <td>N</td> <td>Authentication Failed. Customer failed or cancelled authentication, transaction denied.</td> </tr> <tr> <td>A</td> <td>Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated.</td> </tr> <tr> <td>U</td> <td>Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem.</td> </tr> </table>
|
29
30
|
attr_accessor :authen_result
|
30
31
|
|
31
|
-
# A boolean definition that indicates that the transaction was authorised. It will return false if the transaction was declined, rejected or cancelled due to CSC matching failures.
|
32
|
+
# A boolean definition that indicates that the transaction was authorised. It will return false if the transaction was declined, rejected or cancelled due to CSC matching failures. Attention should be referenced to the AuthResult and Response code for accurate determination of the result.
|
32
33
|
attr_accessor :authorised
|
33
34
|
|
34
|
-
# The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline.
|
35
|
+
# The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline. <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td>Y</td><td>Address and 5 digit post code match</td></tr> <tr><td>M</td><td>Street address and Postal codes match for international transaction</td></tr> <tr><td>U</td><td>No AVS data available from issuer auth system</td></tr> <tr><td>A</td><td>Addres matches, post code does not</td></tr> <tr><td>I</td><td>Address information verified for international transaction</td></tr> <tr><td>Z</td><td>5 digit post code matches, Address does not</td></tr> <tr><td>W</td><td>9 digit post code matches, Address does not</td></tr> <tr><td>X</td><td>Postcode and address match</td></tr> <tr><td>B</td><td>Postal code not verified due to incompatible formats</td></tr> <tr><td>P</td><td>Postal codes match. Street address not verified due to to incompatible formats</td></tr> <tr><td>E</td><td>AVS Error</td></tr> <tr><td>C</td><td>Street address and Postal code not verified due to incompatible formats</td></tr> <tr><td>D</td><td>Street address and postal codes match</td></tr> <tr><td> </td><td>No information</td></tr> <tr><td>N</td><td>Neither postcode nor address match</td></tr> <tr><td>R</td><td>Retry, System unavailble or Timed Out</td></tr> <tr><td>S</td><td>AVS Service not supported by issuer or processor</td></tr> <tr><td>G</td><td>Issuer does not participate in AVS</td></tr> </table>
|
35
36
|
attr_accessor :avs_result
|
36
37
|
|
37
38
|
# Determines whether the bin range was found to be a commercial or business card.
|
@@ -49,7 +50,7 @@ module CityPayApiClient
|
|
49
50
|
# The context which processed the transaction, can be used for support purposes to trace transactions.
|
50
51
|
attr_accessor :context
|
51
52
|
|
52
|
-
# The CSC rseult 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.
|
53
|
+
# The CSC rseult 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>
|
53
54
|
attr_accessor :csc_result
|
54
55
|
|
55
56
|
# The currency the transaction was processed in. This is an `ISO4217` alpha currency value.
|
@@ -64,7 +65,7 @@ module CityPayApiClient
|
|
64
65
|
# The identifier provided within the request.
|
65
66
|
attr_accessor :identifier
|
66
67
|
|
67
|
-
# Used to identify that a
|
68
|
+
# Used to identify that a transaction was processed on a live authorisation platform.
|
68
69
|
attr_accessor :live
|
69
70
|
|
70
71
|
# A masked value of the card number used for processing displaying limited values that can be used on a receipt.
|
@@ -73,10 +74,10 @@ module CityPayApiClient
|
|
73
74
|
# The merchant id that processed this transaction.
|
74
75
|
attr_accessor :merchantid
|
75
76
|
|
76
|
-
# An integer result that indicates the outcome of the transaction. The Code value below maps to the result value
|
77
|
+
# An integer result that indicates the outcome of the transaction. The Code value below maps to the result value <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>
|
77
78
|
attr_accessor :result
|
78
79
|
|
79
|
-
# The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure.
|
80
|
+
# The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure. Codes may start with an alpha character i.e. C001 indicating a type of error such as a card validation error.
|
80
81
|
attr_accessor :result_code
|
81
82
|
|
82
83
|
# The message regarding the result which provides further narrative to the result code.
|
@@ -85,10 +86,10 @@ module CityPayApiClient
|
|
85
86
|
# A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.
|
86
87
|
attr_accessor :scheme
|
87
88
|
|
88
|
-
# A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating
|
89
|
+
# A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating * authcode * amount * response_code * merchant_id * trans_no * identifier * licence_key - which is not provided in the response.
|
89
90
|
attr_accessor :sha256
|
90
91
|
|
91
|
-
# Used to identify the status of a transaction. The status is used to track a transaction through its life cycle.
|
92
|
+
# Used to identify the status of a transaction. The status is used to track a transaction through its life cycle. <table> <tr> <th>Id</th> <th>Description</th> </tr> <tr> <td>O</td> <td>Transaction is open for settlement</td> </tr> <tr> <td>A</td> <td>Transaction is assigned for settlement and can no longer be voided</td> </tr> <tr> <td>S</td> <td>Transaction has been settled</td> </tr> <tr> <td>D</td> <td>Transaction has been declined</td> </tr> <tr> <td>R</td> <td>Transaction has been rejected</td> </tr> <tr> <td>P</td> <td>Transaction has been authorised only and awaiting a capture. Used in pre-auth situations</td> </tr> <tr> <td>C</td> <td>Transaction has been cancelled</td> </tr> <tr> <td>E</td> <td>Transaction has expired</td> </tr> <tr> <td>I</td> <td>Transaction has been initialised but no action was able to be carried out</td> </tr> <tr> <td>H</td> <td>Transaction is awaiting authorisation</td> </tr> <tr> <td>.</td> <td>Transaction is on hold</td> </tr> <tr> <td>V</td> <td>Transaction has been verified</td> </tr> </table>
|
92
93
|
attr_accessor :trans_status
|
93
94
|
|
94
95
|
# The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.
|
@@ -127,6 +128,11 @@ module CityPayApiClient
|
|
127
128
|
}
|
128
129
|
end
|
129
130
|
|
131
|
+
# Returns all the JSON keys this model knows about
|
132
|
+
def self.acceptable_attributes
|
133
|
+
attribute_map.values
|
134
|
+
end
|
135
|
+
|
130
136
|
# Attribute type mapping.
|
131
137
|
def self.openapi_types
|
132
138
|
{
|
@@ -144,7 +150,7 @@ module CityPayApiClient
|
|
144
150
|
:'context' => :'String',
|
145
151
|
:'csc_result' => :'String',
|
146
152
|
:'currency' => :'String',
|
147
|
-
:'datetime' => :'
|
153
|
+
:'datetime' => :'Time',
|
148
154
|
:'eci' => :'String',
|
149
155
|
:'identifier' => :'String',
|
150
156
|
:'live' => :'Boolean',
|
@@ -294,36 +300,20 @@ module CityPayApiClient
|
|
294
300
|
# @return Array for valid properties with the reasons
|
295
301
|
def list_invalid_properties
|
296
302
|
invalid_properties = Array.new
|
297
|
-
if
|
298
|
-
invalid_properties.push('invalid value for "
|
299
|
-
end
|
300
|
-
|
301
|
-
if !@avs_result.nil? && @avs_result.to_s.length < 1
|
302
|
-
invalid_properties.push('invalid value for "avs_result", the character length must be great than or equal to 1.')
|
303
|
-
end
|
304
|
-
|
305
|
-
if !@csc_result.nil? && @csc_result.to_s.length > 1
|
306
|
-
invalid_properties.push('invalid value for "csc_result", the character length must be smaller than or equal to 1.')
|
307
|
-
end
|
308
|
-
|
309
|
-
if !@csc_result.nil? && @csc_result.to_s.length < 1
|
310
|
-
invalid_properties.push('invalid value for "csc_result", the character length must be great than or equal to 1.')
|
311
|
-
end
|
312
|
-
|
313
|
-
if !@currency.nil? && @currency.to_s.length > 3
|
314
|
-
invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
|
303
|
+
if @merchantid.nil?
|
304
|
+
invalid_properties.push('invalid value for "merchantid", merchantid cannot be nil.')
|
315
305
|
end
|
316
306
|
|
317
|
-
if
|
318
|
-
invalid_properties.push('invalid value for "
|
307
|
+
if @result.nil?
|
308
|
+
invalid_properties.push('invalid value for "result", result cannot be nil.')
|
319
309
|
end
|
320
310
|
|
321
|
-
if
|
322
|
-
invalid_properties.push('invalid value for "
|
311
|
+
if @result_code.nil?
|
312
|
+
invalid_properties.push('invalid value for "result_code", result_code cannot be nil.')
|
323
313
|
end
|
324
314
|
|
325
|
-
if
|
326
|
-
invalid_properties.push('invalid value for "
|
315
|
+
if @result_message.nil?
|
316
|
+
invalid_properties.push('invalid value for "result_message", result_message cannot be nil.')
|
327
317
|
end
|
328
318
|
|
329
319
|
invalid_properties
|
@@ -332,73 +322,13 @@ module CityPayApiClient
|
|
332
322
|
# Check to see if the all the properties in the model are valid
|
333
323
|
# @return true if the model is valid
|
334
324
|
def valid?
|
335
|
-
return false if
|
336
|
-
return false if
|
337
|
-
return false if
|
338
|
-
return false if
|
339
|
-
return false if !@currency.nil? && @currency.to_s.length > 3
|
340
|
-
return false if !@currency.nil? && @currency.to_s.length < 3
|
341
|
-
return false if !@identifier.nil? && @identifier.to_s.length > 50
|
342
|
-
return false if !@identifier.nil? && @identifier.to_s.length < 4
|
325
|
+
return false if @merchantid.nil?
|
326
|
+
return false if @result.nil?
|
327
|
+
return false if @result_code.nil?
|
328
|
+
return false if @result_message.nil?
|
343
329
|
true
|
344
330
|
end
|
345
331
|
|
346
|
-
# Custom attribute writer method with validation
|
347
|
-
# @param [Object] avs_result Value to be assigned
|
348
|
-
def avs_result=(avs_result)
|
349
|
-
if !avs_result.nil? && avs_result.to_s.length > 1
|
350
|
-
fail ArgumentError, 'invalid value for "avs_result", the character length must be smaller than or equal to 1.'
|
351
|
-
end
|
352
|
-
|
353
|
-
if !avs_result.nil? && avs_result.to_s.length < 1
|
354
|
-
fail ArgumentError, 'invalid value for "avs_result", the character length must be great than or equal to 1.'
|
355
|
-
end
|
356
|
-
|
357
|
-
@avs_result = avs_result
|
358
|
-
end
|
359
|
-
|
360
|
-
# Custom attribute writer method with validation
|
361
|
-
# @param [Object] csc_result Value to be assigned
|
362
|
-
def csc_result=(csc_result)
|
363
|
-
if !csc_result.nil? && csc_result.to_s.length > 1
|
364
|
-
fail ArgumentError, 'invalid value for "csc_result", the character length must be smaller than or equal to 1.'
|
365
|
-
end
|
366
|
-
|
367
|
-
if !csc_result.nil? && csc_result.to_s.length < 1
|
368
|
-
fail ArgumentError, 'invalid value for "csc_result", the character length must be great than or equal to 1.'
|
369
|
-
end
|
370
|
-
|
371
|
-
@csc_result = csc_result
|
372
|
-
end
|
373
|
-
|
374
|
-
# Custom attribute writer method with validation
|
375
|
-
# @param [Object] currency Value to be assigned
|
376
|
-
def currency=(currency)
|
377
|
-
if !currency.nil? && currency.to_s.length > 3
|
378
|
-
fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
|
379
|
-
end
|
380
|
-
|
381
|
-
if !currency.nil? && currency.to_s.length < 3
|
382
|
-
fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
|
383
|
-
end
|
384
|
-
|
385
|
-
@currency = currency
|
386
|
-
end
|
387
|
-
|
388
|
-
# Custom attribute writer method with validation
|
389
|
-
# @param [Object] identifier Value to be assigned
|
390
|
-
def identifier=(identifier)
|
391
|
-
if !identifier.nil? && identifier.to_s.length > 50
|
392
|
-
fail ArgumentError, 'invalid value for "identifier", the character length must be smaller than or equal to 50.'
|
393
|
-
end
|
394
|
-
|
395
|
-
if !identifier.nil? && identifier.to_s.length < 4
|
396
|
-
fail ArgumentError, 'invalid value for "identifier", the character length must be great than or equal to 4.'
|
397
|
-
end
|
398
|
-
|
399
|
-
@identifier = identifier
|
400
|
-
end
|
401
|
-
|
402
332
|
# Checks equality by comparing each attribute.
|
403
333
|
# @param [Object] Object to be compared
|
404
334
|
def ==(o)
|
@@ -457,8 +387,11 @@ module CityPayApiClient
|
|
457
387
|
# @return [Object] Returns the model itself
|
458
388
|
def build_from_hash(attributes)
|
459
389
|
return nil unless attributes.is_a?(Hash)
|
390
|
+
attributes = attributes.transform_keys(&:to_sym)
|
460
391
|
self.class.openapi_types.each_pair do |key, type|
|
461
|
-
if
|
392
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
393
|
+
self.send("#{key}=", nil)
|
394
|
+
elsif type =~ /\AArray<(.*)>/i
|
462
395
|
# check to ensure the input is an array given that the attribute
|
463
396
|
# is documented as an array but the input is not
|
464
397
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -466,7 +399,7 @@ module CityPayApiClient
|
|
466
399
|
end
|
467
400
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
468
401
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
469
|
-
end
|
402
|
+
end
|
470
403
|
end
|
471
404
|
|
472
405
|
self
|
@@ -478,8 +411,8 @@ module CityPayApiClient
|
|
478
411
|
# @return [Object] Deserialized data
|
479
412
|
def _deserialize(type, value)
|
480
413
|
case type.to_sym
|
481
|
-
when :
|
482
|
-
|
414
|
+
when :Time
|
415
|
+
Time.parse(value)
|
483
416
|
when :Date
|
484
417
|
Date.parse(value)
|
485
418
|
when :String
|
@@ -509,7 +442,9 @@ module CityPayApiClient
|
|
509
442
|
end
|
510
443
|
end
|
511
444
|
else # model
|
512
|
-
|
445
|
+
# models (e.g. Pet) or oneOf
|
446
|
+
klass = CityPayApiClient.const_get(type)
|
447
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
513
448
|
end
|
514
449
|
end
|
515
450
|
|
@@ -535,7 +470,7 @@ module CityPayApiClient
|
|
535
470
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
536
471
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
537
472
|
end
|
538
|
-
|
473
|
+
|
539
474
|
hash[param] = _to_hash(value)
|
540
475
|
end
|
541
476
|
hash
|
@@ -558,5 +493,7 @@ module CityPayApiClient
|
|
558
493
|
value
|
559
494
|
end
|
560
495
|
end
|
496
|
+
|
561
497
|
end
|
498
|
+
|
562
499
|
end
|
@@ -1,15 +1,16 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
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
|
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 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](#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
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 6.2.1
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
12
12
|
require 'date'
|
13
|
+
require 'time'
|
13
14
|
|
14
15
|
module CityPayApiClient
|
15
16
|
class AuthenRequired
|
@@ -31,6 +32,11 @@ module CityPayApiClient
|
|
31
32
|
}
|
32
33
|
end
|
33
34
|
|
35
|
+
# Returns all the JSON keys this model knows about
|
36
|
+
def self.acceptable_attributes
|
37
|
+
attribute_map.values
|
38
|
+
end
|
39
|
+
|
34
40
|
# Attribute type mapping.
|
35
41
|
def self.openapi_types
|
36
42
|
{
|
@@ -121,8 +127,11 @@ module CityPayApiClient
|
|
121
127
|
# @return [Object] Returns the model itself
|
122
128
|
def build_from_hash(attributes)
|
123
129
|
return nil unless attributes.is_a?(Hash)
|
130
|
+
attributes = attributes.transform_keys(&:to_sym)
|
124
131
|
self.class.openapi_types.each_pair do |key, type|
|
125
|
-
if
|
132
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
133
|
+
self.send("#{key}=", nil)
|
134
|
+
elsif type =~ /\AArray<(.*)>/i
|
126
135
|
# check to ensure the input is an array given that the attribute
|
127
136
|
# is documented as an array but the input is not
|
128
137
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -130,7 +139,7 @@ module CityPayApiClient
|
|
130
139
|
end
|
131
140
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
132
141
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
133
|
-
end
|
142
|
+
end
|
134
143
|
end
|
135
144
|
|
136
145
|
self
|
@@ -142,8 +151,8 @@ module CityPayApiClient
|
|
142
151
|
# @return [Object] Deserialized data
|
143
152
|
def _deserialize(type, value)
|
144
153
|
case type.to_sym
|
145
|
-
when :
|
146
|
-
|
154
|
+
when :Time
|
155
|
+
Time.parse(value)
|
147
156
|
when :Date
|
148
157
|
Date.parse(value)
|
149
158
|
when :String
|
@@ -173,7 +182,9 @@ module CityPayApiClient
|
|
173
182
|
end
|
174
183
|
end
|
175
184
|
else # model
|
176
|
-
|
185
|
+
# models (e.g. Pet) or oneOf
|
186
|
+
klass = CityPayApiClient.const_get(type)
|
187
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
177
188
|
end
|
178
189
|
end
|
179
190
|
|
@@ -199,7 +210,7 @@ module CityPayApiClient
|
|
199
210
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
200
211
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
201
212
|
end
|
202
|
-
|
213
|
+
|
203
214
|
hash[param] = _to_hash(value)
|
204
215
|
end
|
205
216
|
hash
|
@@ -222,5 +233,7 @@ module CityPayApiClient
|
|
222
233
|
value
|
223
234
|
end
|
224
235
|
end
|
236
|
+
|
225
237
|
end
|
238
|
+
|
226
239
|
end
|