CityPay API Documentation

Payments infrastructure for modern businesses

Accept payments, manage subscriptions, create Paylink experiences and authenticate transactions securely with a single, powerful API.

Get Started API Reference

POST /v6/authoriseAPI

{
  "amount": 5000,
  "currency": "GBP",
  "identifier": "ord_123"
}

REST API

Simple and powerful

SDKs

Multiple languages

PCI Compliant

Level 1 certified

Webhooks

Real-time events

Global Scale

99.9% uptime

Start building

Everything you need to integrate with CityPay.

5 minutes

Quickstart

Make your first API request and process a payment.

Start now

SDKs

Use our official SDKs to speed up integration.

View SDKs

Security

Authentication

Secure your API requests with HMAC authentication.

Learn more

Compliance

PCI DSS Guide

Understand your PCI DSS requirements.

Read guide

Popular APIs

Commonly used endpoints to power your integration.

View all APIs

Authorisation & Payments

Authorise and capture payments with support for 3DS.

12 endpoints

Payment Intent

Create and retrieve payment intents for stateful checkout flows.

2 endpoints

Paylink

Create secure payment links for your customers.

8 endpoints

Subscriptions

Preview planned recurring billing and customer subscription workflows.

Upcoming

Card Holder Accounts (Customers)

Store customer cardholder accounts and payment methods securely.

9 endpoints

Direct Post

Post payment forms directly to CityPay for ecommerce card payments.

5 endpoints

Elements

Collect card details securely with our UI components.

7 endpoints

Batch Processing

Process multiple payments efficiently in batches.

6 endpoints

Developer resources

Guides and references to help you build with confidence.

View all guides

Webhooks

Receive real-time event notifications.

10 min read

Testing

Test your integration in our sandbox environment.

15 min read

Errors

Understand and handle API errors.

8 min read

Pagination

Work with paginated API responses.

7 min read

Integrations

Explore platform integrations.

12 min read

BPS Adjustments

Apply Paylink BPS surcharges, discounts, and amount modifiers.

Guide

Still have questions?

Our support team is here to help you succeed.

Contact Support