Mobily Developer Portal

eSIM Product

portaladmin — Tue, 15 Oct 2024 12:32:03 +0000

eSIM Product

Overview

The evolution of the mobile industry has heightened the demand for diverse point-of-sale solutions.

To enhance and expand Mobily's eSIM services, we partnered with our collaborators to provide eSIM services through the use of Application Programming Interfaces (APIs).

With the eSIM APIs, Mobily customers can effortlessly purchase and activate their eSIM in just seconds through our partners' platforms and applications.

Prerequisites:

apikey: It will be provide by Mobily team
JWT: You need to generate the JWT from Authentication & Authorization Product

Sequence Diagram for Visitors eSIM Activation: Sequence Diagram for Partners:

portaladmin October 15, 2024

Authentication & Authorization Product

portaladmin — Tue, 15 Oct 2024 08:28:06 +0000

Authentication & Authorization Product

Overview

The evolution of the mobile industry has heightened the demand for diverse point-of-sale solutions.

To enhance and expand Mobily's services, we partnered with our collaborators to provide Mobily services through using our Application Programming Interfaces (APIs).

As required to be Authorize to use Mobily APIs, this product will provide the required information for the Authentication.

Prerequisites:

apikey: It will be provide by Mobily team

portaladmin October 15, 2024

Swaggers

b.prakash — Fri, 07 Jun 2024 10:03:10 +0000

Swaggers b.prakash June 07, 2024

Body

1. Customer management

API to fetch customer details by ID details or MSISDN. Allows also to verify Mobily employees and perform service base, service eligibility checks.

API details:

API URL:

/installedbase/getCustomerProductDetails

Swagger Link:

<<Customer Related Account Inquiry >>

API URL:

/customer

Swagger Link:

<<Customer Account Inquiry >>

API URL:

/employee

Swagger Link:

<<Employee Verification >>

API URL:

/installedbase/familyPlan

Swagger Link:

<<Family Plan Check >>

2. SIM management

APIs for reserve and validate SIM cards and for eSim activation

API details:

API URL:

/sim/get

Swagger Link:

<<Get SIM Service >>

API URL:

/mobily/simvalidationandorc

Swagger Link:

<<Sim Validation Service >>

API URL:

/esim/v1/validation

Swagger Link:

<<eSim Validation Service >>

3. Checkout

Checkout API is used to capture the data that is needed to successfully handle the commercial order.

API details:

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture Data >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Get Checkout Structure >>

4. Package Eligibility

Service to validate whether customer is eligible to activate the requested package or not.

API details:

API URL:

/package-eligibilty-check

Swagger Link:

<<PNRPackageEligibility >>

5. OTP Services

API responsible for OTP flows - from generating to validating the one time passwords for customers.

API details:

API URL:

/mobily-otp-services/services/otp-rayah/initiate

Swagger Link:

<<Rayah OTP Inquiry request >>

API URL:

/mobily-otp-services/otp-rayah/validate

Swagger Link:

<<Rayah OTP Validate request >>

API URL:

/mobily-otp-services/services/otp/inquiry

Swagger Link:

<<EAI OTP Framework Inquiry >>

API URL:

/mobily-otp-services/services/otp/generation

Swagger Link:

<<EAI OTP Framework Generate >>

API URL:

/mobily-otp-services/services/otp/regeneration

Swagger Link:

<<EAI OTP Framework Resend >>

API URL:

/mobily-otp-services/services/otp/validation

Swagger Link:

<<EAI OTP Framework Validate >>

API URL:

/mobily-sms-service/services/sms-verify

Swagger Link:

<<SMS Service >>

API URL:

/mobily-sms-service/sms-otp/validate

Swagger Link:

<<OTP Validation Service >>

API URL:

/mobily-sms-service/auth-initiation/initiate

Swagger Link:

<<Mobily Auth Initiate >>

API URL:

/mobily-sms-service/auth-validation/validate

Swagger Link:

<<Mobily Auth Validate >>

6. Prepaid Recharge

This Document contains EVD REST APIs used by applications to implement EVD Integration, like login, reservation, confirm, receive confirm etc.

API details:

API URL:

/ecrLogin

Swagger Link:

