masstack

V2
V3
V4
API Overview Resources Schemas

MasCustomers API save_alt

I am MasCustomers API. My intention is provide the necessary functionality to be able to give E2E coverage to the entire life-cycle of a client.

NOTE: The examples provided here are made up and should not be used for testing purposes. Make sure to change all parameters before attempting to make any request.

Resources

Resource Description
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
Consumption Access to Consumption subscription info
Workorders Proxy to MySimWS
Penalties Proxy to penalties

Security

warningAuthentication

All MasStack APIs uses JWT tokens to authorize all the requests. Following this, an Auhtorization with a Bearer JWT token is needed in all the requests.

In the Authorization Guides you can find documentation about JWT Tokens and how to get them in MasStack.

Base URLs

Environment Base Path
staging https://customers.sta.masstack.com/v2/
production https://customers.masstack.com/v2/

Release details

Release Notes

  • 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/{orgId}/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
API Overview