Imported data
permissions apiKey | Recurso | Descripción |
|---|---|
| Accounts | Access to accounts |
| External accounts | Access to external accounts |
| Customers | Access to customers |
| External customers | Access to external customers |
| Categories | Access to customer categories |
| Customers Categories | Access to customer categories |
| Special Treatment | Access to special treatment |
| Customer Special Treatment | Access to customers special treatment |
| Credit Card Tokenization | Credit card tokenization request operations |
| Customer credentials | Access to customer credentials |
| Customer identification processes | Access to customer identification processes |
permissions apiKey | Recurso | Descripción |
|---|---|
| Accounts | Access to accounts |
| External accounts | Access to external accounts |
| Customers | Access to customers |
| External customers | Access to external customers |
| Categories | Access to customer categories |
| Customers Categories | Access to customer categories |
| Special Treatment | Access to special treatment |
| Customer Special Treatment | Access to customers special treatment |
| Credit Card Tokenization | Credit card tokenization request operations |
| Customer credentials | Access to customer credentials |
| Customer identification processes | Access to customer identification processes |
DigitalEmail: maxLength 255 → 82.Credential.username and CredentialResponse.username: maxLength 150 → 82.external_id field to CustomerSearchResponse schemanationality field to PatchPersonalInfo schemaPersonalInfoNationality schema with ISO 3166-1 alpha-2 pattern validation (^[A-Z]{2}$)address_lines values containing the literal string "undefined" in POST /customers and POST /customers/{id}/accountsaddress_lines items, aligned with Oracle column limitsmaxLength from 255 to 100 in Address and BillingAddress schemasPutAssociatedUsersRequest for the request body (reuses AssociatedUser for items)associated_users property from PatchCompanyInfo schemaPatchAssociatedUser schema (no longer referenced)associated_users support in CompanyInfo and CompanyInfoResponsecycle.name, day, type and frequency to InvoiceCycle schema.status field from GetAccount schema. Won't be usedreference_id to token_idstatus field from GetAccount schema. Won't be usedreference_id to token_idreference_id fieldstatus with enum values ACTIVE and PAYMENT_METHOD_PENDING to GetAccount schemareference_id field in GetPaymentMethod schemastate_id to BillingAddress schemapayment_method field.customer_id field.external_id has been removed from the response. It can be added in the future if needed.nationality> fields in AssociatedUsercontact_info> and nationality> fields in AssociatedUserexternal_id> to POST /orgs/{org_id}/customers responsecreate_date_time>, end_date_time>, last_modified_date_time>
in GET /orgs/{org_id}/customers/{customer_id}/categoriesvalue> in customer categories now is nullablevalue> in customer categories now is nullable. Customer categories with null value won't be shownreason> in customer category. Will be checked in codereason> fieldReturns all the info about a single account given by account id.
PATH PARAMETERS
organization name
Account identifier
OK successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "214748364",
"customer_id": "1efd6af5-dc6b-438e-b523-44f91322beac",
"customer_external_id": "23768603",
"contract_reference": "MMC1708177227910",
"modality": "PREPAID",
"billing_address": {
"address_lines": [
"Avenida de Bruselas, 38"
],
"postal_code": "28108",
"state_id": "28",
"locality": "Alcobendas",
"administrative_area": "Madrid",
"region_code": "ES"
},
"payment_method": {
"direct_debit": {
"type": "DIRECT_DEBIT",
"details": {
"iban": "ES7921000813610123456789"
}
},
"credit_card": {
"type": "CREDIT_CARD",
"details": {
"token_id": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
}
},
"bank_transfer": {
"type": "BANK_TRANSFER",
"details": {}
},
"teci": {
"type": "TECI",
"details": {
"token_teci": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
}
}
},
"invoice": {
"cycle": {
"name": "DIA 1 - MENSUAL",
"day": 1,
"type": "M",
"frequency": 1
},
"due_date_id": 5,
"due_days_id": 1,
"delivery_mode": "EMAIL"
},
"created_at": "2022-01-01T01:01:01Z",
"ended_at": "2022-01-01T01:01:01Z",
"updated_at": "2022-01-01T01:01:01Z"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string (uuid) | Account id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id | string | null | Account external id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id* | string (uuid) | Customer id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_external_id | string | null | Customer external id (legacy Oracle CUSTOMERID) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_reference | string | null | Contract reference | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
modality* | string
()
PREPAIDRECURRING_PREPAIDPOSTPAID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_address | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_method | object | Payment method is required for RECURRING_PREPAID and POSTPAID modalities. PREPAID modality has no payment method associated. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice | object | null | Account invoice info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at* | string (date-time) | Account creation date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ended_at | string (date-time) | null | Account end date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at* | string (date-time) | Account end date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000' \
-H 'Accept: application/json'Update account payment method for a given account id
PATH PARAMETERS
organization name
Account identifier
{
"type": "BANK_TRANSFER",
"details": {}
}| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
type* | string
()
BANK_TRANSFERDIRECT_DEBITCREDIT_CARD | ||||||||
details | any | any | any | iban is mandatory when type is DIRECT_DEBIT, token_id OR reference_id is mandatory when type is CREDIT_CARD | |||||||
| |||||||||
Accepted Asynchronous payment method update accepted (credit card with reference_id for pending tokenization)
No Content Synchronous payment method update completed successfully (bank transfer, direct debit, or credit card with token_id)
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/payment-method' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"type": "BANK_TRANSFER",
"details": {}
}'Returns the history of payment methods for a single account given by account id. The result includes all historical payment methods with their details.
PATH PARAMETERS
organization name
Account identifier
OK successful operation
{
"payment_methods": [
{
"payment_method_type": "DIRECT_DEBIT",
"details": "ES7921000813610123456789",
"created_at": "2022-01-01T01:01:01Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
payment_methods | object[] | |||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/payment-methods/historical' \
-H 'Accept: application/json'Returns the history of billing address changed about a single account given by account id. You can filter the time period you want to query. To do this, you must enter the 'from' and *'to' query parameters. Neither field is required for the query. If you do not enter these fields, the entire billing address change history for the account will be displayed. If you enter these fields, they must be entered in the yyyy-MM-dd format.
PATH PARAMETERS
organization name
Account identifier
QUERY PARAMETERS
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01
OK successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "214748364",
"from": "2020-01-01",
"to": "2020-01-01",
"history": [
{
"billing_address": {
"address_lines": [
"Avenida de Bruselas, 38"
],
"postal_code": "28108",
"state_id": "28",
"locality": "Alcobendas",
"administrative_area": "Madrid",
"region_code": "ES"
},
"init_date": "2022-01-01T01:01:01Z",
"end_date": "2022-01-01T01:01:01Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) | Account id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id | string | null | Account external id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date) | null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date) | null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
history | object[] | minItems: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/billing-address?from=2020-01-01&to=2020-12-31' \
-H 'Accept: application/json'Returns the invoice address information about a single account given by account id.
PATH PARAMETERS
organization name
Account identifier
OK successful operation
{
"name": "Antonio Benavente Blanco",
"address_lines": [
"Avenida de Bruselas, 38"
],
"postal_code": "28108",
"locality": "Alcobendas",
"administrative_area": "Madrid",
"region_code": "ES"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Destiny name | maxLength: 300 | |
address_lines* | string[] | minItems: 1, maxItems: 1 | ||
postal_code* | string | maxLength: 5, pattern: ^([0-4]\d{4})|(5[0-2]\d{3})$ | ||
locality* | string | minLength: 2, maxLength: 255 | ||
administrative_area* | string | minLength: 4, maxLength: 50 | ||
region_code* | string |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/invoice-recipient' \
-H 'Accept: application/json'list account promotions by account
ACTIVATED: Returns the list of active promotions for the account. Those with a past activated_date and future expiration_date, which must be applied to the customer's invoice. This is the default value if not sent.
SCHEDULED: Returns the list of scheduled promotions: those with a future activation date.
ALL: includes all those mentioned in the previous two.
PATH PARAMETERS
organization name
Account identifier
QUERY PARAMETERS
Account Promotion Type
OK successful operation
[
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"account_id": "123e4567-e89b-12d3-a456-556642440000",
"promotion_id": 2064,
"start_date": "2025-09-01",
"end_date": "2026-03-01",
"status": "PENDING"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Promotion Account identifier | ||
account_id | string (uuid) | Account identifier | ||
promotion_id | integer | Promotion identifier | minLength: 1, maxLength: 4 | |
start_date | string (date) | Star Date to promotion in account | ||
end_date | string (date) | End Date to promotion in account | ||
status | string | Status to promotion in account |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/promotions?account_promotion_type=ACTIVE' \
-H 'Accept: application/json'Add promotion for a given account id
PATH PARAMETERS
organization name
Account identifier
OK successful operation
[
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"account_id": "123e4567-e89b-12d3-a456-556642440000",
"promotion_id": 2064,
"start_date": "2025-09-01",
"end_date": "2026-03-01",
"status": "PENDING"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Promotion Account identifier | ||
account_id | string (uuid) | Account identifier | ||
promotion_id | integer | Promotion identifier | minLength: 1, maxLength: 4 | |
start_date | string (date) | Star Date to promotion in account | ||
end_date | string (date) | End Date to promotion in account | ||
status | string | Status to promotion in account |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/promotions' \
-H 'Accept: application/json'get all operation to promotions to account by date
PATH PARAMETERS
organization name
Account identifier
QUERY PARAMETERS
Reference date to list account promotion operation history
OK successful operation
[
{
"account_id": "123e4567-e89b-12d3-a456-556642440000",
"promotion_id": 2064,
"start_date": "2025-09-01",
"end_date": "2026-03-01",
"status": "PENDING",
"operation": "INSERT"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
account_id | string (uuid) | Account identifier | ||
promotion_id | integer | Promotion identifier | minLength: 1, maxLength: 4 | |
start_date | string (date) | Star Date to promotion in account | ||
end_date | string (date) | End Date to promotion in account | ||
status | string | Status to promotion in account | ||
operation | string | Operation |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/promotions_hist?start_date=2025-09-01' \
-H 'Accept: application/json'Update cancellation date to account promotion
PATH PARAMETERS
organization name
Account identifier
Account promotion relation identifier
{
"cancellation_date": "2025-09-01"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
cancellation_date* | string (date) | Cancellation Date to promotion in account |
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/promotions/123e4567-e89b-12d3-a456-556642440000' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"cancellation_date": "2025-09-01"
}'Get the account ID list for a single customer
PATH PARAMETERS
organization name
Customer identifier
OK Customer accounts returned successfully
{
"accounts": [
{
"id": "123e4567-e89b-12d3-a456-556642440000"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accounts | object[] | minItems: 0 | ||||||||||||
Array items:
| ||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/accounts' \
-H 'Accept: application/json'Create account information about a single account and a single customer
PATH PARAMETERS
organization name
Customer identifier
{
"modality": "RECURRING_PREPAID",
"billing_address": {
"address_lines": [
"Avenida de Bruselas, 38"
],
"postal_code": "28108",
"state_id": "28",
"locality": "Alcobendas",
"administrative_area": "Madrid",
"region_code": "ES"
},
"payment_method": {
"type": "BANK_TRANSFER",
"details": {}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
modality* | string
()
RECURRING_PREPAIDPOSTPAID | ||||||||||||||||||||||||||||||||||||||
billing_address | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
payment_method* | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
OK Synchronous workflow completed successfully (bank transfer, direct debit, or credit card with token_id)
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "214748364"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Account id | ||
external_id | string | null | Account external id |
Accepted Asynchronous workflow accepted (credit card with reference_id for pending tokenization)
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "214748364"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Account id | ||
external_id | string | null | Account external id |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/accounts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"modality": "RECURRING_PREPAID",
"billing_address": {
"address_lines": [
"Avenida de Bruselas, 38"
],
"postal_code": "28108",
"state_id": "28",
"locality": "Alcobendas",
"administrative_area": "Madrid",
"region_code": "ES"
},
"payment_method": {
"type": "BANK_TRANSFER",
"details": {}
}
}'Delete account information about a single account and a single customer given by the ids.
PATH PARAMETERS
organization name
Customer identifier
Account identifier
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/accounts/123e4567-e89b-12d3-a456-556642440000' \
-H 'Accept: application/json'Returns all available payment methods for an account
PATH PARAMETERS
organization name
Customer identifier
Account identifier
OK Payment methods returned successfully
{
"payment_methods": [
"BANK_TRANSFER"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
payment_methods | string[] | minItems: 1 |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/accounts/123e4567-e89b-12d3-a456-556642440000/available-payment-methods' \
-H 'Accept: application/json'Returns account id given by account external id
PATH PARAMETERS
organization name
External id of account to return
OK successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Account id |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364' \
-H 'Accept: application/json'Returns all contracts by account external id
PATH PARAMETERS
organization name
External id of account to return
OK successful operation
{
"contracts": [
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"account_external_id": "214748364",
"start_date": "2022-01-01T01:01:01Z",
"end_date": "2022-01-01T01:01:01Z",
"requests": [
{
"request_external_id": "214748364",
"create_date": "2022-01-01T01:01:01Z",
"contract_reference_id": "MMC2105077108808",
"type": "SALE_MOBILE_ONLY",
"origin_user": "john.doe"
}
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
contracts* | object[] | Contracts | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364/contracts' \
-H 'Accept: application/json'Returns active contract by account external id
PATH PARAMETERS
organization name
External id of account to return
OK successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"account_external_id": "214748364",
"start_date": "2022-01-01T01:01:01Z",
"end_date": "2022-01-01T01:01:01Z",
"requests": [
{
"request_external_id": "214748364",
"create_date": "2022-01-01T01:01:01Z",
"contract_reference_id": "MMC2105077108808",
"type": "SALE_MOBILE_ONLY",
"origin_user": "john.doe"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) | |||||||||||||||||||||||||||||||||
account_external_id | string | Account external id | ||||||||||||||||||||||||||||||||
start_date | string (date-time) | Contract start date | ||||||||||||||||||||||||||||||||
end_date | string (date-time) | Contract end date | ||||||||||||||||||||||||||||||||
requests | object[] | Contract requests | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364/contracts/active' \
-H 'Accept: application/json'Create a single customer.
PATH PARAMETERS
organization name
{
"type": "PRIVATE_CUSTOMER",
"preferred_language": "es",
"segment": "CONSUMER",
"contact_info": {
"phone_numbers": [
{
"country_code": "+34",
"number": "615667898",
"type": "MOBILE",
"is_default": true
}
],
"emails": [
{
"email": "email@example.com",
"is_default": true
}
],
"postal_address": {
"address_lines": [
"Calle Mayor 2, 3º A"
],
"postal_code": "28039",
"locality": "Fuenlabrada",
"administrative_area": "Madrid",
"region_code": "ES"
}
},
"personal_info": {
"identity_document": {
"number": "14861628V",
"type": "NIF"
},
"name": "Antonio",
"first_surname": "Benavente",
"second_surname": "Blanco",
"gender": "MALE",
"nationality": "ES",
"birthdate": "2022-01-01"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type* | string
()
PRIVATE_CUSTOMERCORPORATE_CUSTOMERDIGITAL_CUSTOMER | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preferred_language* | string
()
escagleuenpt | Customer's preferred language code in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) lowercase format | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
segment* | string
()
CONSUMERSELF_EMPLOYEESME | Customer's segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contact_info* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
personal_info* | object | Private customer personal information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type* | string
()
PRIVATE_CUSTOMERCORPORATE_CUSTOMERDIGITAL_CUSTOMER | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preferred_language* | string
()
escagleuenpt | Customer's preferred language code in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) lowercase format | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
segment* | string
()
CONSUMERSELF_EMPLOYEESME | Customer's segment, whether it is an individual, a self-employed customer, or a company (although so far we just support SME - Small Medium Enterprise). For PrivateCustomer: * CONSUMER For CorporateCustomer: * SELF_EMPLOYEE * SME | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contact_info* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
company_info* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type* | string
()
PRIVATE_CUSTOMERCORPORATE_CUSTOMERDIGITAL_CUSTOMER | |||||||||||||||||||||||||||||||||||||||||||||||||||||
preferred_language* | string
()
escagleuenpt | Customer's preferred language code in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) lowercase format | ||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_personal_info* | object | Digital customer personal information | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "1111"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Customer id | ||
external_id | string | null | Customer external id. Only returned when inserted by ourselves. |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"type": "PRIVATE_CUSTOMER",
"preferred_language": "es",
"segment": "CONSUMER",
"contact_info": {
"phone_numbers": [
{
"country_code": "+34",
"number": "615667898",
"type": "MOBILE",
"is_default": true
}
],
"emails": [
{
"email": "email@example.com",
"is_default": true
}
],
"postal_address": {
"address_lines": [
"Calle Mayor 2, 3º A"
],
"postal_code": "28039",
"locality": "Fuenlabrada",
"administrative_area": "Madrid",
"region_code": "ES"
}
},
"personal_info": {
"identity_document": {
"number": "14861628V",
"type": "NIF"
},
"name": "Antonio",
"first_surname": "Benavente",
"second_surname": "Blanco",
"gender": "MALE",
"nationality": "ES",
"birthdate": "2022-01-01"
}
}'Returns customer ids
PATH PARAMETERS
organization name
QUERY PARAMETERS
Document with numbers and letters
Document type
Email used by customer to authenticate
OK successful operation
{
"customer": {
"id": "123e4567-e89b-12d3-a456-556642440000",
"external_id": "214748364"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customer | object | ||||||||||||||||||
| |||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/search?identity_document=12345678A&identity_document_type=NIF&email=email%40example.com' \
-H 'Accept: application/json'Returns all the info about a single customer given by customer id.
PATH PARAMETERS
organization name
Customer identifier
OK successful operation
{}| Property | Type | Description | Constraints | Default |
|---|
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000' \
-H 'Accept: application/json'Update customer information
PATH PARAMETERS
organization name
Customer identifier
{
"preferred_language": "es",
"contact_info": {
"phone_numbers": [
{
"country_code": "+34",
"number": "615667898",
"type": "MOBILE"
}
],
"emails": [
{
"email": "email@example.com"
}
]
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
preferred_language | string
()
escagleuenpt | Customer's preferred language code in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) lowercase format | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contact_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"preferred_language": "es",
"contact_info": {
"phone_numbers": [
{
"country_code": "+34",
"number": "615667898",
"type": "MOBILE"
}
],
"emails": [
{
"email": "email@example.com"
}
]
}
}'Delete customer by its id.
PATH PARAMETERS
organization name
Customer identifier
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000' \
-H 'Accept: application/json'Creates or updates the authorized representative of a business customer.
The associated_users array must contain exactly one element.
Currently, only the AUTHORIZED_REPRESENTATIVE role is supported. If role is not provided, it defaults to AUTHORIZED_REPRESENTATIVE.
PATH PARAMETERS
organization name
Customer identifier
{
"associated_users": [
{
"identity_document": {
"number": "12345678Z",
"type": "NIF"
},
"role": "AUTHORIZED_REPRESENTATIVE",
"name": "John",
"first_surname": "Doe",
"second_surname": "Smith",
"nationality": "ES"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
associated_users* | object[] | List of associated users to set. Currently only one representative per customer is supported. | minItems: 1, maxItems: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
No Content Authorized representative set successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/associated_users' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"associated_users": [
{
"identity_document": {
"number": "12345678Z",
"type": "NIF"
},
"role": "AUTHORIZED_REPRESENTATIVE",
"name": "John",
"first_surname": "Doe",
"second_surname": "Smith",
"nationality": "ES"
}
]
}'Returns all tokenized credit cards for the specified customer id
PATH PARAMETERS
organization name
Customer identifier
OK Credit cards returned successfully
{
"available_credit_cards": [
{
"id": "e58ed763-928c-4155-bee9-fdbaaadc15f3",
"created_at": "2022-01-01T01:01:01Z",
"summary": "5100",
"expiration_date": "05/2029"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
available_credit_cards | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/available-credit-cards' \
-H 'Accept: application/json'Updates a customer’s document from the specified NIE to the specified NIF
PATH PARAMETERS
organization name
Customer identifier
{
"nif": "07687697Q"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
nif* | string | NIF | minLength: 1 |
No Content NIE converted successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/convert-nie-to-nif' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"nif": "07687697Q"
}'Returns customer id given by customer external id
PATH PARAMETERS
organization name
Customer external id
OK successful operation
{
"id": "123e4567-e89b-12d3-a456-556642440000"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Customer id |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/external-customers/214748364' \
-H 'Accept: application/json'Returns all categories for the specified tenant
PATH PARAMETERS
organization name
OK All categories returned successfully
{
"categories": [
{
"id": 214748364,
"name": "risk",
"description": "Risk category",
"valid_values": [
"high"
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
categories* | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/categories' \
-H 'Accept: application/json'Inserts new categories for the specified tenant
PATH PARAMETERS
organization name
{
"categories": [
{
"name": "risk",
"description": "Risk category",
"valid_values": [
"string"
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
categories* | object[] | |||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Created Categories created successfully
{
"categories": [
{
"id": 214748364,
"name": "risk",
"description": "Risk category",
"valid_values": [
"high"
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
categories* | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/categories' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"categories": [
{
"name": "risk",
"description": "Risk category",
"valid_values": [
"string"
]
}
]
}'Returns specified category
PATH PARAMETERS
organization name
Category id to be returned
OK Category returned successfully
{
"id": 214748364,
"name": "risk",
"description": "Risk category",
"valid_values": [
"high"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | integer (int32) | Category id | ||
name* | string | Category name. Only accepts alphanumeric characters and underscore special character. Will not accept spaces | pattern: ^[A-Za-z0-9_]{1,50}$ | |
description | string | Category description | ||
valid_values | string[] | Optional field to restrict the possible values that the category can have when it's associated with the customer. If this field is empty or not present, the category can have any value when associated with the customer. | uniqueItems |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364' \
-H 'Accept: application/json'Update category information
PATH PARAMETERS
organization name
Category id to be returned
{
"description": "Risk category",
"valid_values": [
"string"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
description | string | Category description | ||
valid_values | string[] | Must include all values already present and new values to be added, or less values to be removed. | uniqueItems |
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"description": "Risk category",
"valid_values": [
"string"
]
}'Delete the category by its id
PATH PARAMETERS
organization name
Category id to be returned
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/categories/214748364' \
-H 'Accept: application/json'For a given customer id, returns the history for category updates
PATH PARAMETERS
organization name
Customer identifier
OK Customer Category History returned successfully
{
"customer_id": "123e4567-e89b-12d3-a456-556642440000",
"categories": [
{
"id": 214748364,
"name": "risk",
"historical_values": [
{
"value": "a",
"description": "This is an a of category 1",
"reason": "Change because this is a test",
"create_date": "2022-01-01T01:01:01Z",
"end_date": "2022-01-01T01:01:01Z",
"last_modified_date": "2022-01-01T01:01:01Z",
"modified_by": "user"
}
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customer_id* | string (uuid) | Customer id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
categories* | object[] | Customer categories with history | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/historical' \
-H 'Accept: application/json'Returns all categories for the specified customer id
PATH PARAMETERS
organization name
Customer identifier
OK Categories returned successfully
{
"customer_id": "123e4567-e89b-12d3-a456-556642440000",
"categories": [
{
"id": 214748364,
"name": "risk",
"value": "a",
"description": "This is an a of category 1",
"reason": "Change because this is a test",
"create_date_time": "2022-01-01T01:01:01Z",
"last_modified_date_time": "2022-01-01T01:01:01Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customer_id* | string (uuid) | Customer id | ||||||||||||||||||||||||||||||||||||||||||
categories* | object[] | Customer categories | ||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories' \
-H 'Accept: application/json'Associates a new category id for a specified customer id
PATH PARAMETERS
organization name
Customer identifier
{
"id": 214748364,
"value": "influencer",
"description": "Bill discount",
"reason": "Masmovil sponsors their videos"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | integer (int32) | Category id | ||
value* | string | null | Category value. | pattern: ^[a-z0-9_]{1,50}$ | |
description | string | Description of the category value. | minLength: 1, maxLength: 200 | |
reason | string | Reason for the set of value. | minLength: 1, maxLength: 200 |
Created Categories added successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"id": 214748364,
"value": "influencer",
"description": "Bill discount",
"reason": "Masmovil sponsors their videos"
}'Returns one category for the specified customer id and category id
PATH PARAMETERS
organization name
Customer identifier
Category id to be returned
OK Category returned successfully
{
"id": 214748364,
"name": "risk",
"value": "a",
"description": "This is an a of category 1",
"reason": "Change because this is a test",
"create_date_time": "2022-01-01T01:01:01Z",
"last_modified_date_time": "2022-01-01T01:01:01Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | integer (int32) | Category ID | ||
name | string | Category name | ||
value | string | null | Category value. If null, category won't be shown | ||
description | string | Description of the category value | minLength: 1, maxLength: 50 | |
reason | string | Reason for the set of value | minLength: 1, maxLength: 50 | |
create_date_time | string (date-time) | Category creation date and time | ||
last_modified_date_time | string (date-time) | Category last modified date and time |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364' \
-H 'Accept: application/json'Update customer category information by customer and category id
PATH PARAMETERS
organization name
Customer identifier
Category id to be returned
{
"value": "influencer",
"description": "This is an a of category 1",
"reason": "Riesgo por campañas de fidelizacion: Fidelizacion CP Outbound MM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
value | string | null | Category value. | pattern: ^[a-z0-9_]{1,50}$ | |
description | string | null | Description of the category value. | minLength: 1, maxLength: 200 | |
reason | string | null | Reason for the set of value. | minLength: 1, maxLength: 200 |
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"value": "influencer",
"description": "This is an a of category 1",
"reason": "Riesgo por campañas de fidelizacion: Fidelizacion CP Outbound MM"
}'Delete one category for the specified customer id and category id
PATH PARAMETERS
organization name
Customer identifier
Category id to be returned
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/categories/214748364' \
-H 'Accept: application/json'Returns all special treatments for the specific tenant
PATH PARAMETERS
organization name
OK List of special treatment values
{
"values": [
"silver",
"gold",
"platinum",
"vip"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
values* | string[] | uniqueItems |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/special-treatment' \
-H 'Accept: application/json'Update the list of valid special treatment values for this tenant
PATH PARAMETERS
organization name
{
"values": [
"silver",
"gold",
"platinum",
"vip"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
values* | string[] | uniqueItems |
No Content Special treatment values updated successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/special-treatment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"values": [
"silver",
"gold",
"platinum",
"vip"
]
}'Returns the special treatment assigned to the customer. Currently, only one value is allowed.
PATH PARAMETERS
organization name
Customer identifier
OK Special treatment assigned to the customer
{
"values": [
"vip"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
values* | string[] | minItems: 0, maxItems: 1 |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment' \
-H 'Accept: application/json'Creates or updates the special treatment assigned to a customer. The special treatment is associated with a single customer. Only one special treatment for customer is handled at the moment
PATH PARAMETERS
organization name
Customer identifier
{
"values": [
"vip"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
values* | string[] | minItems: 0, maxItems: 1 |
No Content Customer special treatment set successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"values": [
"vip"
]
}'Deletes the special treatment assigned to the customer
PATH PARAMETERS
organization name
Customer identifier
No Content Successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment' \
-H 'Accept: application/json'Returns all tokenization requests for an account, ordered by creation date (most recent first)
PATH PARAMETERS
organization name
Account identifier
OK successful operation
{
"items": [
{
"reference_id": "550e8400-e29b-41d4-a716-446655440000",
"account_id": "123e4567-e89b-12d3-a456-556642440000",
"status": "COMPLETED",
"token_id": "8E1C82FDC10E4FE78F10BAF9C4DEB93C",
"error_message": "The credit card tokenization process failed due to invalid card details",
"created_at": "2025-10-28T07:13:27Z",
"updated_at": "2025-10-28T07:13:27Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items* | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/accounts/123e4567-e89b-12d3-a456-556642440000/tokenization-requests' \
-H 'Accept: application/json'Return customer credentials
PATH PARAMETERS
organization name
Customer identifier
OK Customer credentials returned successfully
{
"username": "username@masmovil.com",
"customer_id": "123e4567-e89b-12d3-a456-556642440000",
"credentials": [
{
"id": "0c3c8412-2ac2-4c93-8122-c8afb9141457",
"username": "username@masmovil.com"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
username | string | Username | |||||||||||||||||
customer_id | string (uuid) | Customer id | |||||||||||||||||
credentials* | object[] | ||||||||||||||||||
Array items:
| |||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials' \
-H 'Accept: application/json'Create customer credential
PATH PARAMETERS
organization name
Customer identifier
{
"username": "username@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
username* | string | Username | maxLength: 82 |
Created Credential added successfully
{
"id": "123e4567-e89b-12d3-a456-556642440000"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Credential id |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"username": "username@masmovil.com"
}'Update expiration date of a customer credential
PATH PARAMETERS
organization name
Customer identifier
{
"expiration_date": "2025-12-31"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
expiration_date* | string (date) | null | Expiration date of the credential. Use null to remove the expiration date. |
No Content Credential expiration date updated successfully
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"expiration_date": "2025-12-31"
}'Changes the username of a customer credential. Handles both RESERVED and ACTIVE credentials. For ACTIVE credentials: updates +CRED system and sends notification. For RESERVED credentials: updates database only.
PATH PARAMETERS
organization name
Customer identifier
{
"username": "nuevo@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
username* | string | New username (email format) | maxLength: 150 |
No Content Credential username changed successfully (no content)
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials/change' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"username": "nuevo@masmovil.com"
}'Create customer credential for migrations
PATH PARAMETERS
organization name
Customer identifier
{
"username": "username@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
username* | string | Username | maxLength: 82 |
Created Credential added successfully
{
"id": "123e4567-e89b-12d3-a456-556642440000"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Credential id |
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"error": {
"code": "MCUS.999.994",
"title": "Conflict",
"ref": "http://",
"message": "The resource already exists"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials/migration' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"username": "username@masmovil.com"
}'Delete customer credential given its id
PATH PARAMETERS
organization name
Customer identifier
Credential identifier
No Content successful operation
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials/028076fa-c264-42bb-9983-8872a576be28' \
-H 'Accept: application/json'Activate customer credential
PATH PARAMETERS
organization name
Customer identifier
Accepted Credential activation accepted
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials/activate' \
-H 'Accept: application/json'Returns the document for a customer identification process A customer can have multiple identification processes, each one with a different external id Each identification process has a document associated
PATH PARAMETERS
organization name
Customer identifier
Id of the customer identification process
OK successful operation
{
"process_id": "4189285b-08f8-4628-adda-4767d81362e7",
"process_date": "2023-01-27T03:44:52.000Z",
"document": {
"url_expiration_date": "2023-01-27T03:44:52.000Z",
"public_url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
"media_type": "application/pdf",
"name": "my_id_document.pdf",
"type": "NIF",
"size_bytes": 123456
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
process_id* | string (uuid) | Identification process id | |||||||||||||||||||||||||||||||||||||
process_date* | string (date-time) | Date of the identification process. Format according to ISO 8601 | |||||||||||||||||||||||||||||||||||||
document* | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/identification-processes/4189285b-08f8-4628-adda-4767d81362e7' \
-H 'Accept: application/json'Returns all identification processes for a customer sorted by creation date A customer can have multiple identification processes
PATH PARAMETERS
organization name
Customer identifier
OK successful operation
{
"processes": [
{
"process_id": "4189285b-08f8-4628-adda-4767d81362e7",
"process_date": "2023-01-27T03:44:52.000Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
processes* | object[] | ||||||||||||||||||
Array items:
| |||||||||||||||||||
Bad Request Invalid request body
{
"errors": [
{
"error": {
"code": "MCUS.999.998",
"title": "Bad request",
"ref": "http://",
"message": "Bad request"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"error": {
"code": "MCUS.999.996",
"title": "Unauthorized",
"ref": "http://",
"message": "Unauthorized"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Forbidden Forbidden resource
{
"errors": [
{
"error": {
"code": "MCUS.999.995",
"title": "Forbidden",
"ref": "http://",
"message": "Forbidden"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Resource not found
{
"errors": [
{
"error": {
"code": "MCUS.999.997",
"title": "Resource not found",
"ref": "http://",
"message": "Resource not found"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Method Not Allowed Method not allowed
Internal Server Error Internal server error
{
"errors": [
{
"error": {
"code": "MCUS.999.999",
"title": "Unexpected error",
"ref": "http://",
"message": "Unexpected error"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service unavailable
{
"errors": [
{
"error": {
"code": "MCUS.001.005",
"title": "Database error",
"ref": "http://",
"message": "Connection los"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Repository timeout
{
"errors": [
{
"error": {
"code": "MCUS.001.009",
"title": "Database error",
"ref": "http://",
"message": "Statement timeout"
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | minItems: 1 | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/identification-processes' \
-H 'Accept: application/json'