GOV.UK Pay

GOV.UK Pay — search and retrieve payments, their events, and all refunds against them.

Type: Tool
Category: Finance
Version: 1.0.0
Provider: InTouch AI
License: MIT

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

financepaymentsearch

Payments

Tool for the payments API.

Base URL: https://publicapi.payments.service.gov.uk
Auth: header:Authorization (pass your key via the apiKey input)

Operations

search_payments — GET /v1/payments — Search payments
get_a_payment — GET /v1/payments/{paymentId} — Find payment by ID
get_events_for_a_payment — GET /v1/payments/{paymentId}/events — Return payment events by ID
get_all_refunds_for_a_payment — GET /v1/payments/{paymentId}/refunds — Get all refunds for a payment
get_a_payment_refund — GET /v1/payments/{paymentId}/refunds/{refundId} — Find payment refund by ID
search_refunds — GET /v1/refunds — Search refunds

Inputs

apiKey — your payments API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: search_payments
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: search_payments, get_a_payment, get_events_for_a_payment, get_all_refunds_for_a_payment, get_a_payment_refund, search_refunds
`paymentId`	string	no	—	Path parameter paymentId (required by some operations).
`refundId`	string	no	—	Path parameter refundId (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.