Activate Postpaid (Port MSN - eSIM)
Overview
Key
| Icon | Description |
|---|---|
| Telcoinabox | |
| Service Provider / Website |
API Sequence
| Step | Action | Publisher | Consumer | API Guide | M/O | Comments/Other Info | Type |
|---|---|---|---|---|---|---|---|
| 1 | Create Customer Account | Add a New Customer | Optional (if existing customer then can skip this step) | Returns custno which is required to submit the order. | REST API | ||
| 2 | Validate the SIM Card | Query Resource | Mandatory | Validate the sim serial number is internal status = AVAILABLE and provider status = 'r' | Legacy SOAP | ||
| 3 | Request an OTP | Manage OTP | Optional (If performing ID validation by another method or with own OTP solution) | Use requestType = getOtp | Legacy SOAP | ||
| 4 | Verify an OTP | Verify OTP | Optional (If performing ID validation by another method or with own OTP solution) | Use requestType = verifyOtp | Legacy SOAP | ||
| 5 | Provision a Mobile Service | Create a Mobile Service (Port In Number) | Mandatory | Creates a port in order. Do not provide simNumber as eSIM will be automatically assigned, isEsim = true, isQRcode = true (if you want Octane to send your end user an email with QR code. Note that you must have a notification setup with the template code MBQRCODE in order for email QR code to be delivered by Octane), or isQRcode = false (if you wish to provide QR code another way to your customer, example: display in your website or app). Note that you must provide a valid planno in the request. Please see Octane > Plans section for your valid planno or discuss with the Billing Team | Legacy SOAP | ||
| 6 | Query Order | Query an Order | Optional | Check the status of the order (if using to poll orders to completion limit requests to 1 every 30 mins). | Legacy SOAP | ||
| 8 | Retrieve QR Code | Get eSIM Details | Optional | If you have chosen isQRcode = false you can retrieve the QR code via API. requestType = QR Code, msn = serviceNumber returned in Query Order | REST API |
Modified at 2024-06-06 04:27:39