v11

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

Products

Find products by gateway account ID and type

get/v1/api/gateway-account/{gatewayAccountId}/products

Path parameters

gatewayAccountIdinteger required

Query parameters

type'DEMO' | 'PROTOTYPE' | 'ADHOC' | 'AGENT_INITIATED_MOTO'

Response

amount_hintstring

date_createdstring date-time

descriptionstring

external_idstring

gateway_account_idinteger

language'en' | 'cy'

metadataobject

namestring

pay_api_tokenstring

priceinteger

product_name_pathstring

reference_enabledboolean

reference_hintstring

reference_labelstring

require_captchaboolean

return_urlstring

service_name_pathstring

status'ACTIVE' | 'INACTIVE'

type'DEMO' | 'PROTOTYPE' | 'ADHOC' | 'AGENT_INITIATED_MOTO'

Example response

[
  {
    "_links": [
      {
        "href": "http://products-url/v1/api/products/874h5c87834659q345698495",
        "method": "GET",
        "rel": "self"
      }
    ],
    "amount_hint": "Enter an amount in multiples of £2 for the number of permits required",
    "description": "Description of the product",
    "external_id": "874h5c87834659q345698495",
    "gateway_account_id": 1,
    "language": "en",
    "name": "A name for the product",
    "price": 1050,
    "product_name_path": "name-for-product",
    "reference_enabled": true,
    "reference_hint": "This can be found on your letter",
    "reference_label": "Amount for your licence",
    "return_url": "https://some.valid.url/",
    "service_name_path": "some-awesome-government-service",
    "status": "ACTIVE",
    "type": "DEMO"
  }
]