masstack

V1
V2
API Overview Resources Schemas

Provision TV Amazon

Amazon provides the ability to offer your customers the option to subscribe to Amazon services with the convenience of payments through your billing systems. Customers receive entitlement to the subscribed services when they complete the sign-up process. Customers can cancel services at any time by contacting their mobile service provider.

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
bundle_id path string true Bundle identifier

Request example

1
2
3
4
5


curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/bundles/95e3e1a2-e09b-4d2d-b35a-6a0845b1170b \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code Meaning Description Schema
200 OK Success AmazonGetBundleDetailsResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
404 Not Found Not found [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
body body AmazonCreateSubscription true ‘none’

Request body - JsonObject

1
2
3
4
5
6
7
8

{
  "billing_id": "AAZ875147628",
  "email": "test@email.com",
  "external_id": "userid_8572394923",
  "msisdn": "+525512345678",
  "offer_code": "boku-web-demo",
  "product": "PV_3M_PROMO"
}
Name Type Required Description
billing_id AmazonBillingID true Unique subscriber identifier.
email AmazonEmail false The primary email address preferred by the customer.
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
msisdn AmazonMSISDN false MSISDN
offer_code AmazonOfferCode true Offer identifier provided by Amazon.
product AmazonProductID true Amazon product identifier.

Request example

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


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'billing_id': 'AAZ875147628',
  'email': 'test@email.com',
  'external_id': 'userid_8572394923',
  'msisdn': '+525512345678',
  'offer_code': 'boku-web-demo',
  'product': 'PV_3M_PROMO'
}"

Responses

Code Meaning Description Schema
202 Accepted Entitlement offer request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonUpdateSubscription true ‘none’

Request body - JsonObject

1
2
3
4

{
  "external_id": "userid_8572394923",
  "product": "PV_3M_PROMO"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
product AmazonProductID true Amazon product identifier.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X PATCH https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923',
  'product': 'PV_3M_PROMO'
}"

Responses

Code Meaning Description Schema
202 Accepted Bundle update request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonCancelSubscription true ‘none’

Request body - JsonObject

1
2
3
4

{
  "external_id": "userid_8572394923",
  "reason": "CUSTOMER_OPT_OUT"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
reason AmazonCancelReason true Indicates the reason for cancellation.
- BILLING_FAILED_RENEWAL: Customer did not meet financial obligations in time for the billing cycle.
- CUSTOMER_ACCOUNT_CHANGE: Customer has changed their account the offer is attached to.
- CUSTOMER_CLOSED_ACCOUNT: Customer closed their account with the mobile operator.
- CUSTOMER_INELIGIBLE: Customer was found to be ineligible for the offer.
- CUSTOMER_OPT_OUT: Customer cancelled the subscription.
- CUSTOMER_PLAN_CHANGE: Customer changed their rate plan and is no longer eligible for their subscription.
- MERCHANT_OPT_OUT: Cancellation originated by partner, which does not map to any of the other reasons.
- RESELLER_OPT_OUT: Cancellation originated by telco, which does not map to any of the other reasons.
- SUSPECTED_FRAUD: Suspected fraud.
- TEST_BUNDLE: Bundle was created for pre-launch testing, but has become stuck in an invalid state, or no longer desired, after launch.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X PUT https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923',
  'reason': 'CUSTOMER_OPT_OUT'
}"

Responses

Code Meaning Description Schema
202 Accepted Bundle cancellation request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonSuspendSubscription true ‘none’

Request body - JsonObject

1
2
3

{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

Request example

1
2
3
4
5
6
7
8
9


curl -X PUT https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa/suspend \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923'
}"

Responses

Code Meaning Description Schema
202 Accepted Bundle suspension request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonResumeSubscription true ‘none’

Request body - JsonObject

1
2
3

{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

Request example

1
2
3
4
5
6
7
8
9


curl -X PUT https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa/resume \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923'
}"

Responses

Code Meaning Description Schema
202 Accepted Bundle resume request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonGenerateActivationUrl true ‘none’

Request body - JsonObject

1
2
3
4

{
  "external_id": "userid_8572394923",
  "validity_duration_minutes": 30
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
validity_duration_minutes AmazonActivationURLValidityDuration false Specifies the validity duration of the activation URL in minutes. If provided, the activation URL will be valid for the specified duration. If not provided, a default validity duration will be used. Value must be between 15 and 60 minutes.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa/activation-url \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923',
  'validity_duration_minutes': 30
}"

Responses

Code Meaning Description Schema
200 OK Activation URL successfully generated. AmazonGenerateActivationURLResponse
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Parameters

Name In Type Required Description
Request-Correlation-Id header string true A reference for this transaction that can be used to track it.
org_id path string true Tenant
subscription_id path string true Subscription identifier.
body body AmazonGenerateAccountRecoveryUrl true ‘none’

Request body - JsonObject

1
2
3

{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

Request example

1
2
3
4
5
6
7
8
9


curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/tv/amazon/orgs/masmovil/subscriptions/1982io-e112-9002-123029-tr4006f919aa/account-recovery-url \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'external_id': 'userid_8572394923'
}"

Responses

Code Meaning Description Schema
202 Accepted Entitlement offer request accepted for future processing. None
400 Bad Request Bad Request [Error]
401 Unauthorized Unauthorized request [Error]
500 Internal Server Error Internal Server Error [Error]

Endpoints

Provision TV Amazon

    Provision TV Netflix

      Provision TV HBO

        Provision FTTH

          Provision Orange TV

            Tesamanager

              Mobile

                Device Insurance