<<ECR Login, ECR: Electronic Cash Register , this is for ECR or non-andorid Terminal Integration. >>

API URL:

/report/transactions

Swagger Link:

<<Get Transactions >>

API URL:

/report/transactionsByRefnoList

Swagger Link:

<<Get Transactions By Reference List >>

API URL:

/merchant

Swagger Link:

<<Get Merchant Detail >>

API URL:

/merchant

Swagger Link:

<<Get Merchant Detail >>

API URL:

/topup/reconciliation

Swagger Link:

<<Reconciliation(GET) >>

API URL:

/topup/reconciliation

Swagger Link:

<<Reconciliation(POST) >>

API URL:

/topup/reservations

Swagger Link:

<<Pin Code Reservation >>

API URL:

/topup/reservations/{referenceNumber}/cancellations

Swagger Link:

<<Cancel Pin Code Reservation >>

API URL:

/topup/reservations/{referenceNumber}/confirmations

Swagger Link:

<<Confirm Pin Code Reservation >>

7. Self Service Management

This document contains all the apis related to self service management services.

API details:

API URL:

/api/service/rbt/v1/control/categories

Swagger Link:

<<Returns all categories >>

API URL:

/api/service/rbt/v1/control/categories/{categoryId}

Swagger Link:

<<Returns a category >>

API URL:

/api/service/rbt/v1/control/albums

Swagger Link:

<<Returns the Album matching to the key param >>

API URL:

/api/service/rbt/v1/control/artists

Swagger Link:

<<Returns the artists matching to the key param >>

API URL:

/api/service/rbt/v1/control/subscriptiontones/{subscriptionId}

Swagger Link:

<<Queries a tone by subscriptionCode >>

API URL:

/api/service/rbt/v1/control/trending/tones

Swagger Link:

<<Returns the trending tones >>

API URL:

/api/service/rbt/v1/control/services

Swagger Link:

<<Returns all offers >>

API URL:

/api/service/rbt/v1/control/services/{offerId}

Swagger Link:

<<Returns a offer >>

API URL:

/api/service/rbt/v1/customer/recommendation/tones

Swagger Link:

<<Returns recommended Tones >>

API URL:

/api/service/rbt/v1/customer/subscription-list-info

Swagger Link:

<<Returns user Subscription List Info. >>

API URL:

/api/service/rbt/v1/manage/service/subscribe

Swagger Link:

<<Initiates a new service offer subscription >>

API URL:

/api/service/rbt/v1/manage/service/subscribe/{subscriptionId}

Swagger Link:

<<Updates a service offer subscription >>

API URL:

/api/service/rbt/v1/manage/content/subscribe

Swagger Link:

<<Initiates a new content subscription >>

API URL:

/api/service/rbt/v1/manage/content/subscribe/{subscriptionId}

Swagger Link:

<<Updates a content offer subscription >>

API URL:

/api/service/rbt/v1/manage/subscribers/defaulttone

Swagger Link:

<<Update user Default Tone >>

API URL:

/api/service/rbt/v1/manage/subscribers/language

Swagger Link:

<<Update user language >>

API URL:

/api/service/rbt/v1/manage/special-condition-assignment

Swagger Link:

<<Assign a special condition to subscriber profile >>

API URL:

/api/service/rbt/v1/manage/subscribers/firstlogin

Swagger Link:

<<Update first login >>

API URL:

/mobilybe/rest/activesubs/service/list

Swagger Link:

<<Method used to retrieve active subscription service list. >>

API URL:

/mobilybe/rest/activesubs/content/list

Swagger Link:

<<Method used to retrieve active subscription content list. >>

API URL:

/mobilybe/rest/activesubs/subman/list

Swagger Link:

<<Method used to return all the Add-ons found on Sub-man and mobile app. >>

API URL:

/mobilybe/rest/activesubs/service/unsubscribe

Swagger Link:

<<Method used to retrieve active subscription content list. >>

API URL:

/mobilybe/rest/pands/subscriptionServices

Swagger Link:

<< Subscription Services Request >>

API URL:

/mobilybe/rest/pands/unsubscriptionServices

Swagger Link:

<< Unsubscription Services Request >>

API URL:

/mobilybe/rest/pands/unsubscriptionServicesWithParams

Swagger Link:

