payments.service.gov.uk

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

🔑 apikey 10 endpoints financial
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (1 total)

# See https://github.com/square/in-app-payments-flutter-plugin
curl examples
Search refunds
curl \
  -H "Authorization: $API_KEY" \
  /v1/refunds
Search payments
curl \
  -H "Authorization: $API_KEY" \
  /v1/payments
Find payment by ID
curl \
  -H "Authorization: $API_KEY" \
  /v1/payments/{paymentId}
Endpoints (10 total)
GET
/v1/refunds
Search refunds
GET
/v1/payments
Search payments
GET
/v1/payments/{paymentId}
Find payment by ID
GET
/v1/payments/{paymentId}/events
Return payment events by ID
GET
/v1/payments/{paymentId}/refunds
Get all refunds for a payment
GET
/v1/payments/{paymentId}/refunds/{refundId}
Find payment refund by ID
POST
/v1/payments
Create new payment
POST
/v1/payments/{paymentId}/cancel
Cancel payment
POST
/v1/payments/{paymentId}/capture
Capture payment
POST
/v1/payments/{paymentId}/refunds
Submit a refund for a payment
Language coverage
Objective-C
1
At a glance
Total SDKs1
Languages1
Endpoints10
Authapikey
Categories1