Sign in
Services

Update merchant details of a service

put/v1/api/services/{serviceExternalId}/merchant-details

Path parameters

serviceExternalIdstring required

Request body

address_citystring required
address_countrystring required
address_line1string required
address_line2string
address_postcodestring required
emailstring
namestring required
telephone_numberstring
urlstring

Example request

{
  "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"
}

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": {
    "govuk_psp_is_adyen": {
      "enabled": true
    }
  },
  "service_name": {
    "cy": "Service name in welsh",
    "en": "Some service name"
  },
  "went_live_date": "2022-04-09T18:07:46.568Z"
}

Changes

Changed in 9 of the 53 revisions of this API.1410

  • 17f1bf9161721See the full diff
    • ▲

      the response's property type changed from array to object for status

      response-property-type-changed

  • 1f9978f5e1741See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 7c2ffa5bfb932See the full diff
    • ●

      added the new CHOSEN_PSP_ADYEN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TERMS_AGREED_ADYEN enum value to the response property for the response status

      response-property-enum-value-added

  • de931ca0f4481See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • af19ae9aaf456See the full diff
    • ○

      removed the CHOSEN_PSP_EPDQ enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CHOSEN_PSP_SMARTPAY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CHOSEN_PSP_WORLDPAY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TERMS_AGREED_EPDQ enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TERMS_AGREED_SMARTPAY enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TERMS_AGREED_WORLDPAY enum value from the response property for the response status

      response-property-enum-value-removed

  • e138c649db691See the full diff
    • ●

      added the new GOV_BANKING_MOTO_OPTION_COMPLETED enum value to the response property for the response status

      response-property-enum-value-added

  • c07ac65032161See the full diff
    • ○

      removed the CHOSEN_GOV_BANKING_MOTO enum value from the response property for the response status

      response-property-enum-value-removed

  • 3fe20c1da7ee1See the full diff
    • ●

      added the new CHOSEN_GOV_BANKING_MOTO enum value to the response property for the response status

      response-property-enum-value-added

  • e37356aab0361See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added