masstack

V3
API Overview Resources Schemas

Service Operations

Parameters

Name In Type Required Description
Request-Correlation-Id header string(uuid) false Correlation Id for tracing (unique identifier)
service_type path serviceTypeDTO true Service type indicator
body body createServiceRequestDTO true Create a new service

Enumerated Values

Property Values
service_type one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of createServiceRequestDTO

1
2
3
4
5
6
7
8
9

{
  "service_id": "string",
  "service_details": {
    "secondary_eid": "string",
    "secondary_iccid": "string"
  },
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}
Name Type Required Description
service_id string false none
service_details serviceDetailsDTO true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


curl -X POST https://partners.sta.masstack.com/v3/applewatch/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'service_id': 'string',
  'service_details': {
    'secondary_eid': 'string',
    'secondary_iccid': 'string'
  },
  'callback_success_url': 'https://myserver.com/send/callback/here',
  'callback_error_url': 'https://myserver.com/send/callback/here'
}"

Responses

Code Meaning Description Schema
202 Accepted Successfully accepted the operation request, returned the request external reference identifier None
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

success_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body serviceCallbackDTO true ‘none’

Request body - instance of serviceCallbackDTO

1
2
3
4
5

{
  "code": "OK",
  "title": "Service was successfully created",
  "service_id": 600000000
}
Name Type Required Description
code string true none
title string true none
service_id string true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://partners.sta.masstack.com/v3/{service_type}/ \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'code': 'OK',
  'title': 'Service was successfully created',
  'service_id': 600000000
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

error_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body serviceCallbackDTO true ‘none’

Request body - instance of serviceCallbackDTO

1
2
3
4
5

{
  "code": "OK",
  "title": "Service was successfully created",
  "service_id": 600000000
}
Name Type Required Description
code string true none
title string true none
service_id string true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://partners.sta.masstack.com/v3/{service_type}/ \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'code': 'OK',
  'title': 'Service was successfully created',
  'service_id': 600000000
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

Parameters

Name In Type Required Description
Request-Correlation-Id header string(uuid) false Correlation Id for tracing (unique identifier)
service_type path serviceTypeDTO true Service type indicator
service_id path string true Service identifier whose device will be updated
device_id path string true Device identifier to be updated
body body updateServiceDeviceRequestDTO true Update an existing service device

Enumerated Values

Property Values
service_type one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of updateServiceDeviceRequestDTO

1
2
3
4
5
6
7
8
9

{
  "category": "eSIM",
  "new_service_device_details": {
    "iccid": 8934011411551283000,
    "eid": 8.903302331217e+31
  },
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}
Name Type Required Description
category string true none
new_service_device_details deviceDetailsDTO true none
Property Values
category one of [STB, SMARTWATCH, TABLET, ROUTER, PBX, SMARTPHONE, WIFI_EXTENDER, OTHER, SIM, eSIM]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


curl -X PATCH https://partners.sta.masstack.com/v3/mobile/612123456/devices/{device_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'category': 'eSIM',
  'new_service_device_details': {
    'iccid': 8934011411551283000,
    'eid': 8.903302331217e+31
  },
  'callback_success_url': 'https://myserver.com/send/callback/here',
  'callback_error_url': 'https://myserver.com/send/callback/here'
}"

Responses

Code Meaning Description Schema
202 Accepted Successfully accepted the operation request, returned the request external reference identifier None
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

success_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body serviceCallbackDTO true ‘none’

Request body - instance of serviceCallbackDTO

1
2
3
4
5

{
  "code": "OK",
  "title": "Service was successfully created",
  "service_id": 600000000
}
Name Type Required Description
code string true none
title string true none
service_id string true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X PATCH https://partners.sta.masstack.com/v3/{service_type}/{service_id}/devices/{device_id} \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'code': 'OK',
  'title': 'Service was successfully created',
  'service_id': 600000000
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

error_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body serviceCallbackDTO true ‘none’

Request body - instance of serviceCallbackDTO

1
2
3
4
5

{
  "code": "OK",
  "title": "Service was successfully created",
  "service_id": 600000000
}
Name Type Required Description
code string true none
title string true none
service_id string true none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X PATCH https://partners.sta.masstack.com/v3/{service_type}/{service_id}/devices/{device_id} \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'code': 'OK',
  'title': 'Service was successfully created',
  'service_id': 600000000
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

Endpoints

Barrings Operations

    Billing Operations

      Promotions Operations

        Service Operations