Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HMRC UK Tax Authority Payments API

VAT payments made to HMRC

HMRC UK Tax Authority Payments API is one of 8 APIs that HMRC UK Tax Authority publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.service.hmrc.gov.uk, https://test-api.service.hmrc.gov.uk.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.service.hmrc.gov.uk
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

HMRC UK Tax Authority Payments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2UserRestricted) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • OAuth2UserRestricted — HMRC OAuth 2.0 Authorization Code grant (user-restricted)

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Payments 1

VAT payments made to HMRC

GET
/organisations/vat/{vrn}/payments
Retrieve VAT payments
getVatPayments 4 params → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are VatPayment (2 properties), PaymentsResponse (1 property). Each schema is shown below with its type and property counts.

PaymentsResponse
object
1 property
VatPayment
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hmrc-payments-api-openapi.yml Raw ↑

Other APIs HMRC UK Tax Authority publishes across the network.

HMRC Self Assessment API
HMRC PAYE (Pay As You Earn) API
HMRC Customs Declarations API
HMRC Corporation Tax API
HMRC UK Tax Authority Liabilities API
HMRC UK Tax Authority Obligations API
HMRC UK Tax Authority Returns API