<< Unsubscription Services With Param Request >>

API URL:

/mobilybe/rest/pands/swapServicesWithParams

Swagger Link:

<< Swap Services With Param Request >>

API URL:

/api/services/pands/v1/bundle/country

Swagger Link:

<< Returns a list of bundle countries >>

API URL:

/api/services/pands/v1/bundles

Swagger Link:

<< Returns a list of bundle details >>

API URL:

/mobilybe/rest/corporate/serviceMgmt/listOfLines

Swagger Link:

<< Get line numbers >>

8. Bill and Payment Management

This document contains all the apis related to bill and payment services (Consumer and Corporate)

API details:

API URL:

/cem/dpc/core/v1/audit

Swagger Link:

<<Audit payment transactions >>

API URL:

/cem/dpc/core/v1/processRequest

Swagger Link:

<<Process Request >>

API URL:

/cem/dpc/mpgs/v1/process

Swagger Link:

<<MPGS Process >>

API URL:

/cem/dpc/inquiry/v1/saved-card

Swagger Link:

<<Saved cards >>

API URL:

/cem/dpc/mpgs/v1/batch-status/{batchName}

Swagger Link:

<<Retrieve Batch Status >>

API URL:

/cem/dpc/mpgs/v1/batch-response/{batchName}

Swagger Link:

<<Retrieve Batch Response >>

API URL:

/cem/dpc/inquiry/v1/request/{refId}

Swagger Link:

<<Retrieve payment request details >>

API URL:

/api/payment/v1/bill/dues-penalty

Swagger Link:

<<Get the calculated total amount(s) related to bill and penality (including device installment amount) based on the input choice. >>

API URL:

/api/payment/v4/overdue

Swagger Link:

<<Retrieve the Over Due amount with discount information and return limited information to the callers. >>

API URL:

/api/payment/v2/saved-cards

Swagger Link:

<<Get list of payment tokens (Saved cards) >>

API URL:

/mobilybe/rest/ftth/balanceOrOutstanding

Swagger Link:

<<Balance or Outstanding Amount >>

API URL:

/api/payment/v2/overdue

Swagger Link:

<<Retrieve the Over Due amounts of all the related lines.>>

API URL:

/api/payment/v1/vat

Swagger Link:

<<Get the calculated total amount including VAT for the given amount.>>

API URL:

/cem/bff/dpc/v1/initiatePayment

Swagger Link:

<<InitiatePayment by Channels for various Authorize, Capture and Void operations >>

API URL:

/cem/bff/ecom/v1/initiatePayment

Swagger Link:

<<BFF APIs for eCommerce InitiatePayment by Channels for various Authorize, Capture and Void operations >>

API URL:

/cem/bff/dpc/v1/process

Swagger Link:

<<Process request by Channels for various DPC's MPGS process operations. >>

API URL:

/mobilybe/rest/payment/balance/info

Swagger Link:

<<Retrieve Customer Balance Info >>

API URL:

/mobilybe/rest/payment/audit

Swagger Link:

<<Audit Payment >>

API URL:

/mobilybe/rest/payment/deleteCard

Swagger Link:

<<Delete Card >>

API URL:

/mobilybe/rest/payment/updateDefaultCard

Swagger Link:

<<Update Default Card >>

API URL:

/mobilybe/rest/payment/recharge/dataVoucher

Swagger Link:

<<Recharge Data Voucher >>

API URL:

/mobilybe/rest/oth/credit/transfer

Swagger Link:

<<Credit Transfer >>

API URL:

/mobilybe/rest/oth/credit/transfer/confirm

Swagger Link:

<<Credit Transfer Confirm >>

API URL:

/api/bill/v1/pdf/latest

Swagger Link:

<<Returns the latest bill pdf information in the form of Base64 format. >>

API URL:

/api/my-balance/v1/prepaid-line-status

Swagger Link:

<<Inquiry Customer Balance to know the prepaid line status (Active or Inactive) >>

API URL:

/api/services/clg/v1/graceeligiblelines

Swagger Link:

<<Get Grace Eligible Lines >>

API URL:

/api/services/clg/v1/graceperiod

Swagger Link:

<<Grace Reconnection >>

API URL:

