CityPay Payment API

• API version: 6.9.2
  • Build date: 2025-06-19T10:43:48.671338044Z[Etc/UTC]
  • Generator version: 7.13.0

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.

For more information, please visit https://www.citypay.com/contacts/

Automatically generated by the OpenAPI Generator

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Add this dependency to your project's POM:

<dependency>
  <groupId>com.citypay</groupId>
  <artifactId>citypay-api-client-java</artifactId>
  <version>1.1.7</version>
  <scope>compile</scope>
</dependency>

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/citypay-api-client-java-1.1.7.jar
• target/lib/*.jar

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.citypay.client.ApiClient;
import com.citypay.client.ApiException;
import com.citypay.client.Configuration;
import com.citypay.client.auth.*;
import com.citypay.client.model.*;
import com.citypay.client.api.AuthorisationAndPaymentApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.citypay.com");
    

    AuthorisationAndPaymentApi apiInstance = new AuthorisationAndPaymentApi(defaultClient);
    AuthRequest authRequest = new AuthRequest(); // AuthRequest | 
    try {
      Decision result = apiInstance.authorisationRequest(authRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuthorisationAndPaymentApi#authorisationRequest");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

support@citypay.com