Module: CityPayApiClient

Defined in:
lib/citypay_api_client/version.rb,
lib/citypay_api_client.rb,
lib/citypay_api_client/api_error.rb,
lib/citypay_api_client/api_client.rb,
lib/citypay_api_client/models/bin.rb,
lib/citypay_api_client/models/card.rb,
lib/citypay_api_client/models/ping.rb,
lib/citypay_api_client/models/batch.rb,
lib/citypay_api_client/models/error.rb,
lib/citypay_api_client/configuration.rb,
lib/citypay_api_client/models/exists.rb,
lib/citypay_api_client/models/api_key.rb,
lib/citypay_api_client/models/mcc6012.rb,
lib/citypay_api_client/models/decision.rb,
lib/citypay_api_client/models/merchant.rb,
lib/citypay_api_client/api/paylink_api__.rb,
lib/citypay_api_client/models/bin_lookup.rb,
lib/citypay_api_client/models/paylink_ui.rb,
lib/citypay_api_client/models/card_status.rb,
lib/citypay_api_client/models/auth_request.rb,
lib/citypay_api_client/models/external_mpi.rb,
lib/citypay_api_client/models/paylink_cart.rb,
lib/citypay_api_client/models/void_request.rb,
lib/citypay_api_client/models/auth_response.rb,
lib/citypay_api_client/models/register_card.rb,
lib/citypay_api_client/api/direct_post_api__.rb,
lib/citypay_api_client/models/account_create.rb,
lib/citypay_api_client/models/account_status.rb,
lib/citypay_api_client/models/airline_advice.rb,
lib/citypay_api_client/models/auth_reference.rb,
lib/citypay_api_client/models/charge_request.rb,
lib/citypay_api_client/models/paylink_config.rb,
lib/citypay_api_client/models/refund_request.rb,
lib/citypay_api_client/models/three_d_secure.rb,
lib/citypay_api_client/models/acknowledgement.rb,
lib/citypay_api_client/models/airline_segment.rb,
lib/citypay_api_client/models/auth_references.rb,
lib/citypay_api_client/models/authen_required.rb,
lib/citypay_api_client/models/capture_request.rb,
lib/citypay_api_client/models/contact_details.rb,
lib/citypay_api_client/models/paylink_address.rb,
lib/citypay_api_client/models/event_data_model.rb,
lib/citypay_api_client/models/retrieve_request.rb,
lib/citypay_api_client/models/acl_check_request.rb,
lib/citypay_api_client/models/batch_transaction.rb,
lib/citypay_api_client/models/c_res_auth_request.rb,
lib/citypay_api_client/models/check_batch_status.rb,
lib/citypay_api_client/models/domain_key_request.rb,
lib/citypay_api_client/models/paylink_error_code.rb,
lib/citypay_api_client/models/request_challenged.rb,
lib/citypay_api_client/api/batch_processing_api__.rb,
lib/citypay_api_client/models/card_holder_account.rb,
lib/citypay_api_client/models/direct_post_request.rb,
lib/citypay_api_client/models/domain_key_response.rb,
lib/citypay_api_client/models/pa_res_auth_request.rb,
lib/citypay_api_client/models/paylink_card_holder.rb,
lib/citypay_api_client/models/paylink_state_event.rb,
lib/citypay_api_client/models/batch_report_request.rb,
lib/citypay_api_client/models/paylink_custom_param.rb,
lib/citypay_api_client/models/paylink_token_status.rb,
lib/citypay_api_client/models/paylink_part_payments.rb,
lib/citypay_api_client/models/paylink_token_created.rb,
lib/citypay_api_client/models/process_batch_request.rb,
lib/citypay_api_client/api/card_holder_account_api__.rb,
lib/citypay_api_client/models/process_batch_response.rb,
lib/citypay_api_client/models/list_merchants_response.rb,
lib/citypay_api_client/models/paylink_cart_item_model.rb,
lib/citypay_api_client/api/operational_functions_api__.rb,
lib/citypay_api_client/models/acl_check_response_model.rb,
lib/citypay_api_client/models/domain_key_check_request.rb,
lib/citypay_api_client/models/direct_token_auth_request.rb,
lib/citypay_api_client/models/paylink_attachment_result.rb,
lib/citypay_api_client/models/paylink_field_guard_model.rb,
lib/citypay_api_client/models/paylink_adjustment_request.rb,
lib/citypay_api_client/models/paylink_attachment_request.rb,
lib/citypay_api_client/models/batch_report_response_model.rb,
lib/citypay_api_client/models/check_batch_status_response.rb,
lib/citypay_api_client/models/paylink_token_request_model.rb,
lib/citypay_api_client/models/tokenisation_response_model.rb,
lib/citypay_api_client/api/authorisation_and_payment_api__.rb,
lib/citypay_api_client/models/paylink_sms_notification_path.rb,
lib/citypay_api_client/models/batch_transaction_result_model.rb,
lib/citypay_api_client/models/paylink_email_notification_path.rb,
lib/citypay_api_client/models/paylink_bill_payment_token_request.rb,
lib/citypay_api_client/models/paylink_token_status_change_request.rb,
lib/citypay_api_client/models/paylink_token_status_change_response.rb

Overview

#CityPay Payment API

# 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 [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.

Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 6.2.1

Defined Under Namespace

Classes: AccountCreate, AccountStatus, Acknowledgement, AclCheckRequest, AclCheckResponseModel, AirlineAdvice, AirlineSegment, ApiClient, ApiError, ApiKey, AuthReference, AuthReferences, AuthRequest, AuthResponse, AuthenRequired, AuthorisationAndPaymentApi, Batch, BatchProcessingApi, BatchReportRequest, BatchReportResponseModel, BatchTransaction, BatchTransactionResultModel, Bin, BinLookup, CResAuthRequest, CaptureRequest, Card, CardHolderAccount, CardHolderAccountApi, CardStatus, ChargeRequest, CheckBatchStatus, CheckBatchStatusResponse, Configuration, ContactDetails, Decision, DirectPostApi, DirectPostRequest, DirectTokenAuthRequest, DomainKeyCheckRequest, DomainKeyRequest, DomainKeyResponse, Error, EventDataModel, Exists, ExternalMPI, ListMerchantsResponse, MCC6012, Merchant, OperationalFunctionsApi, PaResAuthRequest, PaylinkAddress, PaylinkAdjustmentRequest, PaylinkApi, PaylinkAttachmentRequest, PaylinkAttachmentResult, PaylinkBillPaymentTokenRequest, PaylinkCardHolder, PaylinkCart, PaylinkCartItemModel, PaylinkConfig, PaylinkCustomParam, PaylinkEmailNotificationPath, PaylinkErrorCode, PaylinkFieldGuardModel, PaylinkPartPayments, PaylinkSMSNotificationPath, PaylinkStateEvent, PaylinkTokenCreated, PaylinkTokenRequestModel, PaylinkTokenStatus, PaylinkTokenStatusChangeRequest, PaylinkTokenStatusChangeResponse, PaylinkUI, Ping, ProcessBatchRequest, ProcessBatchResponse, RefundRequest, RegisterCard, RequestChallenged, RetrieveRequest, ThreeDSecure, TokenisationResponseModel, VoidRequest

Constant Summary collapse

VERSION = 
'1.1.1'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

CityPayApiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



111
112
113
114
115
116
117
 
# File 'lib/citypay_api_client.rb', line 111

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end