/mobilybe/rest/clg/creditlimit/inquiry

Swagger Link:

<<Credit Limit Inquiry >>

API URL:

/mobilybe/rest/clg/creditlimit/update

Swagger Link:

<<Credit Limit Update >>

API URL:

/mobilybe/rest/clg/gracePeriod/update

Swagger Link:

<<Grace Period Updation (MSISDN) or 4.1.16.4 Grace Period Updation (Account Number) >>

API URL:

/mobilybe/rest/myprofile/bill/altcontact/update

Swagger Link:

<<Method used to update bill's alternative contact. >>

API URL:

/mobilybe/rest/myprofile/bill/email/update

Swagger Link:

<<Method used to update billing email. >>

API URL:

/mobilybe/rest/myprofile/bill/unbilled/details

Swagger Link:

<< Unbilled Amount Details >>

API URL:

/mobilybe/rest/payment/prepaid/renewalsInquiry

Swagger Link:

<< Prepaid Renewals Inquiry >>

API URL:

/mobilybe/rest/payment/recharge/byvoucher

Swagger Link:

<< Recharge By Voucher >>

API URL:

/mobilybe/rest/usage/balance/credit

Swagger Link:

<< Retrieve Credit Balance >>

API URL:

/mobilybe/rest/usage/balance/outstanding

Swagger Link:

<< Retrieve Outstanding Balance >>

API URL:

/mobilybe/rest/usage/analytics

Swagger Link:

<< Retrieve Analytics >>

API URL:

/mobilybe/rest/usage/hotstatement

Swagger Link:

<< Retrieve Hot Statement >>

API URL:

/mobilybe/rest/vad/overDraft

Swagger Link:

<< Emergency Credit (VAD Overdraft) >>

API URL:

/api/bill/v1/list

Swagger Link:

<< Retrieve list of bills >>

API URL:

/api/bill/v1/pdf

Swagger Link:

<< Fetch bill pdf information >>

API URL:

/api/corpbilling/bills/v1/lastbills

Swagger Link:

<< Individual Lines Last bills >>

API URL:

/api/corpbilling/bills/v1/usage

Swagger Link:

<< Individual Line Usage details >>

API URL:

/mobilybe/rest/corporate/billing/downloadBill

Swagger Link:

<< Download Bill >>

API URL:

/mobilybe/rest/corporate/billing/freeResourceBalance

Swagger Link:

<< Get free resource balance details >>

API URL:

/mobilybe/rest/corporate/billing/getLastBillAndMonths

Swagger Link:

<< Get Last Bill And Months >>

API URL:

/mobilybe/rest/corporate/billing/lineBalance

Swagger Link:

<< Line Balance >>

API URL:

/mobilybe/rest/corporate/billing/list/lob

Swagger Link:

<< Get Corporate Services Lookup >>

API URL:

/mobilybe/rest/corporate/billing/list/prepaid

Swagger Link:

<< Get Prepaid Lines >>

API URL:

/mobilybe/rest/corporate/billing/list/postpaid

Swagger Link:

<< Get Postpaid Lines >>

API URL:

/mobilybe/rest/corporate/billing/resendBill

Swagger Link:

<< Resend Bill >>

API URL:

/mobilybe/rest/corporate/payment/balance

Swagger Link:

<< Method used to inquire about corporate balance. >>

API URL:

/mobilybe/rest/corporate/paymenthistory/accountLevelhistory

Swagger Link:

<< Account Level >>

API URL:

/mobilybe/rest/corporate/paymenthistory/download

Swagger Link:

<< History Download >>

API URL:

/mobilybe/rest/corporate/paymenthistory/servicelevelDetails

Swagger Link:

<< Service Level Details >>

9. Authentication And Authorization

This document contains the authentication and authorization APIs used to generate Mobily Auth tokens. These auth tokens are required to access Mobily resources.

API details:

API URL:

/auth/realms/mobily/protocol/openid-connect/token

Swagger Link:

<<KeyCloak Token Generation >>

API URL:

/api/oauth-server/logout

Swagger Link:

<<DAPI Logout API >>

API URL:

/api/oauth-server/logout/other

Swagger Link:

<<DAPI API for Logging Out Other Devices >>

API URL:

/api/oauth-server/logout/other/confirm

