GOV.UK Pay API API

by payments.service.gov.uk

API keyHTTPSFinance

Overview

GOV.UK Pay API (This version is no longer maintained. See openapi/publicapi_spec.json for latest API specification)

GOV.UK Pay API is a finance API from payments.service.gov.uk. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 10 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://publicapi.payments.service.gov.uk
Version: 1.0.3
Endpoints: 10
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://publicapi.payments.service.gov.uk/v1/payments" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://publicapi.payments.service.gov.uk/v1/payments", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://publicapi.payments.service.gov.uk/v1/payments",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1/payments`	Search payments
POST	`/v1/payments`	Create new payment
GET	`/v1/payments/{paymentId}`	Find payment by ID
POST	`/v1/payments/{paymentId}/cancel`	Cancel payment
POST	`/v1/payments/{paymentId}/capture`	Capture payment
GET	`/v1/payments/{paymentId}/events`	Return payment events by ID
GET	`/v1/payments/{paymentId}/refunds`	Get all refunds for a payment
POST	`/v1/payments/{paymentId}/refunds`	Submit a refund for a payment
GET	`/v1/payments/{paymentId}/refunds/{refundId}`	Find payment refund by ID
GET	`/v1/refunds`	Search refunds