Sign in

v11

latestOpenAPI 3.0.1raw.githubusercontent.com2025-07-2818719.5 KB
Payments

Find payment by payment external ID

get/v1/api/payments/{paymentExternalId}

Path parameters

paymentExternalIdstring required

Response

OK

amountinteger required
external_idstring required
govuk_payment_idstring
govuk_statusstring
product_external_idstring required
reference_numberstring
status'CREATED' | 'SUBMITTED' | 'ERROR' required

Example response

{
  "_links": [
    {
      "href": "https://govukpay-products.cloudapps.digital/v1/api/payments/h6347634cwb67wii7b6ciueroytw",
      "method": "GET",
      "rel": "self"
    },
    {
      "href": "https://some.valid.url/paid",
      "method": "GET",
      "rel": "next"
    }
  ],
  "amount": 1050,
  "external_id": "h6347634cwb67wii7b6ciueroytw",
  "govuk_payment_id": "7cs487heites2nne5k17j5j9as",
  "govuk_status": "success",
  "product_external_id": "uier837y735n837475y3847534",
  "reference_number": "RE4R2A6VAP",
  "status": "SUBMITTED"
}