masstack

V0
V1
API Overview Resources Schemas

Applications

Parameters

Name In Type Required Description
app_owner_id path string true ‘none’
app_client_id path string true ‘none’
body body OperativeCreateApplicationRequest true ‘none’

Request body - instance of OperativeCreateApplicationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "appOwnerName": "string",
  "appOwnerEmail": "user@example.com",
  "appOwnerDescription": "string",
  "appClientSecret": "string",
  "appClientRedirectURL": "http://example.com",
  "appClientName": "string",
  "appClientEmail": "user@example.com",
  "appClientJwksUri": "http://example.com"
}
Name Type Required Description
appOwnerName string true The Aggregator Name plus the AppOwner ID.
appOwnerEmail string(email) true The AppOwner’s contactMedium.emailAddress.
appOwnerDescription string true Trading Name, organizationType and tax Number.
appClientSecret string true Application Client Secret.
appClientRedirectURL string(uri) true Application redirectURL.
appClientName string true Application commercialName.
appClientEmail string(email) false Application contact email.
appClientJwksUri string(uri) false Application Client jwks Uri.

Request example

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


curl -X POST https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'appOwnerName': 'string',
  'appOwnerEmail': 'user@example.com',
  'appOwnerDescription': 'string',
  'appClientSecret': 'string',
  'appClientRedirectURL': 'http://example.com',
  'appClientName': 'string',
  'appClientEmail': 'user@example.com',
  'appClientJwksUri': 'http://example.com'
}"

Responses

Code Meaning Description Schema
200 OK Successful operation OperativeApplicationClientResponse
400 Bad Request Problem with the client request OperativeErrorInfo
401 Unauthorized Unauthorized OperativeErrorInfo
403 Forbidden Client does not have sufficient permission. OperativeErrorInfo
500 Internal Server Error Server error OperativeErrorInfo
503 Service Unavailable Service unavailable. Typically the server is down. OperativeErrorInfo
504 Gateway Time-out Request time exceeded. If it happens repeatedly, consider reducing the request complexity OperativeErrorInfo

Parameters

Name In Type Required Description
app_owner_id path string true ‘none’
app_client_id path string true ‘none’

Request example

1
2
3
4


curl -X GET https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id} \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK Successful operation OperativeApplicationClientResponse
400 Bad Request Problem with the client request OperativeErrorInfo
401 Unauthorized Unauthorized OperativeErrorInfo
403 Forbidden Client does not have sufficient permission. OperativeErrorInfo
500 Internal Server Error Server error OperativeErrorInfo
503 Service Unavailable Service unavailable. Typically the server is down. OperativeErrorInfo
504 Gateway Time-out Request time exceeded. If it happens repeatedly, consider reducing the request complexity OperativeErrorInfo

Parameters

Name In Type Required Description
app_owner_id path string true ‘none’
app_client_id path string true ‘none’
body body OperativeCreateProductOrderRequest true ‘none’

Request body - instance of OperativeCreateProductOrderRequest

1
2
3
4
5
6

{
  "appOwnerId": "string",
  "appClientId": "string",
  "scope": "string",
  "purpose": "string"
}
Name Type Required Description
appOwnerId string false Application OwnerId.
appClientId string false Application ClientId.
scope string true Defines the scope of the API.
purpose string true Defines the purpose of the API.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id}/product-orders \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'appOwnerId': 'string',
  'appClientId': 'string',
  'scope': 'string',
  'purpose': 'string'
}"

Responses

Code Meaning Description Schema
201 Created Successful operation None
400 Bad Request Problem with the client request OperativeErrorInfo
401 Unauthorized Unauthorized OperativeErrorInfo
403 Forbidden Client does not have sufficient permission. OperativeErrorInfo
500 Internal Server Error Server error OperativeErrorInfo
503 Service Unavailable Service unavailable. Typically the server is down. OperativeErrorInfo
504 Gateway Time-out Request time exceeded. If it happens repeatedly, consider reducing the request complexity OperativeErrorInfo

400 - instance of OperativeErrorInfo

Custom schema example

1
2
3
4
5

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param"
}
Name Type Required Description
status integer true HTTP response status code
code string true Code given to this error
message string true Detailed error description

500 - instance of OperativeErrorInfo

Custom schema example

1
2
3
4
5

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials."
}
Name Type Required Description
status integer true HTTP response status code
code string true Code given to this error
message string true Detailed error description

503 - instance of OperativeErrorInfo

Custom schema example

1
2
3
4
5

{
  "status": 401,
  "code": "AUTHENTICATION_REQUIRED",
  "message": "New authentication is required."
}
Name Type Required Description
status integer true HTTP response status code
code string true Code given to this error
message string true Detailed error description

504 - instance of OperativeErrorInfo

Custom schema example

1
2
3
4
5

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}
Name Type Required Description
status integer true HTTP response status code
code string true Code given to this error
message string true Detailed error description

Endpoints

Consents

    Number Verification

      Sim Swap

        Applications