Imported data
permissions apiKey | Recurso | Descripción |
|---|---|
| Signups | Access to signups new clients |
| Users | Access to user |
| Accounts | Access to accounts |
| Invoices | Access to invoices |
| Terms | Access to terms |
| Payment info | Access to payment info |
| Account migrations | Access to Product migrations |
| Subscriptions | Access to subscriptions |
| Products | Access to products |
| Services | Access to services |
| Bonuses | Access to bonuses (Free Unit Packages) |
| Promotions | Access to promotions |
| Barrings | Proxy to selfCareSocket blocks |
| Workorders | Proxy to MySimWS |
| Penalties | Proxy to penalties |
permissions apiKey | Recurso | Descripción |
|---|---|
| Signups | Access to signups new clients |
| Users | Access to user |
| Accounts | Access to accounts |
| Invoices | Access to invoices |
| Terms | Access to terms |
| Payment info | Access to payment info |
| Account migrations | Access to Product migrations |
| Subscriptions | Access to subscriptions |
| Products | Access to products |
| Services | Access to services |
| Bonuses | Access to bonuses (Free Unit Packages) |
| Promotions | Access to promotions |
| Barrings | Proxy to selfCareSocket blocks |
| Workorders | Proxy to MySimWS |
| Penalties | Proxy to penalties |
ErrorMessage.code type with Hijack runtime payload.ErrorMessage.code from integer to string."0001", "0013").pattern from old_email, new_email, email and registration_email fields. Format validation is enforced in code.catalogue_id mandatory in
- POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
2.37.1
- Deprecate endpoints.
- GET /orgs/{orgId}/subscriptions/{subscriptionId}/services.
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/services/{serviceId}.
- GET /orgs/{orgId}/subscriptions/{subscriptionId}/blocks.
2.37.0
- Removed deprecated PATCH endpoint.
- PATCH /orgs/{orgId}/accounts/{accountId}/paymentinfo (DELETE).
- Removed ChangeAccountPaymentInfoRequest schema.
2.36.8
- Deprecated financial fields that are no longer sent to backend.
- Deprecated Employment schema (profession, professional_area, company, income, income_source, activity_country_code, professional_use).
- Deprecated income_source property within Employment schema.
- Deprecated pre_booking property within financial_details.
- These fields are still accepted in API requests for backward compatibility but are no longer processed or sent to MySim backend.
2.36.7
- Add fields DeviceResponse schema.
- Added delivery_date field to DeviceResponse schema.
2.36.6
- Add fields to DeviceInfo schema.
- Added terminal_code field to DeviceInfo schema.
- Added terminal_category_type field to DeviceInfo schema.
2.36.5
- Add services array field to Ftth schema.
- Added for endpoint POST /orgs/{orgId}/signups.
2.36.4
- Changed description and example of SpecialTreatment Object
- Changed for endpoint GET /orgs/{orgId}/users/{userId}
2.36.3
- Removed unused specialTreatments Object
- Removed for endpoint GET /orgs/{orgId}/signups/master-data
- 2.36.2 Removed unused deprecated endpoints.
- GET /orgs/{orgId}/subscriptions/{subscriptionId}/balance
- GET /orgs/{orgId}/subscriptions/{subscriptionId}/consumption/detail
2.36.1
- Permission unification.
2.36.0
- Changes typo of reservation_id to String.
- Changed for endpoint POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
- Changed for endpoint GET /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
- Changed for endpoint POST /orgs/{orgId}/signups.
- Changed for endpoint POST /orgs/{orgId}/signups/subscriptions.
- Changed for endpoint POST /orgs/{orgId}/signups/migration.
2.35.3
- Fix HTML content in endpoints description.
2.35.2
- Deprecate endpoints and delete older endpoints.
- GET /orgs/{orgId}/accounts/{accountId}/paymentinfo (DEPRECATE).
- PATCH /orgs/{orgId}/accounts/{accountId}/paymentinfo (DEPRECATE).
- POST /orgs/{orgId}/signups/register-sell-payment (DELETE).
- GET /orgs/{orgId}/users/tree/full (DELETE)
2.35.1
- Changes to response in GET /orgs/{orgId}/accounts/{accountId}/invoices.
- Added
value_total field to InvoiceInfoDetail schema like it was previously.
2.35.0
- Changes to response in GET /orgs/{orgId}/accounts/{accountId}/invoices.
- Added
cycle field to InvoiceInfoDetail schema.
2.34.0
- Changes to response in GET /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
- Add field devices[].fees.installment_plan.financed_by
- Add field devices[].fees.final_installment_plan.financed_by
- Marked field devices[].device_info.financed_by as deprecated.
2.33.4
- Add
commitment_uuid field to Penalty schema.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}/subscription/{subscriptionId}.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}/subscription/uuid/{subscriptionUUID}.
- Added for endpoint POST /orgs/{orgId}/penalties/{computePenaltyId}.
2.33.3
- Add
subscription_terminal_id field to Penalty schema.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}/subscription/{subscriptionId}.
- Added for endpoint POST /orgs/{orgId}/penalties/{accountId}/subscription/uuid/{subscriptionUUID}.
- Added for endpoint POST /orgs/{orgId}/penalties/{computePenaltyId}.
2.33.2
- Add endpoint for get penalties by subscriptionUUID.
- Added endpoint GET /orgs/{orgId}/penalties/{accountId}/subscriptions/{subscriptionUUID}.
2.32.0
- Add new value to the
PaymentMethod ENUM.
- Added
RECURRING_CREDIT_CARD value to the payment_method ENUM in GET /orgs/{orgId}/accounts/{accountId}/paymentinfo.
2.31.0
- Add
catalogue_id and logistic_required fields to Device schema.
- Added for endpoint POST /orgs/{orgId}/signups.
- Added for endpoint POST /orgs/{orgId}/signups/migration.
- Added for endpoint POST /orgs/{orgId}/signups/subscriptions.
- Added for endpoint POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
2.30.0
- Add
category field to Device schema.
- Added for endpoint POST /orgs/{orgId}/signups.
- Added for endpoint POST /orgs/{orgId}/signups/migration.
- Added for endpoint POST /orgs/{orgId}/signups/subscriptions.
- Added for endpoint POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
2.29.0
- Added new field in GET /orgs/{orgId}/signups:
- Added
work_order_id field.
2.28.9
- Added new field in GET /orgs/{orgId}/accounts/{accountId}/contracts:
- Added
contract_id field.
2.28.8
- Added new fields in POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Added
old_subscription_terminal_id to main object.
- Added
discount_final_payment_value field to InstallmentPlan.
- Added
is_promotional_renew field to InstallmentPlan.
2.28.7
- Added new fields inside Permanence Object in GET /orgs/{orgId}/subscriptions/{subscriptionId}/device:
- Added
current_duration_days field to Permanence.
- Added
penalty_amount field to Permanence.
- Added
current_penalty_amount field to Permanence.
2.28.6
- Added new field in GET /orgs/{orgId}/accounts/{accountId}/tax:
- Added
start_date field to TaxAccountInfo.
2.28.5
- Added new field in POST /orgs/{orgId}/signups:
- Added
ftth.access_reuse_choice field.
2.28.4
- Fixing sdk generation issue.
2.28.3
- Added new field in POST /orgs/{orgId}/signups:
- Added
ftth.access_reuse field.
2.28.2
- Fixed field example in POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Fixed
province_id example. Now is string as it should be.
2.28.1
- Added new fields to POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Added
dealer_id field
- Added
shop_id field
2.28.0
- Several additions.
- Added
pay_date field to GET /orgs/{orgId}/accounts/{accountId}/invoices
- Added
ECI enum value to payment_method field in GET /orgs/{orgId}/accounts/{accountId}/paymentinfo
2.27.0
- Added new field in GET /orgs/{orgId}/accounts/{accountId}/invoices:
- Added
status field to request.
2.26.0
- Changed response from GET /orgs/{orgId}/accounts/{accountId}/paymentinfo:
- Added
payment_method from request.
2.25.4
- Deprecated fields in POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- address_id, description, block, bis, stair, letter, hand1, hand2, technical_id deprecated.
2.25.3
- Added new enum values to Status schema:
- Added 82 to id, and PENDIENTE A DESACTIVAR to value.
2.25.2
- Added info to POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Added maxLength, description and example to
province_id.
2.25.1
- Removed field from POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Removed
province from request.
2.25.0
- Added new field POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Added
signature_type optional field to request.
2.24.0
- Added new fields POST /orgs/{orgId}/signups:
- Added
app_id optional field to request.
- Added
channel_id optional field to request.
- Added
signature_type optional field to request.
- Added
PAYMENTS to platform enum in signups and devices endpoints.
2.23.0
- Added new field and query param to GET /orgs/{orgId}/accounts/{accountId}/tax:
- Added
historical_changes field to response
- Added
include_historical_changes query param.
2.22.0
- Added new field to GET /orgs/{orgId}/accounts/{accountId}:
- Added
customer_id field to response
2.21.0
- Change response to GET /orgs/{orgId}/subscriptions/{subscriptionId}/devices:
- Added final_installment_plan to Fees
- Removed contract_detail to DeviceResponse
2.20.0
- Added new fields to POST /orgs/{orgId}/signups:
- Added credit_limit to SignupsScoring
- Added credit_limit_available to SignupsScoring
2.19.1
- Fix devices fields for business logic
- Fields
granted_amount and credit_line_amount are now Long.
- Fields
fees and reservation_id are now mandatory
2.19.0
- Added new functionality to mobile only signups
- Added new functionality to add devices in mobile onlye signups
2.19.0
- Adds new field subscription_terminal_id
- Adds field subscription_terminal_id to response of POST /orgs/{orgId}/signups in each subscription (account_info.subscriptions).
- Adds field subscription_terminal_id to response of POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
2.18.1
- Fix field
order_id type in POST /orgs/:orgId/subscriptions/:subscriptionId/devices
- Fixed field
order_id type from long to string
2.18.0
- Added new fields to POST /orgs/:orgId/subscriptions/:subscriptionId/devices
- Added
platform, payment_link, tax fields
2.17.0
- Adds Apple Watch subscription
- Adds the Apple Watch subscription type (13) to all endpoints.
2.16.0
- Refactor specification to use components and obfuscate examples
- Refactor specification to use components and obfuscate examples
2.15.1
- Removed required from
registration_email field in POST /orgs/{orgId}/signups/migration
- Removed required from
registration_email field in POST /orgs/{orgId}/signups/migration
2.15.0
- Add new values to GET /orgs/{orgId}/signups/master-data
- Added
occupations and occupation_sectors to GET /orgs/{orgId}/signups/master-data
2.14.0
- Removed unused deprecated endpoints.
- /orgs/{orgId}/users/{userId}/accounts:
- /orgs/{orgId}/subscriptions/{subscriptionId}/consumption-limit:
2.13.0
- Add ott subscription type to POST /orgs/{orgId}/signups/migration
2.12.2
- Add signature_process_id:
- POST /orgs/:orgId/signups
- POST /orgs/:orgId/signups/migration
- POST /orgs/:orgId/signups/subscriptions
- POST /orgs/:orgId/subscriptions/:subscriptionId/devices
2.12.1
- Add donor_use to endpoint:
- POST /orgs/{orgId}/signups/migration:
2.11.0
- Removed unused deprecated endpoints.
- GET/PUT /orgs/{orgId}/users/{expeditionUserId}/expeditions
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/accounts
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/accounts/{accountNumber}
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/migrate-to-prepaid
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/migrate-to-prepaid/{accountNumber}
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/migrate-to-postpaid
- PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/migrate-to-postpaid/{accountNumber}
- DELETE /orgs/{orgId}/subscriptions/{subscriptionId}/in-flight
- PUT /orgs/{orgId}/subscriptions/{subscriptionId}/consumption-limit
- DELETE /orgs/{orgId}/subscriptions/{subscriptionId}/consumption-limit
- PUT /orgs/{orgId}/subscriptions/{subscriptionId}/promotions
- DELETE /orgs/{orgI d}/subscriptions/{subscriptionId}/promotions/{promotionId}
- PATCH /barrings
- POST /notifications/external
2.10.0
- Add get Account contracts endpoint.
- Added endpoint GET /orgs/{orgId}/accounts/{accountId}/contracts.
2.9.1
- Add insured_amount field to Device schema.
- Added for endpoint POST /orgs/{orgId}/signups.
- Added for endpoint POST /orgs/{orgId}/signups/migration.
- Added for endpoint POST /orgs/{orgId}/signups/subscriptions.
- Added for endpoint POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
2.9.0
- Add scoring field to POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices
- Add scoring_id field to POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices endpoint.
- Changed credit_line_amount field from integer to double
2.8.2
- Remove Broadband component
- Removed unused Broadband component.
2.8.1
- Adds Device Insurance subscription
- Adds the Device Insurance subscription type (11) to all endpoints.
2.8.0
- Change PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/sim-replacement to return risk decision
- Change response
- /orgs/{orgId}/subscriptions/{subscriptionId}/sim-replacement to return risk decision: Now the service return 206 when the field risk decision has the value "r", "x" or "n/a".
2.7.0
- Change PATCH /subscriptions/{subscriptionId}/products to return risk decision
- Change response
- /subscriptions/{subscriptionId}/products to return risk decision: Now the service return 202 when the field risk decision has the value "r", "x" or "n/a".
2.6.3
- Add field to com.masmovil.mascustomers.client.model.UserBusinessResponsable nationality_value.
2.6.2
- Change HTTP status code
- Change from 206 to 202, when the field risk decision has the value "r", "x" or "n/a" on the next endpoints:
- POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices.
- POST /orgs/{orgId}/signups to return risk decision.
- POST /orgs/{orgId}/signups/migration to return risk decision.
- POST /orgs/{orgId}/signups/subscriptions to return risk decision.
2.6.1
- Adds Netflix subscription
- Adds the Netflix subscription type (12) to all endpoints.
2.6.0
- Change POST /orgs/{orgId}/subscriptions/{subscriptionId}/devices to return risk decision
- Change response
- /orgs/{orgId}/subscriptions/{subscriptionId}/devices to return risk decision: Now the service return 206 when the field risk decision has the value "r", "x" or "n/a".
2.5.0
- Change POST /signups/migration to return risk decision
- Change response
- /signups/migration to return risk decision: Now the service return 206 when the field risk decision has the value "r", "x" or "n/a".
2.4.0
- Change POST /signups/subscriptions to return risk decision
- Change response
- /signups/subscriptions to return risk decision: Now the service return 206 when the field risk decision has the value "r", "x" or "n/a".
2.3.8
- Creation this change logs and delete Customers Tag and delete endpoint getDeviceByCustomerId
- Creation this release notes
- Delete Tag Customers
- Delete endpoint
/orgs/{orgId}/customers/{customerId}/devices
Add new customers including products purchased
PATH PARAMETERS
organization name
{
"sales_type": "telecomunications",
"sales_info": {
"channel": "dealer",
"dealer_id": "string",
"shop_id": "string",
"agent_id": "string",
"logistic": true,
"signature_process_id": 0,
"signature_type": "PAPER",
"channel_id": 0
},
"clients": {
"sector_id": 1,
"attributes": [
{}
]
},
"payment": {
"billing_type_id": 1,
"scoring": {
"scoring_value": 0,
"id_value": 0,
"forced_value": 0,
"up_front": 0,
"credit_limit": 0,
"credit_limit_available": 0,
"app_id": 0
},
"info": {
"bank_account": "string",
"swift_bic": "string"
},
"tpv_response": {
"amount": "string",
"card_number": "000000******0000",
"expiry_date": "0121",
"transaction_id": "1563B44RPR2",
"reference_id": "string",
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
},
"account_number": "string"
},
"products": {
"mobile_line": {
"existing_number": false,
"type": "mobile",
"product_id": 214748364,
"portability_info": {
"scheduled_date": "2020-04-20",
"iccid": "string",
"operator_id": "string",
"operation_type": 1,
"initial_date_operation": "1999-01-31",
"donor_line_type": "C",
"donor_user": {},
"internal_portability": true,
"installation_required": true
},
"msisdn": "string",
"iccid": "string",
"fabrication_type_sim_id": 214748364,
"initial_balance": 0,
"bonuses": [
{
"id": 0
}
],
"promotions": [
{
"id": 0,
"value": "string"
}
],
"terminals": [
{
"id": 0,
"financed": true,
"imei": "string",
"serial_number": "string"
}
],
"wants_communications": true,
"expedition_info": {
"address": {
"value": null
}
},
"delivery_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"observation": null
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"devices": [
{
"device_details": {
"id": null,
"model_id": null,
"cession_price": null,
"imei": null,
"pending_imei": null,
"insured_amount": null,
"category": null,
"logistic_required": null,
"catalogue_id": null,
"amount": null
},
"fees": {
"upfront_fee": null,
"installment_plan": null
},
"financial_details": {
"pre_booking": null,
"consents": null
},
"campaign_id": 0,
"terms": {
"penalty_value": null,
"commitment_duration": null
},
"reservation_id": "string",
"signature_process_id": 0,
"signature_type": "PAPER",
"old_subscription_terminal_id": 0
}
]
},
"bundle": {
"bundle_id": 0,
"territory_owner": "string",
"promotions": [
{
"id": 0,
"value": "string"
}
],
"installation_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"gescal": null,
"pair_vacancy": null,
"address_id": null
}
},
"delivery_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"observation": null
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"landline": {
"product_id": 0,
"portability_info": {
"scheduled_date": "2020-04-20",
"iccid": "string",
"operator_id": "string",
"operation_type": 1,
"initial_date_operation": "1999-01-31",
"donor_line_type": "C",
"donor_user": {},
"internal_portability": true,
"installation_required": true
},
"number": "string",
"bonuses": [
{
"id": null
}
],
"promotions": [
{
"id": null,
"value": null
}
],
"services": [
{
"id": null
}
],
"wants_communications": true
},
"ftth": {
"product_id": 0,
"promotions": [
{
"id": null,
"value": null
}
],
"connection_type": "string",
"installer": "string",
"iua": "string",
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
],
"wants_communications": true,
"access_reuse": "Interno",
"access_reuse_choice": true,
"services": [
{
"id": null
}
]
},
"adsl": {
"product_id": 0,
"promotions": [
{
"id": null,
"value": null
}
],
"wants_communications": true,
"install_tech_support": true,
"tech_support_billiable": true
},
"mobile_lines": [
{
"existing_number": false,
"type": "mobile",
"product_id": 214748364,
"portability_info": {
"scheduled_date": null,
"iccid": null,
"operator_id": null,
"operation_type": null,
"initial_date_operation": null,
"donor_line_type": null,
"donor_user": null,
"internal_portability": null,
"installation_required": null
},
"msisdn": "string",
"iccid": "string",
"fabrication_type_sim_id": 214748364,
"initial_balance": 0,
"bonuses": [
null
],
"promotions": [
null
],
"terminals": [
null
],
"wants_communications": true,
"expedition_info": null,
"delivery_info": {
"contact": null,
"address": null,
"delivery_shop_id": null,
"delivery_type": null
},
"devices": [
null
]
}
],
"tv": {
"product_id": 0,
"number_associated": "string",
"registration_email": "string",
"contact_phone": "string",
"install_tech_support": true,
"promotions": [
{
"id": null,
"value": null
}
],
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
]
},
"ott": [
{
"product_id": 0,
"email": "string",
"promotions": [
null
]
}
]
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sales_type* | string
()
telecomunications | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sales_info* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clients* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK signup ok
{
"sell_id": 0,
"customer_id": 0,
"work_order_id": "FOO_XYZ",
"account_info": {
"account_id": 0,
"account_number": "string",
"bundle_id": 0,
"subscriptions": [
{
"type": 0,
"subscription_id": 0,
"user_info_id": 0,
"msisdn": "string",
"fixed_number": "string",
"associated_number": "string",
"subscription_terminal_id": 0
}
]
},
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sell_id | number (int64) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id | number (int64) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
work_order_id | string | identification work order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_info | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
risk_decision | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Accepted Check the risk decision
{
"sell_id": 0,
"customer_id": 0,
"work_order_id": "FOO_XYZ",
"account_info": {
"account_id": 0,
"account_number": "string",
"bundle_id": 0,
"subscriptions": [
{
"type": 0,
"subscription_id": 0,
"user_info_id": 0,
"msisdn": "string",
"fixed_number": "string",
"associated_number": "string",
"subscription_terminal_id": 0
}
]
},
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sell_id | number (int64) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id | number (int64) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
work_order_id | string | identification work order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_info | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
risk_decision | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/signups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"sales_type": "telecomunications",
"sales_info": {
"channel": "dealer",
"dealer_id": "string",
"shop_id": "string",
"agent_id": "string",
"logistic": true,
"signature_process_id": 0,
"signature_type": "PAPER",
"channel_id": 0
},
"clients": {
"sector_id": 1,
"attributes": [
{}
]
},
"payment": {
"billing_type_id": 1,
"scoring": {
"scoring_value": 0,
"id_value": 0,
"forced_value": 0,
"up_front": 0,
"credit_limit": 0,
"credit_limit_available": 0,
"app_id": 0
},
"info": {
"bank_account": "string",
"swift_bic": "string"
},
"tpv_response": {
"amount": "string",
"card_number": "000000******0000",
"expiry_date": "0121",
"transaction_id": "1563B44RPR2",
"reference_id": "string",
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
},
"account_number": "string"
},
"products": {
"mobile_line": {
"existing_number": false,
"type": "mobile",
"product_id": 214748364,
"portability_info": {
"scheduled_date": "2020-04-20",
"iccid": "string",
"operator_id": "string",
"operation_type": 1,
"initial_date_operation": "1999-01-31",
"donor_line_type": "C",
"donor_user": {},
"internal_portability": true,
"installation_required": true
},
"msisdn": "string",
"iccid": "string",
"fabrication_type_sim_id": 214748364,
"initial_balance": 0,
"bonuses": [
{
"id": 0
}
],
"promotions": [
{
"id": 0,
"value": "string"
}
],
"terminals": [
{
"id": 0,
"financed": true,
"imei": "string",
"serial_number": "string"
}
],
"wants_communications": true,
"expedition_info": {
"address": {
"value": null
}
},
"delivery_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"observation": null
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"devices": [
{
"device_details": {
"id": null,
"model_id": null,
"cession_price": null,
"imei": null,
"pending_imei": null,
"insured_amount": null,
"category": null,
"logistic_required": null,
"catalogue_id": null,
"amount": null
},
"fees": {
"upfront_fee": null,
"installment_plan": null
},
"financial_details": {
"pre_booking": null,
"consents": null
},
"campaign_id": 0,
"terms": {
"penalty_value": null,
"commitment_duration": null
},
"reservation_id": "string",
"signature_process_id": 0,
"signature_type": "PAPER",
"old_subscription_terminal_id": 0
}
]
},
"bundle": {
"bundle_id": 0,
"territory_owner": "string",
"promotions": [
{
"id": 0,
"value": "string"
}
],
"installation_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"gescal": null,
"pair_vacancy": null,
"address_id": null
}
},
"delivery_info": {
"contact": {
"name": "string",
"middlename": "string",
"lastname": "string",
"phone": "string",
"email": "string",
"document_type_id": 0,
"document_value": "string"
},
"address": {
"street_type_id": null,
"street_name": null,
"number": null,
"supplement": null,
"state_id": null,
"locality": null,
"postal_code": null,
"observation": null
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"landline": {
"product_id": 0,
"portability_info": {
"scheduled_date": "2020-04-20",
"iccid": "string",
"operator_id": "string",
"operation_type": 1,
"initial_date_operation": "1999-01-31",
"donor_line_type": "C",
"donor_user": {},
"internal_portability": true,
"installation_required": true
},
"number": "string",
"bonuses": [
{
"id": null
}
],
"promotions": [
{
"id": null,
"value": null
}
],
"services": [
{
"id": null
}
],
"wants_communications": true
},
"ftth": {
"product_id": 0,
"promotions": [
{
"id": null,
"value": null
}
],
"connection_type": "string",
"installer": "string",
"iua": "string",
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
],
"wants_communications": true,
"access_reuse": "Interno",
"access_reuse_choice": true,
"services": [
{
"id": null
}
]
},
"adsl": {
"product_id": 0,
"promotions": [
{
"id": null,
"value": null
}
],
"wants_communications": true,
"install_tech_support": true,
"tech_support_billiable": true
},
"mobile_lines": [
{
"existing_number": false,
"type": "mobile",
"product_id": 214748364,
"portability_info": {
"scheduled_date": null,
"iccid": null,
"operator_id": null,
"operation_type": null,
"initial_date_operation": null,
"donor_line_type": null,
"donor_user": null,
"internal_portability": null,
"installation_required": null
},
"msisdn": "string",
"iccid": "string",
"fabrication_type_sim_id": 214748364,
"initial_balance": 0,
"bonuses": [
null
],
"promotions": [
null
],
"terminals": [
null
],
"wants_communications": true,
"expedition_info": null,
"delivery_info": {
"contact": null,
"address": null,
"delivery_shop_id": null,
"delivery_type": null
},
"devices": [
null
]
}
],
"tv": {
"product_id": 0,
"number_associated": "string",
"registration_email": "string",
"contact_phone": "string",
"install_tech_support": true,
"promotions": [
{
"id": null,
"value": null
}
],
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
]
},
"ott": [
{
"product_id": 0,
"email": "string",
"promotions": [
null
]
}
]
}
}
}'Returns a list of normalized master-data info related to a given a dealerId
PATH PARAMETERS
organization name
QUERY PARAMETERS
(optional) dealer identifier
OK successful operation
{
"states": [
{
"id": 0,
"value": "Lugo",
"iso": "ES-LU"
}
],
"document_types": [
{
"id": 0,
"value": "nif",
"description": ""
}
],
"nationalities": [
{
"id": 0,
"value": "España",
"iso": "ES"
}
],
"languages": [
{
"id": 0,
"value": "Castellano",
"iso": "es"
}
],
"balances": [
0
],
"mobile_operators": [
{
"code": "string",
"name": "string"
}
],
"cli_operators": [
{
"code": "string",
"name": "string"
}
],
"sectors": [
{
"id": 0,
"value": "RESIDENCIAL"
}
],
"billing_types": [
{
"id": 1,
"value": "POSPAGO"
}
],
"fabrication_types": [
{
"id": 0,
"value": "string"
}
],
"deactivation_motives": {
"termination_motives": [
{
"id": 214748364,
"value": "LOGISTICA"
}
],
"cancellation_motives": [
{
"id": 214748364,
"value": "CONTRAOFERTA"
}
]
},
"movement_types": [
{
"id": 214748364,
"value": "PENALIZACION CANCELACION",
"description": "FIBRA CUOTA PENALIZACIÓN"
}
],
"recharge_origins": [
{
"id": 214748364,
"value": "TPV"
}
],
"occupations": [
{
"id": 0,
"value": "Empresario"
}
],
"occupation_sectors": [
{
"id": 0,
"value": "Armas y energía nuclear"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
states | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document_types | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nationalities | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
languages | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
balances | number (double)[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mobile_operators | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cli_operators | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sectors | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_types | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fabrication_types | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deactivation_motives | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
movement_types | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recharge_origins | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
occupations | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
occupation_sectors | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/signups/master-data' \
-H 'Accept: application/json'Get available msisdns for YOIGO network (only mobile numbers)
PATH PARAMETERS
organization name
network id (YOIGO)
OK successful operation
{
"host_cfg_id": 0,
"available_msisdns": [
"string"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
host_cfg_id | number (int32) | this endpoint only support YOIGO network | ||
available_msisdns | string[] |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/signups/available-msisdns/:host_cfg' \
-H 'Accept: application/json'Returns simcard info from provided icc
PATH PARAMETERS
organization name
icc
OK successful operation
{
"simcard_status_id": 0,
"origin_id": 0,
"create_date": "string",
"last_status_date": "string",
"promotion_code": "NTH_256",
"society_id": "string",
"initial_balance": 0
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
simcard_status_id | number (int32) | Simcard status id | ||
origin_id | number (int32) | Origin id | ||
create_date | string (date) | Date of creation | ||
last_status_date | string (date) | Last status date | ||
promotion_code | string | Promotion code | ||
society_id | string | Last status date | ||
initial_balance | number (double) | Initial balance |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/signups/simcard-info/:iccid' \
-H 'Accept: application/json'Allows to activate simcard
PATH PARAMETERS
organization name
{
"msisdn": "string",
"activation_type": 0
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
msisdn* | string | Phone number | pattern: ^[6789]\d{8}$ | |
activation_type | number (int32) |
OK activate successful
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/signups/activate-sim' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"msisdn": "string",
"activation_type": 0
}'Add a new mobile line or tv subscription to an existing convergent account.
PATH PARAMETERS
organization name
{
"client": {
"attributes": {
"document_expiration_date": "1999-01-31",
"employment": {
"activity_country_code": "string",
"company": "string",
"income": 0,
"income_source": {
"id": 0,
"observations": "string"
},
"profession": 0,
"professional_area": 0,
"professional_use": true
}
}
},
"sales_info": {
"channel": "dealer",
"dealer_id": "string",
"shop_id": "string",
"agent_id": "string",
"logistic": true,
"signature_process_id": 0,
"signature_type": "PAPER",
"channel_id": 0
},
"account": {
"account_id": 0,
"subscriptions": {
"mobile_lines": [
{
"type": "additional",
"product_id": 0,
"msisdn": 12345,
"iccid": "8934042419120320845",
"fabrication_type_sim_id": 214748364,
"portability_info": {
"iccid": null,
"operator_id": null,
"operation_type": null,
"initial_date_operation": null,
"donor_line_type": null,
"internal_portability": null,
"installation_required": null,
"donor_user": null
},
"bonuses": [
null
],
"promotions": [
null
],
"terminals": [
null
],
"devices": [
null
],
"expedition_info": null
}
],
"tv": {
"product_id": 0,
"number_associated": 12345,
"registration_email": "string",
"contact_phone": 12345,
"promotions": [
{
"id": null,
"value": null
}
],
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
]
}
}
},
"tpv_response": {
"amount": "string",
"card_number": "000000******0000",
"expiry_date": "0121",
"transaction_id": "1563B44RPR2",
"reference_id": "string",
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
client | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sales_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tpv_response | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Add line to bundle ok
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Accepted Check the risk decision
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/signups/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"client": {
"attributes": {
"document_expiration_date": "1999-01-31",
"employment": {
"activity_country_code": "string",
"company": "string",
"income": 0,
"income_source": {
"id": 0,
"observations": "string"
},
"profession": 0,
"professional_area": 0,
"professional_use": true
}
}
},
"sales_info": {
"channel": "dealer",
"dealer_id": "string",
"shop_id": "string",
"agent_id": "string",
"logistic": true,
"signature_process_id": 0,
"signature_type": "PAPER",
"channel_id": 0
},
"account": {
"account_id": 0,
"subscriptions": {
"mobile_lines": [
{
"type": "additional",
"product_id": 0,
"msisdn": 12345,
"iccid": "8934042419120320845",
"fabrication_type_sim_id": 214748364,
"portability_info": {
"iccid": null,
"operator_id": null,
"operation_type": null,
"initial_date_operation": null,
"donor_line_type": null,
"internal_portability": null,
"installation_required": null,
"donor_user": null
},
"bonuses": [
null
],
"promotions": [
null
],
"terminals": [
null
],
"devices": [
null
],
"expedition_info": null
}
],
"tv": {
"product_id": 0,
"number_associated": 12345,
"registration_email": "string",
"contact_phone": 12345,
"promotions": [
{
"id": null,
"value": null
}
],
"terminals": [
{
"id": null,
"financed": null,
"imei": null,
"serial_number": null
}
]
}
}
},
"tpv_response": {
"amount": "string",
"card_number": "000000******0000",
"expiry_date": "0121",
"transaction_id": "1563B44RPR2",
"reference_id": "string",
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
}
}'Returns customer tree data associated to a given document identification, email or number of the client.
PATH PARAMETERS
organization name
QUERY PARAMETERS
user email
user phone number (MSISDN)
Deprecated use documentType and document (user nif)
Document type id
Document with numbers and letters
OK successful operation
{
"id": 214748364,
"customer_id": 214748364,
"customer_uuid": "123e4567-e89b-12d3-a456-556642440000",
"accounts": [
{
"id": 214748364,
"owner_id": 214748364,
"subscriptions": [
{
"id": 214748364,
"subscription_type": {
"id": null,
"value": null
},
"status": {
"id": null,
"value": null
},
"user_id": 214748364,
"identification_nr": 12345,
"expedition_user_id": 214748364,
"bundle_id": 214748364,
"mobile_line_type": "mobile"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | User id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id* | integer (int64) | Customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_uuid | string (uuid) | Customer UUID from customers API V4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accounts | object[] | Accounts associated to user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Forbidden Forbidden resource
{
"code": 10,
"status": "FORBIDDEN",
"message": "Forbidden",
"DetailMsg": "The state does not allow login"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/users/tree?email=john.doe%40example.com&number=12345&nif=12345678A&documentType=NIF&document=12345678A' \
-H 'Accept: application/json'Returns customer tree data
PATH PARAMETERS
organization name
User search parameters
{}| Property | Type | Description | Constraints | Default |
|---|
OK successful operation
{
"id": 214748364,
"customer_id": 214748364,
"customer_uuid": "123e4567-e89b-12d3-a456-556642440000",
"accounts": [
{
"id": 214748364,
"owner_id": 214748364,
"subscriptions": [
{
"id": 214748364,
"subscription_type": {
"id": null,
"value": null
},
"status": {
"id": null,
"value": null
},
"user_id": 214748364,
"identification_nr": 12345,
"expedition_user_id": 214748364,
"bundle_id": 214748364,
"mobile_line_type": "mobile"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | User id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id* | integer (int64) | Customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_uuid | string (uuid) | Customer UUID from customers API V4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accounts | object[] | Accounts associated to user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Forbidden Forbidden resource
{
"code": 10,
"status": "FORBIDDEN",
"message": "Forbidden",
"DetailMsg": "The state does not allow login"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/users/tree' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{}'Returns full customer tree data
PATH PARAMETERS
organization name
Contains product data
{
"document_type": "NIF",
"document": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
document_type* | string
()
NIFDNITRPASSCIF | document type value | ||
document* | string |
OK successful operation
{
"id": 214748364,
"customer_id": 214748364,
"customer_uuid": "123e4567-e89b-12d3-a456-556642440000",
"accounts": [
{
"id": 214748364,
"owner_id": 214748364,
"subscriptions": [
{
"id": 214748364,
"subscription_type": {
"id": null,
"value": null
},
"status": {
"id": null,
"value": null
},
"user_id": 214748364,
"identification_nr": 12345,
"expedition_user_id": 214748364,
"bundle_id": 214748364,
"mobile_line_type": "mobile"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | User id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id* | integer (int64) | Customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_uuid | string (uuid) | Customer UUID from customers API V4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accounts | object[] | Accounts associated to user | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Forbidden Forbidden resource
{
"code": 10,
"status": "FORBIDDEN",
"message": "Forbidden",
"DetailMsg": "The state does not allow login"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/users/tree/full' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"document_type": "NIF",
"document": "string"
}'Returns user data by userId
PATH PARAMETERS
organization name
user identifier
OK successful operation
{
"id": 214748364,
"customer_id": 214748364,
"language": {
"value": "Castellano"
},
"document_type": {
"id": 1,
"value": "NUMERO IDENTIFICACION FISCAL"
},
"document_value": "11111111A",
"sector": {
"id": 1,
"value": "RESIDENCIAL"
},
"type": {
"id": 1,
"value": "PARTICULAR"
},
"nationality": {
"value": "ESPAÑA"
},
"personal": {
"first_name": "John",
"middle_name": "Nicholas",
"last_name": "Doe",
"gender": "M",
"birthdate": "string",
"other_phone": 12345,
"email": "john.doe@example.com"
},
"business": {
"company": "SPACEX",
"created_date": "string",
"other_phone": 12345,
"email": "john.doe@example.com",
"responsable": {
"id": 214748364,
"name": "John",
"middlename": "Nicholas",
"lastname": "Doe",
"document_type_id": 1,
"document_value": "11111111A",
"nationality_id": 214748364,
"nationality_iso": "ES",
"nationality_value": "España"
}
},
"address_info": {
"address": "CALLE EMILIO FERRARI",
"state": "MADRID",
"zip_code": "28017",
"locality": "MADRID"
},
"special_treatment": {
"id": 42,
"value": "Influencer"
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id | integer (int64) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
language | object | object | Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document_type* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document_value* | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sector | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nationality | object | object | Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
personal | object | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
business | object | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_info | object | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
special_treatment | object | possible values can be retrieved in mas-customers v4 api <u>/orgs/{org_id}/special-treatment</u> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/users/214748364' \
-H 'Accept: application/json'Patch users agile tv subscription
PATH PARAMETERS
organization name
{
"old_email": "old_email@example.com",
"new_email": "new_email@example.com",
"document_number": "11111111A"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
old_email* | string | Customer email. Validated in code: max 82 chars, RFC-compatible format, case-insensitive. | ||
new_email* | string | Customer email. Validated in code: max 82 chars, RFC-compatible format, case-insensitive. | ||
document_number* | string |
OK successful operation
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/users/agile-tv' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"old_email": "old_email@example.com",
"new_email": "new_email@example.com",
"document_number": "11111111A"
}'Returns all the info about a single account given by accountId.
PATH PARAMETERS
organization name
account identifier
OK successful operation
{
"id": 214748364,
"customer_id": 214748364,
"account_number": "MM-5338507",
"work_order_id": "FOO_XYZ",
"work_orders": [
{
"work_order_id": "FOO_XYZ",
"work_order_type": {
"id": 1,
"value": "ALTA"
},
"status": {
"id": 32,
"value": "PENDIENTE CREAR OT"
},
"created_date": "2019-12-09T09:58:34Z"
}
],
"activation_date": "2019-12-09T09:58:34Z",
"billing_type": {
"id": 1,
"value": "POSPAGO"
},
"status": {
"id": 3,
"value": "ACTIVO"
},
"path": "string",
"filename": "string"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | integer (int64) | id de la cuenta | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id | integer (int64) | id del cliente | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_number | string | numero de contrato | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
work_order_id | string | work order identifier. DEPRECATED, this info is in work_orders list | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
work_orders | object[] | list of ot associated to a package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activation_date | string (date-time) | account activation date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_type | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
path | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filename | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364' \
-H 'Accept: application/json'Return tax value by accountId
PATH PARAMETERS
organization name
account identifier
QUERY PARAMETERS
true when you want to include historical changes
start date that you want query historical changes with format yyyy-mm-ddThh:MM:ssZ
end date that you want query historical changes with format yyyy-mm-ddThh:MM:ssZ
OK array of compatible bundles
{
"id": 0,
"tax_value": 21,
"tax_terminal_value": 21,
"state_id": 28,
"description": "IVA",
"start_date": "1970-01-01T00:00:00Z",
"historical_changes": [
{
"tax_value": 21,
"tax_terminal_value": 21,
"state_id": 28,
"description": "IVA",
"start_date": "1970-01-01T00:00:00Z",
"end_date": "1970-01-01T00:00:00Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | account id | |||||||||||||||||||||||||||||||||||||
tax_value* | integer (int32) | value tax | |||||||||||||||||||||||||||||||||||||
tax_terminal_value | integer (int32) | value terminal tax | |||||||||||||||||||||||||||||||||||||
state_id* | integer (int32) | ID of the state | |||||||||||||||||||||||||||||||||||||
description | string | description of the type tax (IVA, IGIC, etc..) | |||||||||||||||||||||||||||||||||||||
start_date | string (date-time) | Date when the customer moved into the current state | |||||||||||||||||||||||||||||||||||||
historical_changes | object[] | ||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/tax?include_historical_changes=true&historical_changes_start_date=1970-01-01T00%3A00%3A00Z&historical_changes_end_date=1970-01-01T00%3A00%3A00Z' \
-H 'Accept: application/json'Get account contracts
PATH PARAMETERS
organization name
account identifier
QUERY PARAMETERS
Signature config
OK Successful operation
{
"contracts": [
{
"account_bundle_id": 214748364,
"account_id": 0,
"pdf_file_name": "string",
"document_id": "string",
"digital_signature_origin_id": "string",
"ineid": "string",
"iccid": "string",
"ccggid": "string",
"subscription_id": 214748364,
"subscription_terminal_id": 214748364,
"process_id": "string",
"status": "string",
"signed_document_id": "string",
"contract_id": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
contracts | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/contracts?signature_config=CONVERGENTE' \
-H 'Accept: application/json'Returns invoices info related to a given accountId
PATH PARAMETERS
organization name
account identifier
QUERY PARAMETERS
start date query with format yyyy-mm-dd
end date query with format yyyy-mm-dd
OK successful operation
{
"account_id": 0,
"period_date": {
"start_date": "2020-05-01",
"end_date": "2020-05-27"
},
"invoices": [
{
"value": 47.89,
"value_total": 55.19,
"delivery_mode": "yosoymas",
"date": "2017-09-15T22:00:00Z",
"pay_date": "2017-09-15T22:00:00Z",
"number": "MM12123445",
"path": "/path/to/invoices/20120716/XYZ_AB12345.pdf",
"status": {
"id": 2,
"value": "PAGADO"
},
"cycle": {
"start_date": "2030-01-01T12:13:11Z",
"end_date": "2030-01-17T12:13:11Z"
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id* | integer (int64) | account identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
period_date* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoices* | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/invoices?start_date=1970-01-01&end_date=1970-01-01' \
-H 'Accept: application/json'Returns terms info given by accountId. Items are ordered with end date descending order.
PATH PARAMETERS
organization name
account identifier
OK successful operation
[
{
"subscription_id": 214748364,
"start_date": "2017-09-15T22:00:00Z",
"end_date": "2017-09-15T22:00:00Z",
"penalty_amount": 0,
"terms_months": 12,
"account_bundle_id": 214748364,
"binding_type": {
"id": 214748364,
"value": "12 MESES"
},
"promotion": {
"id": 0,
"value": "string",
"description": "PERMANENCIA TERMINAL 150E 24M"
},
"associated_type": "terminal",
"associated_terminal": {
"id": 0,
"value": "string"
}
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_id | integer (int64) | subscription id | ||||||||||||||||||||||
start_date | string (date-time) | start date | ||||||||||||||||||||||
end_date | string (date-time) | end date | ||||||||||||||||||||||
penalty_amount | number (double) | terms penalty amount | ||||||||||||||||||||||
terms_months | integer (int32) | terms months | ||||||||||||||||||||||
account_bundle_id | integer (int64) | account bundle id | ||||||||||||||||||||||
binding_type | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
promotion | object | Promotion to which the permanence is associated to | ||||||||||||||||||||||
| ||||||||||||||||||||||||
associated_type | string
()
terminalpromotion | Type of permanence to which it is associated | ||||||||||||||||||||||
associated_terminal | object | Returned in case the associated_type has value "terminal", with id and name of the terminal | ||||||||||||||||||||||
| ||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/terms' \
-H 'Accept: application/json'Returns payment info (bank account) given by accountId.
PATH PARAMETERS
organization name
account identifier
OK successful operation
{
"payment_method": "BANK_ACCOUNT",
"bank_account": {
"entity": "string",
"subsidiary": "string",
"control_digit": "string",
"number": "string",
"iban": "string"
},
"credit_card": {
"reference": "string",
"type_id": 0,
"number": "string",
"validity_date": "string"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
payment_method | string
()
BANK_ACCOUNTBANK_TRANSFERCREDIT_CARDECIRECURRING_CREDIT_CARD | |||||||||||||||||||||||||||||||||
bank_account | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
credit_card | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/paymentinfo' \
-H 'Accept: application/json'Migrate bundle account to another bundle. When using only required fields (account_id and new_bundle_id) in request, existing additional and extra mobiles lines must be sent too with their subscription_id and destination product_id.
PATH PARAMETERS
organization name
[
{
"sales_info": null,
"value": [
{
"dealer_id": "C00002",
"shop_id": "0025",
"logistic": false
}
],
"account": {
"value": [
{
"account_id": 5827148,
"new_bundle_id": 954,
"subscriptions": {
"value": [
{
"ftth": {
"value": [
{
"product_id": 3036
}
]
},
"mobile_lines": {
"values": [
{
"subscription_id": 8619281,
"type": "main",
"product_id": 364,
"msisdn": "693533593"
}
]
}
}
]
}
}
]
}
}
][
{
"account": {
"value": [
{
"account_id": 5827148,
"new_bundle_id": 954
}
]
}
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
client | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sales_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Bundle migration ok
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Accepted Check risk decision
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/signups/migration' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"sales_info": null,
"value": [
{
"dealer_id": "C00002",
"shop_id": "0025",
"logistic": false
}
],
"account": {
"value": [
{
"account_id": 5827148,
"new_bundle_id": 954,
"subscriptions": {
"value": [
{
"ftth": {
"value": [
{
"product_id": 3036
}
]
},
"mobile_lines": {
"values": [
{
"subscription_id": 8619281,
"type": "main",
"product_id": 364,
"msisdn": "693533593"
}
]
}
}
]
}
}
]
}
}
]'Returns subscription info given by subscriptionId
PATH PARAMETERS
organization name
subscription identifier
QUERY PARAMETERS
Use 'include' to get <ul> <li>'origin' -> origin of the subscription (new, from portability, from migration, etc.)</li> <li>'selldate' -> date of last change of status</li> <li>'historical_status' -> all status changes over time, including the current one, sorted by time</li> </ul>
OK successful operation
{
"id": 214748364,
"subscription_status": {
"id": 1,
"value": "INSTALADO"
},
"sell_date": "2017-09-15T22:00:00Z",
"activated_date": "2017-09-15T22:00:00Z",
"end_date": "2017-09-15T22:00:00Z",
"subscription_type": {
"id": 1,
"value": "PRE-PAGO"
},
"origin": {
"id": 214748364,
"value": "NUEVA"
},
"historical_status": [
{
"subscription_status": {
"id": 1,
"value": "INSTALADO"
},
"date": "2017-09-15T22:00:00Z",
"modified_by": "somebody"
}
],
"dealer_id": "string",
"shop_id": "string",
"path": "string",
"filename": "string",
"identification_nr": 12345,
"imsi": 214035453370793,
"iccid": 8934011411551283000
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | integer (int64) | ID of subscription to return | ||||||||||||||||||||||||||||||||||||||||||
subscription_status | object | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
sell_date | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||
activated_date | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||
end_date | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||
subscription_type | object | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
origin | object | to get origin use in url object query with include = origin. /subscriptions/{id}?query={"include":["origin"]} | ||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
historical_status | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
dealer_id | string | null | Dealer id (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
shop_id | string | null | Shop id (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
path | string | null | Contract path (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
filename | string | null | Contract filename (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
identification_nr | integer (int32) | Phone number associated to subscription | ||||||||||||||||||||||||||||||||||||||||||
imsi | integer (int64) | null | IMSI associated to mobile subscription (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
iccid | string | null | Mobile online icc id (in some cases this field can be null) | ||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364' \
-H 'Accept: application/json'Returns devices subscription info given by subscriptionId
PATH PARAMETERS
organization name
subscription identifier
OK returns list of terminals of a subscription
{
"devices": [
{
"subscription_id": 214748364,
"subscription_terminal_id": 214748364,
"delivery_date": "2024-10-15T14:30:00Z",
"status": {
"id": 214748364,
"value": "ACTIVO"
},
"request_detail": {
"created_date": "2017-09-15T22:00:00Z",
"request_id": 214748364,
"request_type": "captacion",
"user_profile_role": "Generic"
},
"device_info": {
"terminal_id": 214748364,
"serial_number": 0,
"device_name": "Honor 90 Smart 5G",
"device_model": "128GB Midnight Black",
"financed_by": "XFERA",
"is_financed": false,
"value_due_today": 120,
"reservation_id": "e528d8ec-831f-40e9-8414-8ef7cc99c4e4",
"paid": false,
"terminal_code": "PV00000",
"terminal_category_type": "SMARTPHONE"
},
"fees": {
"upfront_fee": 0,
"installment_plan": {
"last_installment_fee": 0,
"monthly_fee": 6,
"duration": 0,
"unpaid_installments": 10,
"financed_by": "XFERA"
},
"final_installment_plan": {
"last_installment_fee": 0,
"monthly_fee": 6,
"duration": 0,
"unpaid_installments": 10,
"financed_by": "XFERA"
}
},
"permanences": {
"duration_months": 24,
"current_duration_days": 120,
"penalty_amount": 120.5,
"current_penalty_amount": 120.5
}
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
devices | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/devices' \
-H 'Accept: application/json'Add device to subscription
PATH PARAMETERS
organization name
subscription identifier
HEADER PARAMETERS
origin ip address
Add device to subscription
{
"delivery_info": {
"shipping_price": 0,
"pay_in_return": true,
"contact": {
"name": "string",
"phone": "string"
},
"address": {
"address_id": "string",
"description": "string",
"street_type": "ACCESS",
"street_name": "string",
"number": "string",
"block": "string",
"bis": "string",
"floor": "string",
"stair": "string",
"door": "string",
"letter": "string",
"hand1": "string",
"hand2": "string",
"postal_code": "string",
"town": "string",
"province_id": "28",
"technical_id": "string"
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"sell": {
"dealer_id": "C00002",
"shop_id": "0025",
"channel_id": 0,
"category": "Generic",
"payment": {
"id": 0,
"credit_card_reference": "string",
"transaction_id": "9651BHUZ2A3",
"reference_id": "string",
"scoring": {
"scoring_value": 0,
"id_value": 0,
"forced_value": 0,
"up_front": 0,
"credit_limit": 0,
"credit_limit_available": 0,
"app_id": 0
},
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
}
},
"client": {
"customer_id": "string",
"account_id": "string",
"attributes": {
"document_expiration_date": "1999-01-31",
"employment": {
"activity_country_code": "string",
"company": "string",
"income": 0,
"income_source": {
"id": 0,
"observations": "string"
},
"profession": 0,
"professional_area": 0,
"professional_use": true
}
}
},
"device": {
"device_details": {
"id": 0,
"model_id": "string",
"cession_price": 0,
"imei": "string",
"pending_imei": true,
"insured_amount": 0,
"category": "string",
"logistic_required": true,
"catalogue_id": "string",
"amount": 0
},
"fees": {
"upfront_fee": 0,
"installment_plan": {
"commission": 0,
"tae": 0,
"tin": 0,
"duration": 0,
"monthly_fee": 0,
"last_installment_fee": 0,
"discount_final_payment_value": 0,
"is_promotional_renew": true
}
},
"financial_details": {
"pre_booking": {
"order_id": "string",
"authorization_id": "string",
"financial_entity": "string",
"status": "Accepted",
"granted_amount": 0,
"credit_line_amount": 0,
"total_client_financed_value": 0
},
"consents": {
"commercial": true,
"gdpr": true
}
},
"campaign_id": 0,
"terms": {
"penalty_value": 0,
"commitment_duration": 0
},
"reservation_id": "string",
"signature_process_id": 0,
"signature_type": "PAPER",
"old_subscription_terminal_id": 0
},
"subscription_offer_segment": "string"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
delivery_info | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sell* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_offer_segment* | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created successful operation
{
"risk_decision": "string",
"subscription_terminal_id": 0
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string | |||
subscription_terminal_id | number (int64) |
Accepted check risk decision
{
"risk_decision": "string",
"subscription_terminal_id": 0
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string | |||
subscription_terminal_id | number (int64) |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X POST 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/devices' \
-H 'x-ip-address: 192.168.1.1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"delivery_info": {
"shipping_price": 0,
"pay_in_return": true,
"contact": {
"name": "string",
"phone": "string"
},
"address": {
"address_id": "string",
"description": "string",
"street_type": "ACCESS",
"street_name": "string",
"number": "string",
"block": "string",
"bis": "string",
"floor": "string",
"stair": "string",
"door": "string",
"letter": "string",
"hand1": "string",
"hand2": "string",
"postal_code": "string",
"town": "string",
"province_id": "28",
"technical_id": "string"
},
"delivery_shop_id": "0025",
"delivery_type": "LOGISTIC"
},
"sell": {
"dealer_id": "C00002",
"shop_id": "0025",
"channel_id": 0,
"category": "Generic",
"payment": {
"id": 0,
"credit_card_reference": "string",
"transaction_id": "9651BHUZ2A3",
"reference_id": "string",
"scoring": {
"scoring_value": 0,
"id_value": 0,
"forced_value": 0,
"up_front": 0,
"credit_limit": 0,
"credit_limit_available": 0,
"app_id": 0
},
"platform": "PAYMENTS",
"payment_link": "string",
"tax": 21
}
},
"client": {
"customer_id": "string",
"account_id": "string",
"attributes": {
"document_expiration_date": "1999-01-31",
"employment": {
"activity_country_code": "string",
"company": "string",
"income": 0,
"income_source": {
"id": 0,
"observations": "string"
},
"profession": 0,
"professional_area": 0,
"professional_use": true
}
}
},
"device": {
"device_details": {
"id": 0,
"model_id": "string",
"cession_price": 0,
"imei": "string",
"pending_imei": true,
"insured_amount": 0,
"category": "string",
"logistic_required": true,
"catalogue_id": "string",
"amount": 0
},
"fees": {
"upfront_fee": 0,
"installment_plan": {
"commission": 0,
"tae": 0,
"tin": 0,
"duration": 0,
"monthly_fee": 0,
"last_installment_fee": 0,
"discount_final_payment_value": 0,
"is_promotional_renew": true
}
},
"financial_details": {
"pre_booking": {
"order_id": "string",
"authorization_id": "string",
"financial_entity": "string",
"status": "Accepted",
"granted_amount": 0,
"credit_line_amount": 0,
"total_client_financed_value": 0
},
"consents": {
"commercial": true,
"gdpr": true
}
},
"campaign_id": 0,
"terms": {
"penalty_value": 0,
"commitment_duration": 0
},
"reservation_id": "string",
"signature_process_id": 0,
"signature_type": "PAPER",
"old_subscription_terminal_id": 0
},
"subscription_offer_segment": "string"
}'Replace sim icc to a new one
PATH PARAMETERS
organization name
subscription identifier
HEADER PARAMETERS
origin ip address
Contains dealer id, shop id (if present), offline/online value and new icc
{
"dealer_id": "string",
"shop_id": "string",
"logistic": true,
"new_icc": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
dealer_id* | string | Dealer ID | ||
shop_id | string | Shop ID | ||
logistic* | boolean | Online/offline operation | ||
new_icc | string | New icc |
Created successful operation
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Accepted successful operation
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/sim-replacement' \
-H 'x-ip-address: 192.168.1.1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealer_id": "string",
"shop_id": "string",
"logistic": true,
"new_icc": "string"
}'Get recharge details between two dates or actual month. if it doesn't include dates, it will take the current month by subscriptionId given.
PATH PARAMETERS
organization name
subscription identifier
QUERY PARAMETERS
start date query with format yyyy-mm-dd
end date query with format yyyy-mm-dd
OK successful operation
{
"subscription_id": 214748364,
"identification_nr": 12345,
"period_date": {
"start_date": "2020-05-01",
"end_date": "2020-05-27"
},
"recharges": [
{
"recharge_id": 214748364,
"date": "2020-05-17T12:13:11Z",
"movement_type_id": 214748364,
"origin_id": 214748364,
"amount": 0
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_id | integer (int64) | identification subscription | ||||||||||||||||||||||||||||||||
identification_nr | integer (int32) | number of identification | ||||||||||||||||||||||||||||||||
period_date | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
recharges | object[] | |||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/recharge/detail?start_date=1970-01-01&end_date=1970-01-01' \
-H 'Accept: application/json'Returns current product including last change(s) and compatibilities for a given subscriptionId
PATH PARAMETERS
organization name
subscription identifier
QUERY PARAMETERS
Use 'include' to get <ul> <li>compatibilities -> Get compatible tariffs</li> <li>historical_changes -> Get history of tariff changes</li> </ul>
OK successful operation
{
"id": 214748364,
"product": {
"id": 214748364,
"value": "TARIFA MAS 10GB CONV",
"historic_date": "2020-05-05T12:29:22Z",
"compatibilities": [
{
"id": 214748364,
"value": "TARIFA MAS 10GB CONV",
"historic_date": "2020-05-05T12:29:22Z",
"compatibilities": [
null
],
"scheduled": {
"request_date": null,
"process_date": null,
"scheduled_date": null,
"destination_product": null
}
}
],
"scheduled": {
"request_date": "2020-05-05T12:29:22Z",
"process_date": "2020-05-06T12:29:22Z",
"scheduled_date": "2020-05-06T12:29:22Z",
"destination_product": {
"id": 214748364,
"value": "TARIFA MAS 10GB CONV",
"historic_date": "2020-05-05T12:29:22Z",
"compatibilities": [
null
],
"scheduled": {}
}
}
},
"bundle": {
"id": 214748364,
"value": "FIBRA 600Mb INDIRECTA + TARIFA MÁS 10GB"
},
"historical_changes": [
{
"id": 214748364,
"value": "TARIFA MAS 10GB CONV",
"historic_date": "2020-05-05T12:29:22Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | integer (int64) | identification subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundle | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
historical_changes | object[] | Tariff change history, ordered by datetime in descending order. The current tariff is always included at the top of the list. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/products' \
-H 'Accept: application/json'Change subscription products given by new productId & subscriptionId. Bundled main line products can not be changed this way.
PATH PARAMETERS
organization name
subscription identifier
Change subscription product given a productId
{
"productId": 214748364,
"scheduled_date": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
productId* | integer (int64) | target product identifier | ||
scheduled_date | string (date) | Desired date to execute operation |
Created successful operation
Accepted check risk decision
{
"risk_decision": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
risk_decision | string |
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/products' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"productId": 214748364,
"scheduled_date": "string"
}'Returns an array of items with all the services associated to the subscriptionId given.
PATH PARAMETERS
organization name
subscription identifier
QUERY PARAMETERS
User 'filter' to get 'active' or 'inactive' services
OK successful operation
{
"subscription_id": 0,
"items": [
{
"id": 214748364,
"value": "VOZ",
"changeable": true,
"date_last_modified": "2017-09-15T22:00:00Z",
"active": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_id | integer (int64) | identification subscription | ||||||||||||||||||||||||||||||||
items | object[] | |||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/services' \
-H 'Accept: application/json'Change values of Active to 'True/False' given by serviceId & subscriptionId.
PATH PARAMETERS
organization name
subscription identifier
service identifier
Change service status
{
"active": true
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
active | boolean | active = True - Activate a service <br> active = False - Deactivate a service |
Created successful operation
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/services/214748364' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"active": true
}'Returns bonuses which are associated with a subscription identificator given by subscriptionId. Default response includes active and scheduled bonuses
PATH PARAMETERS
organization name
subscription identifier
QUERY PARAMETERS
Filter array can be used to show 'active' (without scheduled), 'actual' or 'inactive' bonuses.
OK successful operation
{
"id": 214748364,
"items": [
{
"id": 214748364,
"value": "INTERNET 3GB TPILI",
"start_date": "2017-09-15T22:00:00Z",
"end_date": "2017-09-15T22:00:00Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | integer (int64) | identification subscription | |||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/bonuses' \
-H 'Accept: application/json'Given a subscriptionId, this method allows to add a bonus to the subscription (bonusId must to be informed as parameter)
PATH PARAMETERS
organization name
subscription identifier
Add bonus to a subscriptionId (must include bonusId to add)
{
"bonusId": 214748364,
"scheduled_date": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
bonusId* | integer (int64) | bonus ID to add | ||
scheduled_date | string (date) | Desired date to execute operation |
Created successful operation
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X PUT 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/bonuses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"bonusId": 214748364,
"scheduled_date": "string"
}'Given a subscriptionId, this method allow to delete a bonus to the subscription (bonusId must to be informed as parameter)
PATH PARAMETERS
organization name
subscription identifier
bonus identifier
QUERY PARAMETERS
Desired date to execute operation
Accepted successful operation
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X DELETE 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/bonuses/214748364?scheduled_date=2020-01-01' \
-H 'Accept: application/json'Returns an array of promotions grouped in three levels (subscription, account, account bundle). Default response includes active and scheduled promotions
PATH PARAMETERS
organization name
account identifier
QUERY PARAMETERS
Filter array can be used to show 'inactive' promotions instead of the active ones.
OK successful operation
{
"subscription_promotions": [
{
"subscription_id": 214748364,
"promotion_id": 214748364,
"promotion_code": "NTH_256",
"promotion_name": "MM_50% DTO_CONVERGENCIA_FIDELIZACIÓN_12_MESES",
"association_date": "2017-09-15T22:00:00Z",
"end_date": "2017-09-15T22:00:00Z",
"account_bundle_id": 214748364,
"promotion_benefit_type": {
"id": 1,
"value": 0
},
"promotion_type": {
"id": 1,
"value": "string"
}
}
],
"account_promotions": [
{
"promotion_id": 0,
"begin_date": "2017-09-15T22:00:00Z",
"promotion_name": "string",
"end_date": "2017-09-15T22:00:00Z",
"promotion_benefit_type": {
"id": 1,
"value": 0
},
"promotion_type": {
"id": 1,
"value": "string"
}
}
],
"account_bundle_promotions": [
{
"promotion_id": 0,
"effective_date_ini": "2017-09-15T22:00:00Z",
"effective_date_end": "2017-09-15T22:00:00Z",
"promotion_name": "string",
"account_bundle_id": 0,
"promotion_benefit_type": {
"id": 1,
"value": 0
},
"promotion_type": {
"id": 1,
"value": "string"
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_promotions | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_promotions | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_bundle_promotions | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/promotions' \
-H 'Accept: application/json'Returns the subscription's blocking reason for a subscriptionId given, filtered results by theft or loss.
PATH PARAMETERS
organization name
subscription identifier
OK successful operation
{
"subscription_id": 0,
"items": [
{
"id": 214748364,
"value": "ROBO",
"date_last_modified": "2017-09-15T22:00:00Z",
"description": "A PETICION DE CLIENTE"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_id | integer (int64) | identification subscription | |||||||||||||||||||||||||||
items | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/blocks' \
-H 'Accept: application/json'Change to Block / Unblock SIM_CARD with origin theft or loss related to a given subscriptionId.
PATH PARAMETERS
organization name
subscription identifier
block identifier (only allow 1 or 2)
Change block status
{
"active": true,
"reason": "Lo ha perdido"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
active* | boolean | active = True - Activate a service <br> active = False - Deactivate a service | ||
reason | string | Describes the reason to block the simcard |
Created successful operation
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X PATCH 'https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/blocks/214748364' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"active": true,
"reason": "Lo ha perdido"
}'Executes changeOrder proxy call to mysimWS
{
"seller": "string",
"workorderid": "string",
"reason": "string",
"parameters": "string",
"changetype": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
seller* | string | |||
workorderid* | string | |||
reason | string | |||
parameters | string | |||
changetype* | string |
OK successful operation
{
"errorVO": {
"error_code": "string",
"error_description": "string",
"operation_date": "string"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorVO | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
Method Not Allowed Method not allowed
curl -X POST 'https://customers.sta.masstack.com/v2/workorders/change-order' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"seller": "string",
"workorderid": "string",
"reason": "string",
"parameters": "string",
"changetype": "string"
}'Get account penalties by account id. Two different penalties can be obtained, for unsubscribing or for cancelling
PATH PARAMETERS
organization name
account identifier
QUERY PARAMETERS
Reason. Two values are possible, unsubscribe or cancel
OK Account penalties
[
{
"computed_penalty_id": 0,
"mobile_operator_id": 0,
"penalties": [
{
"id": 0,
"value": 0,
"description": "string",
"subscription_id": 0,
"subscription_uuid": "string",
"commitment_uuid": "string",
"subscrition_promotion_id": 0,
"promotion_id": 0,
"start_date": "1999-01-31",
"end_date": "1999-01-31",
"mandatory": true,
"type": "ADMCOSTCANCELCOST",
"subscription_terminal_id": 0
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
computed_penalty_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mobile_operator_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalties | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Invalid request body
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364?reason=unsubscribe' \
-H 'Accept: application/json'Get account penalties by account and subscription ids. Three different penalties can be obtained, for unsubscribing a broadband subscription, for migrating a subscription that has a device linked to it, or for mobile only unsubscribing
PATH PARAMETERS
organization name
account identifier
subscription identifier
QUERY PARAMETERS
Reason. Three values are possible, broadband_subscription, device or mobile
OK Subscription penalties
[
{
"computed_penalty_id": 0,
"mobile_operator_id": 0,
"penalties": [
{
"id": 0,
"value": 0,
"description": "string",
"subscription_id": 0,
"subscription_uuid": "string",
"commitment_uuid": "string",
"subscrition_promotion_id": 0,
"promotion_id": 0,
"start_date": "1999-01-31",
"end_date": "1999-01-31",
"mandatory": true,
"type": "ADMCOSTCANCELCOST",
"subscription_terminal_id": 0
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
computed_penalty_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mobile_operator_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalties | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364/subscriptions/214748364?reason=broadband_subscription' \
-H 'Accept: application/json'Get account penalties by account and subscription UUID. Three different penalties can be obtained, for unsubscribing a broadband subscription, for migrating a subscription that has a device linked to it, or for mobile only unsubscribing
PATH PARAMETERS
organization name
account identifier
subscription identifier
OK Subscription penalties
[
{
"computed_penalty_id": 0,
"mobile_operator_id": 0,
"penalties": [
{
"id": 0,
"value": 0,
"description": "string",
"subscription_id": 0,
"subscription_uuid": "string",
"commitment_uuid": "string",
"subscrition_promotion_id": 0,
"promotion_id": 0,
"start_date": "1999-01-31",
"end_date": "1999-01-31",
"mandatory": true,
"type": "ADMCOSTCANCELCOST",
"subscription_terminal_id": 0
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
computed_penalty_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mobile_operator_id | number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalties | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X GET 'https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364/subscriptions/uuid/123e4567-e89b-12d3-a456-556642440000' \
-H 'Accept: application/json'Put computed penalty to confirm penalties. Computed penalty id is obtained through the GET penalties method (account or subscription)
PATH PARAMETERS
organization name
computed penalty identifier
QUERY PARAMETERS
Optional array of penalties for specific calculation
OK Successful operation
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X PUT 'https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364' \
-H 'Accept: application/json'Deletes already confirmed penalty with PUT method. Computed penalty id is obtained through the GET penalties method (account or subscription)
PATH PARAMETERS
organization name
computed penalty identifier
OK Successful operation
Not Found Resource not found
{
"code": "0001",
"status": "string",
"message": "string",
"detailMsg": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | Custom error code (Zero-padded, e.g. "0001", "0013") | ||
status | string | Status | ||
message | string | Status message | ||
detailMsg | string | Detailed description of the error |
curl -X DELETE 'https://customers.sta.masstack.com/v2/orgs/telco/penalties/214748364' \
-H 'Accept: application/json'