Swagger Link:

<<DAPI API for Confirming Logging Out Other Devices. >>

API URL:

/api/oauth-server/hand-over-code

Swagger Link:

<<DAPI Handover Token API >>

API URL:

/api/oauth-server/oauth/token

Swagger Link:

<<DAPI Access Token Generation >>

API URL:

/auth/realms/mobily/protocol/openid-connect/logout

Swagger Link:

<<Keycloak Logout API >>

API URL:

/auth/realms/mobily/protocol/openid-connect/token/introspect

Swagger Link:

<<JWT Validity Check >>

API URL:

/api/internal-oauth-server/logout

Swagger Link:

<<DAPI Internal Logout API >>

API URL:

/api/internal-oauth-server/oauth/token

Swagger Link:

<<DAPI Internal Access Token Generation >>

API URL:

/apis/apigee-oauth/access-token

Swagger Link:

<<Apigee Client Access Token Generation >>

API URL:

/api/oauth-server/resend-otp

Swagger Link:

<<DAPI Resend OTP for 2FA >>

API URL:

/api/login/account

Swagger Link:

<<API used for account login with mobily credentials >>

API URL:

/api/login/otp

Swagger Link:

<<API used to generate an OTP token. >>

API URL:

/api/login/validateotp

Swagger Link:

<<API used to validate pin code for the OTP token. >>

API URL:

/cem/bff/line/v1/authorize

Swagger Link:

<<Validate the account number against the user name attached to the access token >>

API URL:

/cem/bff/login/v1/alien

Swagger Link:

<<Check whether network location and line location is inside KSA or abroad. >>

API URL:

/cem/nafath/auth/v1/initiate

Swagger Link:

<<Initiate Nafath Auth >>

API URL:

/cem/nafath/auth/v1/tokenInfo

Swagger Link:

<<Get Nafath Token Info >>

10. OTP Services

API responsible for OTP flows - from generating to validating the one time passwords for customers.

API details:

API URL:

/mobily-otp-services/services/otp-rayah/initiate

Swagger Link:

<<Rayah OTP Inquiry request >>

API URL:

/mobily-otp-services/otp-rayah/validate

Swagger Link:

<<Rayah OTP Validate request >>

API URL:

/mobily-otp-services/services/otp/inquiry

Swagger Link:

<<EAI OTP Framework Inquiry >>

API URL:

/mobily-otp-services/services/otp/generation

Swagger Link:

<<EAI OTP Framework Generate >>

API URL:

/mobily-otp-services/services/otp/regeneration

Swagger Link:

<<EAI OTP Framework Resend >>

API URL:

/mobily-otp-services/services/otp/validation

Swagger Link:

<<EAI OTP Framework Validate >>

API URL:

/mobily-sms-service/services/sms-verify

Swagger Link:

<<SMS Service >>

API URL:

/mobily-sms-service/sms-otp/validate

Swagger Link:

<<OTP Validation Service >>

API URL:

/mobily-sms-service/auth-initiation/initiate

Swagger Link:

<<Mobily Auth Initiate >>

API URL:

/mobily-sms-service/auth-validation/validate

Swagger Link:

<<Mobily Auth Validate >>

11. Email Service

API for sending Email Messages to customers.

API details:

API URL:

/email/create

Swagger Link:

<<Email Service >>

12. Order Generator

Order Generator is used to convert Bluemarble Commerce data into Product Order. The Order Generator service is implemented with the objective to create the order request and send orders to Mobily Order Management service.

API details:

API URL:

/OrderGenerator/cancelMNPOrder

Swagger Link:

<<Cancel MNP order by order id >>

API URL:

/OrderGenerator/fetchByOrderId/{orderId}

Swagger Link:

<<Fetch the Order by OrderId >>

API URL:

/OrderGenerator/generateOrderId

Swagger Link:

<<Generate Order Id >>

API URL:

/OrderGenerator/postProductOrder

Swagger Link:

<<Post Product Order from Shopping Cart >>

API URL:

/OrderGenerator/retryProductOrder

Swagger Link:

<<Retry Product Order from Shopping Cart >>

API URL:

/OrderGenerator/updateOrderStatus/{orderId}

Swagger Link:

