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.

• TLS Encryption: All data transmissions must utilise TLS version 1.2 or higher, employing strong cryptography. 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/.
• 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.

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.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 6.9.3
• Package version: 1.1.5
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.citypay.com/contacts/

Python 3.9+

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/citypay/citypay-api-client-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/citypay/citypay-api-client-python.git)

Then import the package:

import citypay

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import citypay

Execute pytest to run the tests.

Please follow the installation procedure and then run the following:

import citypay
from citypay.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.citypay.com
# See configuration.py for a list of all supported configuration parameters.
configuration = citypay.Configuration(
    host = "https://api.citypay.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cp-api-key
configuration.api_key['cp-api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cp-api-key'] = 'Bearer'


# Enter a context with an instance of the API client
with citypay.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = citypay.AuthorisationAndPaymentApi(api_client)
    auth_request = citypay.AuthRequest() # AuthRequest | 

    try:
        # Authorisation
        api_response = api_instance.authorisation_request(auth_request)
        print("The response of AuthorisationAndPaymentApi->authorisation_request:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorisationAndPaymentApi->authorisation_request: %s\n" % e)

All URIs are relative to https://api.citypay.com

• AccountCreate
• AccountStatus
• Acknowledgement
• AclCheckRequest
• AclCheckResponseModel
• AdjustmentCondition
• Adjustments
• AirlineAdvice
• AirlineSegment
• AuthReference
• AuthReferences
• AuthRequest
• AuthResponse
• Batch
• BatchReportRequest
• BatchReportResponseModel
• BatchTransaction
• BatchTransactionReportRequest
• BatchTransactionReportResponse
• BatchTransactionResultModel
• Bin
• BinLookup
• CResAuthRequest
• CaptureRequest
• Card
• CardHolderAccount
• CardStatus
• CardTokenisationRequest
• CardTokenisationResponse
• ChargeRequest
• CheckBatchStatus
• CheckBatchStatusResponse
• ContactDetails
• Decision
• DirectPostRequest
• DirectTokenAuthRequest
• DomainKeyCheckRequest
• DomainKeyRequest
• DomainKeyResponse
• Error
• EventDataModel
• Exists
• ExternalMPI
• FindPaymentIntentRequest
• HttpConfig
• ListMerchantsResponse
• MCC6012
• Merchant
• MerchantBatchReportRequest
• MerchantBatchReportResponse
• MerchantBatchResponse
• NetSummaryResponse
• PaylinkAddress
• PaylinkAdjustmentRequest
• PaylinkAttachmentRequest
• PaylinkAttachmentResult
• PaylinkBillPaymentTokenRequest
• PaylinkCardHolder
• PaylinkCart
• PaylinkCartItemModel
• PaylinkConfig
• PaylinkCustomParam
• PaylinkEmailNotificationPath
• PaylinkErrorCode
• PaylinkFieldGuardModel
• PaylinkPartPayments
• PaylinkResendNotificationRequest
• PaylinkSMSNotificationPath
• PaylinkStateEvent
• PaylinkTokenCreated
• PaylinkTokenRequestModel
• PaylinkTokenStatus
• PaylinkTokenStatusChangeRequest
• PaylinkTokenStatusChangeResponse
• PaylinkUI
• PaymentIntentReference
• PaymentIntentRequestModel
• PaymentIntentResponseModel
• Ping
• ProcessBatchRequest
• ProcessBatchResponse
• RefundRequest
• RegisterCard
• RegisterIpModel
• RemittanceData
• RemittanceReportRequest
• RemittanceReportResponse
• RemittedClientData
• RequestChallenged
• RetrieveRequest
• ThreeDSecure
• TokenisationResponseModel
• TransactionReportRequest
• VerificationRequest
• VoidRequest
• WebHookChannelCreateRequest
• WebHookChannelCreateResponse
• WebHookChannelDeleteRequest
• WebHookSubscriptionRequest
• WebHookSubscriptionResponse
• WebHookUnsubscribeRequest

Authentication schemes defined for the API:

• Type: API key
• API key parameter name: cp-api-key
• Location: HTTP header

• Type: API key
• API key parameter name: cp-domain-key
• Location: URL query string

support@citypay.com