CityPay API Documentation

Version: 6.4.18

Use the CityPay API to simplify complex payment authorisation workflows whether server or client based. Whether you're integrating Internet payments, Mail Order or Telephone Order (MOTO) transactions, managing Subscriptions with Recurring and Continuous Authority, 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.

Getting started

To get started, you will need a client and merchant id provided by CityPay, then download one of our dedicated client SDKs. You can read about how to make requests for the resources you need to access using our HTTP APIs using the SDK or this documentation. When your integration is ready to go live, contact us via your online control panel.


Learn how to authenticate your API requests.

Read more


Understand how to work with paginated responses.

Read more


Read about the different types of errors returned by the API.

Read more

Authorisation and Payment Api

The Payment Processing API offers standard and enhanced payment processing for MOTO, e-commerce and continuous authority transactions that include fraud and risk checking, 3D-Secure flows and payment querying.

Batch Processing Api

Batch processing uses the Batch and Instalment Service (BIS) which allows for transaction processing against cardholder accounts using a dynamic batch file. For merchants who process on schedules and dynamic amounts, the service allows for the presentation of cardholder account references and transaction requirements to run as a scheduled batch.

Card Holder Account Api

A cardholder account models a cardholder and can register 1 or more cards for tokenised charging. The account offers a credential on file option to the CityPay gateway allowing for both cardholder initiated and merchant initiated transaction processing. This can include unscheduled or scheduled transactions that can be requested through this API and include batch processing options.

Direct Post Api

The Direct Post Method for e-commerce payment is generally used by merchants that require more control over their payment form “look and feel” and can understand and implement the extra PCI DSS security controls that are required to protect their systems. The Direct Post Method uses the merchant’s website to generate the shopping cart and payment web pages.

Paylink Api

CityPay Paylink makes online e-commerce easier to implement by handling the card payment process directly with the cardholder's browser and CityPay's payment processing servers, allowing you to concentrate on your business whilst allowing us to manage the payment process.

Reporting Api

Reporting functions that return data based on payment processing services