<<Update the Order Status by External Order Id >>

API URL:

/OrderGenerator/orderTracking/orderInquiry

Swagger Link:

<<Track the order using order Number / Mobile Number >>

API URL:

/OrderGenerator/orderTracking/deliveryAddressChange

Swagger Link:

<<Update the delivery address for New Physical SIM >>

13. QR Code Service

API providing a QR Code generation service along with a functionality to fetch the QR Code and/or send it to a specified email address.

API details:

API URL:

/qr/get

Swagger Link:

<<QR Code Get Service >>

API URL:

/qr/send

Swagger Link:

<<QR Code Send Service >>

14. Security Deposit

API responsible for verifying the requirement for customer to make a deposit while buying a service or product from Mobily.

API details:

API URL:

/deposit/get

Swagger Link:

<<Security Deposit Service >>

15. Resource Pool Management

API providing fetch and reserve functionality for customer phone numbers (MSISDNs).

API details:

API URL:

/resourcePoolManagement/AvailabilityCheck

Swagger Link:

<<Get MSISDN Service >>

API URL:

/resourcePoolManagement/Reservation

Swagger Link:

<<Reserve MSISDN Service >>

16. Unpaid Bills

API responsible for verifying if customer has any outstanding, unpaid bills.

API details:

API URL:

/customer/dues

Swagger Link:

<<Unpaid Bills Service >>

17. TCC Eligibility Service

API offering functionality to perform TCC Eligibility check or Registration process.

API details:

API URL:

/tcc/register

Swagger Link:

<<TCC registration Service >>

API URL:

/tcc/eligibilityCheck

Swagger Link:

<<TCC Eligibility Service >>

18. Product Offering Qualification

Product Offering Qualification Management REST APIs

API details:

API URL:

/api/product-offering-qualification-management/v3/getEligibleCategories

Swagger Link:

<<Get Eligible Categories >>

API URL:

/api/product-offering-qualification-management/v3/qualifyProducts

Swagger Link:

<<Qualify Products >>

19. Shopping Cart Projection

Retrieve Shopping Cart by shopping cart Id

API details:

API URL:

/shopping-cart-projection/v3/shoppingCart/{shoppingCartId}

Swagger Link:

<<Query shopping cart by Id >>

20. Shopping Cart

Shopping Cart REST APIs for Create Patch and Validate Shopping Cart

API details:

API URL:

/api/shopping-cart/v3/shoppingCart

Swagger Link:

<<Create Shopping Cart >>

API URL:

/api/shopping-cart/v3/shoppingCart/{shoppingCartId}

Swagger Link:

<<Patch Shopping Cart >>

API URL:

/api/shopping-cart/v3/shoppingCart/{shoppingCartId}/validate

Swagger Link:

<<Validate Shopping Cart >>

API URL:

/mobily-shopping-cart-management/api/update-and-validate

Swagger Link:

<< Shopping Cart Update service >>

restriction

Off

Customer management

b.prakash — Wed, 17 Apr 2024 11:40:48 +0000

Customer management b.prakash April 17, 2024

SIM management

b.prakash — Wed, 17 Apr 2024 11:28:38 +0000

SIM management b.prakash April 17, 2024

Checkout

portaladmin — Wed, 17 Apr 2024 06:28:47 +0000

Checkout portaladmin April 17, 2024

eSIM Sequence Diagram

b.prakash — Fri, 12 Apr 2024 07:03:49 +0000

eSIM Sequence Diagram b.prakash April 12, 2024

Body

Mobily eSIM is an industry-standard digital SIM that allows users to activate a cellular plan from Mobily without having to use a normal physical SIM.

Mobily eSIM APIs allows customers to purchase and activate the Mobily cellular plan with digital SIM. Currently customers can use the Mobily digital channels like Web Portal and Mobile App to order new digital SIM and activate the same. Mobily digital partners can integrate with Mobily eSIM APIs and provide the services to purchase and activate the Mobily Digital SIM.

1. Mobily Products

System shows the list of available Mobily products from the Content Management System (WCM).

2. Authentication

It is the process to authenticate the systems and allow the access of Mobily eSIM APIs. System needs to authenticate with the given authentication details and consumer the APIs. Channel system to adhere all the Mobily Security guidelines. Please refer the API documentation for authentication process and sample input & output details.

