Services
Search services by name or merchant name
This endpoint returns a list of services using lexical meaning to determine a match to the search criteria
post/v1/api/services/search
Request body
string required
Response
OK
Example response
{
"merchant_results": [
{
"_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"
}
],
"name_results": [
{
"_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"
}
]
}