v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-03432547.1 KB
Services

Find service associated with gateway account ID

get/v1/api/services

Query parameters

gatewayAccountIdstring

Response

OK

agent_initiated_moto_enabledboolean
archivedboolean
archived_datestring date-time
collect_billing_addressboolean
created_datestring date-time
current_go_live_stage'NOT_STARTED' | 'ENTERED_ORGANISATION_NAME' | 'ENTERED_ORGANISATION_ADDRESS' | 'CHOSEN_PSP_ADYEN' | 'CHOSEN_PSP_STRIPE' | 'CHOSEN_PSP_GOV_BANKING_WORLDPAY' | 'GOV_BANKING_MOTO_OPTION_COMPLETED' | 'TERMS_AGREED_ADYEN' | 'TERMS_AGREED_STRIPE' | 'TERMS_AGREED_GOV_BANKING_WORLDPAY' | 'DENIED' | 'LIVE'
current_psp_test_account_stage'NOT_STARTED' | 'REQUEST_SUBMITTED' | 'CREATED'
custom_brandingobject
default_billing_address_countrystring
experimental_features_enabledboolean
external_idstring
gateway_account_idsstring[]
idinteger
internalboolean
namestring
redirect_to_service_immediately_on_terminal_stateboolean
sectorstring
service_featuresobject
service_nameobject
takes_payments_over_phoneboolean
went_live_datestring date-time

Example response

{
  "_links": [
    {
      "href": "https://an.example.link",
      "method": "GET",
      "rel": "self"
    }
  ],
  "archived_date": "2023-04-09T18:07:46.568Z",
  "collect_billing_address": true,
  "created_date": "2022-04-01T12:07:46.568Z",
  "current_go_live_stage": "NOT_STARTED",
  "current_psp_test_account_stage": "NOT_STARTED",
  "custom_branding": {
    "css_url": "css url",
    "image_url": "image url"
  },
  "default_billing_address_country": "GB",
  "external_id": "7d19aff33f8948deb97ed16b2912dcd3",
  "gateway_account_ids": [
    "1"
  ],
  "merchant_details": {
    "address_city": "London",
    "address_country": "GB",
    "address_line1": "Address line 1",
    "address_line2": "Address line 2",
    "address_postcode": "E1 8XX",
    "email": "email@example.com",
    "name": "organisation name",
    "telephone_number": "447700900000",
    "url": "http://www.example.org"
  },
  "name": "Some service name",
  "sector": "local government",
  "service_features": {
    "test_feature": {
      "enabled": true
    },
    "test_feature_2": {
      "enabled": false
    }
  },
  "service_name": {
    "cy": "Service name in welsh",
    "en": "Some service name"
  },
  "went_live_date": "2022-04-09T18:07:46.568Z"
}