3. Mobily Products Details

Mobily provide the Graph QL APIs to inquiry the products catalogue and products details. Channel system consume the same to retrieve the sellable products and display the details to customers.

Please refer the below APIs for complete details.

API details:

Get Products details

API URL:

/catalog-agg-query/graphql

Create Shopping cart:

System to create a shopping kart with the product selected by customer.

API URL:

/api/shopping-cart/v3/shoppingCart

Swagger Link:

<<Create shopping cart: >>

API URL:

/mobily-shopping-cart-management/api/update-and-validate

Swagger Link:

<<Product Offer Qualification >>

4. Number Option

Customer can purchase a new Mobily number or purchase a package with his / her number (MNP Port In).

API details:

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate checkout Structure >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture the number option >>

5. SIM Options

Customers can purchase physical SIM or Digital SIM.

API details:

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate checkout Structure >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture the number option >>

6. TCC Eligibility

As per the CST guidelines there are certain limitations on number of service lines per customer. So, channel / digital partner need to check the customer eligibility to proceed with new service line purchase. Partner needs to call the Mobily TCC eligibility service to check the eligibility and proceed further.

Please refer the below APIs for complete details.

API details:

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate checkout Structure >>

API URL:

/bmi-tcc-eligibility/services/tcc/eligibilityCheck

Swagger Link:

<<TCC Eligibility check >>

API URL:

/bmi-customer-management/services/installedbase/getCustomerProductDetails

Swagger Link:

<<Get Customer Account/Product Details >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(TCCEligibiliyCheck) >>

7. Number Reservation

Mobily enables customers to select the desired Mobile number from the available pool of numbers. Based on the selected package customers may choose the vanity numbers as well.

API details:

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate checkout Structure >>

API URL:

/resource-pool-management/services/resourcePoolManagement/AvailabilityCheck

Swagger Link:

<<Get msisdn(if ChooseNumber exists) >>

API URL:

/resource-pool-management/services/resourcePoolManagement/Reservation

Swagger Link:

<<Reserve MSISDN >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(Number Reservation) >>

8. Overdue bill

As per the Mobily business process customer need to pay all the previous dues if customer would like to purchase new service line. Channel / Digital Partner to check with Mobily if any previous overdue bills are existing in Mobily system for the customer. Overdue bill check is required if customer is purchasing a postpaid service.

If any overdue bills are there, then partner to show a proper error message to customer. So, use can navigate to Mobily portal and do the overdue payment.

API details:

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate checkout Structure >>

API URL:

/bmi-customer-unpaidbills/services/customer/dues

Swagger Link:

<<Overdue inquiry >>

API URL:

/api/shopping-cart/v3/shoppingCart/{shoppingCartId}

Swagger Link:

<<Patch Unpaid Bills Shopping Cart >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(OverdueBills) >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate Checkout >>

9. Package eligibility

Mobily is having different business rules for different packages. Partner system to validate whether customer is eligible for the selected package or not, by calling Mobily’s package eligibility service. Customer able to proceed further if he / she is eligible to purchase the selected package or else system to show the proper error message.

10. Security Deposit

Security deposit is required if customer is trying to purchase a postpaid package. System to check the required security deposit amount and show the same to customer. Once customer accepts to pay the same then only customer can proceed further.

API details:

API URL:

/bmi-customer-security-deposit/services/deposit/get

Swagger Link:

<<Security deposit inquiry >>

API URL:

/api/shopping-cart/v3/shoppingCart/{shoppingCartId}

Swagger Link:

<<Security deposit_Patch API >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(SecurityDeposit) >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate Checkout >>

11. OTP Verification

It is One time Pin code verification process which is required to validate the customer contact details. If customer is already existing in Mobily then system to show the existing service lines to customer and proceed with the OTP verification process with the line selected by customer. If customer is new to Mobily then Mobily to check with Tahaqoq to validate whether customer provided MSISDN and ID number are related or not? If it is valid then System sends the OTP to the same MSISDN and to verify the customer number. OTP verification process is mandatory for all customers.

API details:

API URL:

/bmi-customer-management/services/installedbase/getCustomerProductDetails

