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 C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 6.6.40
• SDK version: 1.3.3
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://www.citypay.com/contacts/

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using CityPayAPI.Api;
using CityPayAPI.Client;
using CityPayAPI.Model;

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out CityPayAPI.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

using System.Collections.Generic;
using System.Diagnostics;
using CityPayAPI.Api;
using CityPayAPI.Client;
using CityPayAPI.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.citypay.com";
            // Create a temporal ApiKey using your client id and licence key
            config.AddApiKey("cp-api-key", new ApiKey("CLIENT_ID", "LICENCE_KEY").GenerateKey());

            var apiInstance = new AuthorisationAndPaymentApi(config);
            var authRequest = new AuthRequest(); // AuthRequest | 

            try
            {
                // Authorisation
                Decision result = apiInstance.AuthorisationRequest(authRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AuthorisationAndPaymentApi.AuthorisationRequest: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

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

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

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