Swagger Link:

<<Get Customer(if OTPVerification exists) >>

API URL:

/mobily-otp-services/services/otp/generation

Swagger Link:

<<Generate OTP >>

API URL:

/mobily-otp-services/services/otp/regeneration

Swagger Link:

<<Regenerate OTP: >>

API URL:

/mobily-otp-services/otp-rayah/validate

Swagger Link:

<<Validate OTP >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(OTPVerification) >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate Checkout >>

12. Nafath

Nafath is a government service to validate the customer identity. Partner system to use the Mobily Services for Nafath verification process. It is customer responsibility to have the Nafath app and perform the verification. Partner system to input the webhook URI while calling Nafath random number generation. Once customer complete face verification in Nafath App, partner system receives the Nafath verification status to the same webhook URI which is given by partner while calling random number service. Refer the Nafath status response for details. Partner should provide the basic auth for webhook.

API details:

API URL:

/cem/nafath/auth/v1/initiate

Swagger Link:

<<Generate Nafath Random Number >>

API URL:

/cem/nafath/auth/v1/tokeninfo

Swagger Link:

<<Nafath Status Inquiry >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section(OTPVerification) >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate Checkout >>

13. TCC Registration

As per the CST guide lines any new service line activation should be registered with TCC. Partner system use the Mobily services to register the new service line details with TCC.

API details:

API URL:

/bmi-sim-details/services/sim/get

Swagger Link:

<<Get SIM >>

API URL:

/bmi-tcc-eligibility/services/tcc/register

Swagger Link:

<<TCC Registration >>

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section SIM >>

API URL:

/checkout-api/v3/checkout/structure

Swagger Link:

<<Generate Checkout >>

14. Delivery Details

Customer should provide the contact details to proceed with purchase.

API details:

API URL:

/checkout-api/v3/checkout/captureData

Swagger Link:

<<Capture section (DeliveryDetails) >>

15. Payment

Customer need to complete the payment to submit new eSIM Order. Channel / Digital partner to use the Mobily payment APIs and follow the payment process. Refer the sequence diagram and the APIs for more details.

API details:

API URL:

/OrderGenerator/postProductOrder

Swagger Link:

<<postProductOrder >>

API URL:

/api/payment/v2/createSession

Swagger Link:

Mobile App:

<<Create Session>>

Portal:

Create Session and Update CC Details using MPGS Java Script

API URL:

/api/payment/v2/createPayment

Swagger Link:

<<3D enrollment(passing Session ID & Payment Trans ID),>>

System Open HTML in browser which redirects the customer to bank portal for OTP verification.

API URL:

/api/payment/v2/confirmPayment

Swagger Link:

<<ProceedPayment (Payment Details, Saving Flage, FCM Token)>>

16. Order

Once payment is success Channel / Digital partner system to submit the order to Mobily and show the success message to customer. Mobily performs the remaining process like order fulfillment, Service line activation, digital SIM QR code generation and eContract etc.

17. QR Code

It is eSIM QR code required to install the digital sim in compatible mobiles. Channel / Digital Partner system to inquiry Mobily to retrieve the QR code and show the same to customer. Channel / Digital Partner system can re-inquiry for QR code if any delay in activation process.

API details:

API URL:

/mobily-qr-code/services/qr/get

Swagger Link:

<<QR code enquiry >>

Please find the below flow which denotes the Mobily Digital SIM activation process.

Sequence Diagram:

Hero Image

Package Eligibility

portaladmin — Fri, 01 Mar 2024 10:37:50 +0000

Package Eligibility portaladmin March 01, 2024

OTP Services

portaladmin — Fri, 01 Mar 2024 10:35:03 +0000

OTP Services portaladmin March 01, 2024

Prepaid Recharge

portaladmin — Thu, 29 Feb 2024 10:51:52 +0000

Prepaid Recharge

Overview

"The mobile industry's evolution has increased the need for different recharge platforms.

In order to elevate and expand Mobily's recharge services, we collaborated with our partners to offer recharge services by utilizing Application Programming Interfaces (API).

The Recharge API allows Mobily customers to conveniently recharge their balance in seconds via our partners' platforms and applications."

Error Code

Postman Collection

portaladmin February 29, 2024